@begyoupardon/marzgah

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

Set up and administer a self-hosted Marzgah VPN reseller panel

原始使用文档
文档目录3 节
  1. Create a panel
  2. Administer a panel
  3. Source and licensing

Marzgah CLI

Set up and administer a self-hosted Marzgah VPN reseller panel. Requires Bun 1.4.4 or newer; npm distributes this package, but the executable runs on Bun.

Create a panel

bunx @begyoupardon/marzgah init my-panel

The CLI creates a complete project from the template bundled with this release, installs its dependencies, and starts the interactive setup wizard. It refuses to overwrite a non-empty directory. Setup supports Bun directly, Docker, and Cloudflare configuration instructions. Docker and Cloudflare require their respective tools/accounts.

To create files without installing dependencies, contacting your VPN backend, or requesting credentials:

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

Inside an existing generated project, init with no directory runs the configuration wizard.

Administer a panel

Run commands from the panel's directory, where its .env and data live:

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

Stop the panel before restoring a backup:

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

Database administration commands operate on local SQLite. Cloudflare D1 migrations use Wrangler as described by the setup wizard. DATABASE_PATH defaults to ./data/panel.db; relative paths are resolved from the current directory. The package ships its own migrations, with MIGRATIONS_DIR available as an explicit override. Environment variables take precedence over .env values. Use the CLI version matching your panel release when managing its database.

For repeated use, install the command with bun add --global @begyoupardon/marzgah, then run marzgah --help.

Source and licensing

Source and issues: https://github.com/begyoupardon/marzgah

Application code currently has no open-source license (UNLICENSED); no license grant is implied. Third-party dependency licenses remain applicable. The bundled Arad font's SIL Open Font License is retained under public/licenses/Arad-OFL.txt in generated projects. Poppins is installed locally through its Fontsource package.

版本与发布记录

@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 和提交记录判断。