Marzban README

The project's README from github.com/x4gpanell/Marzban. As one markdown file: README.md.

🚀 Marzban Panel روی Railway (روش PasarGuard)

این ریپازیتوری دقیقاً به همان روش ریپازیتوری PasarGuard ساخته شده: به‌جای اینکه سورس Marzban را داخل ریپو کپی (vendor) کنیم، Dockerfile در لحظه‌ی build خودش سورس رسمی را از Gozargah/Marzban کلون می‌کند، داشبورد را می‌سازد، Xray را نصب می‌کند و ایمیج نهایی را می‌سازد.

مزیت این روش نسبت به کپی‌کردن سورس داخل ریپو:

نصب

  1. این ریپو را در گیت‌هاب خودتان Fork کنید.

  2. در Railway: New Project → Deploy from GitHub Repo و ریپوی فورک‌شده را انتخاب کنید.

  3. صبر کنید تا Build تمام شود (به‌خاطر build گرفتن از داشبورد، کمی طول می‌کشد).

  4. (اختیاری ولی پیشنهادی) در تب Variables این دو متغیر را اضافه کنید تا اولین ادمین به‌صورت خودکار ساخته شود:

    • SUDO_USERNAME
    • SUDO_PASSWORD

    اگر تنظیم نکنید، بعداً از Console سرویس همین دستور را بزنید:

    marzban-cli admin create --sudo
    
  5. دیتابیس پیش‌فرض SQLite است. اگر می‌خواهید از Postgres پلاگین Railway استفاده کنید، متغیر SQLALCHEMY_DATABASE_URL را در Variables ست کنید.

نکات

Marzban (x4gpanell/Marzban)

Searching Database…

这是什么?这是 Marzban VPN 面板(一个基于 Xray 的代理管理仪表盘)的 Railway 部署模板。Dockerfile 在构建时从 Gozargah/Marzban 克隆官方 Marzban 源码(而不是把源码塞进仓库),构建面板、安装 Xray,产出最终镜像。
这是 Marzban 的 fork,还是只是一个部署封装?它只是一个轻量的部署封装,构建方式与 PasarGuard 仓库相同:不把任何应用源码复制进本仓库,Dockerfile 在每次构建时都从上游获取最新源码。
怎么部署它?在 GitHub 上 fork 本仓库,然后在 Railway 里新建一个 Project 并选择“Deploy from GitHub Repo”,选中你的 fork。等待构建完成(需要一点时间,因为它还要构建面板)。
部署之前需要先准备什么吗?部署需要一个 Railway 账户。可选在 Railway 的 Variables 标签页里设置 SUDOUSERNAME 和 SUDOPASSWORD 变量,这样第一个管理员账号会自动创建;否则你稍后要从服务控制台手动创建。
数据库和端口配置是怎样的?默认数据库是 SQLite;要改用 Railway 的 Postgres 插件,需设置 SQLALCHEMYDATABASEURL 变量。监听端口由 Railway 通过 $PORT 自动注入,所以不需要手动配置端口。
Marzban 是什么?Marzban 是由 Gozargah 开发的基于网页的面板,用于管理 Xray 代理/VPN 的用户和配置;本仓库只是把它打包,方便在 Railway 上一键托管。
为什么在构建时克隆源码,而不是把它复制进仓库?构建时克隆意味着你总能拿到最新的 Marzban 版本、不会留下过期文件,本仓库的体积也很小,更新就像在 Railway 上重新部署一样简单。
可以固定使用特定的 Marzban 版本吗?可以。在 railway.toml 或 Build 设置里添加 MARZBANREF 构建参数来固定克隆的分支/标签;默认是 master。
这里面包含 Xray 本身吗?包含。Dockerfile 在构建镜像时会连同 Marzban 面板一起安装 Xray。
Creator
x4gpanell
Size
<0.1 MB
Stars
190
Updated
CommitAug 23
Age
1mo
Commits · 90 Days