@begyoupardon/marzgah

中文文档
0.2.4发布于 2026/10/31UNLICENSEDES Module构建来源已验证

设置和管理一个自托管的Marzgah VPN经销商面板

中文使用文档
文档目录3 节
  1. 创建面板
  2. 管理一个小组
  3. 来源和许可

Marzgah CLI

设置和管理一个自托管的Marzgah VPN经销商面板。需要 1.4.4或更新版本;npm发布这个包,但可执行文件运行在Bun上。

创建面板

bunx @begyoupardon/marzgah init my-panel

CLI从与此版本捆绑在一起的模板创建一个完整的项目,安装它的依赖项,并启动交互式安装向导。它拒绝覆盖非空目录。安装程序直接支持Bun、Docker和Cloudflare配置说明。Docker和Cloudflare需要各自的工具/帐户。

要创建文件而不安装依赖项、联系VPN后端或请求凭据:

bunx @begyoupardon/marzgah init my-panel --scaffold-only
cd my-panel
bun install --frozen-lockfile
bun run cli init

在现有生成的项目中, init 如果没有目录,则运行配置向导。

管理一个小组

从面板的目录中运行命令,其中包含 .env 数据直播:

cd my-panel
bunx @begyoupardon/marzgah doctor
bunx @begyoupardon/marzgah migrate
bunx @begyoupardon/marzgah create-admin
bunx @begyoupardon/marzgah reset-password
bunx @begyoupardon/marzgah backup --out ./backups/manual.db

恢复备份前停止面板:

bunx @begyoupardon/marzgah restore ./backups/manual.db

数据库管理命令在本地SQLite上操作。Cloudflare D1迁移使用安装向导所描述的Wrangler。 DATABASE_PATH 默认为 ./data/panel.db;从当前目录解析相对路径。包自带迁移,使用 MIGRATIONS_DIR 作为显式覆盖可用。环境变量优先于 .env 值。在管理面板数据库时,使用与面板版本匹配的CLI版本。

如需重复使用,请使用 bun add --global @begyoupardon/marzgah,然后跑 marzgah --help.

来源和许可

来源及问题: https://github.com/begyoupardon/marzgah

应用程序代码目前没有开源许可证(UNLICENSED); 不隐含许可授予。第三方依赖许可证仍然适用。捆绑的Arad字体的SIL开放字体许可证保留在 public/licenses/Arad-OFL.txt 在生成的项目中。Poppins通过其Fontsource包在本地安装。

版本与发布记录

@begyoupardon/marzgah 共发布 3 个版本,首次发布于 2026/10/28;过去 12 个月发布了 3 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.2.4latest2026/10/312 天前
0.1.02026/10/286 天前
0.0.0-stage2026/10/286 天前

关于 @begyoupardon/marzgah 的常见问题

@begyoupardon/marzgah 是什么?

设置和管理一个自托管的Marzgah VPN经销商面板

如何安装 @begyoupardon/marzgah?

在项目目录运行 npm install @begyoupardon/marzgah,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 marzgah,可以用 npx marzgah 直接运行。

@begyoupardon/marzgah 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/begyoupardon__marzgah 是否存在。

@begyoupardon/marzgah 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@begyoupardon/marzgah 可以商用吗?

@begyoupardon/marzgah 使用 UNLICENSED 许可。作者声明为 UNLICENSED,即不授予公开使用许可(与公共领域的 Unlicense 不同)。使用前需获得作者授权。以上为概括,不构成法律意见,请以许可原文为准。

@begyoupardon/marzgah 还在维护吗?

最新版本 0.2.4 发布于 2026/10/31(2 天前);至今共发布 3 个版本,其中过去 12 个月发布了 3 个;首次发布于 2026/10/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。