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…

Что это?Это шаблон развёртывания на Railway для VPN-панели Marzban (дашборд управления прокси на базе Xray). Dockerfile клонирует официальный исходный код Marzban из Gozargah/Marzban во время сборки, а не хранит его в репозитории, собирает дашборд, устанавливает Xray и создаёт итоговый образ.
Это форк Marzban или просто обёртка для развёртывания?Это лишь тонкая обёртка для развёртывания, устроенная так же, как репозиторий PasarGuard: исходный код приложения не копируется в этот репозиторий — Dockerfile при каждой сборке забирает его свежим из апстрима.
Как это развернуть?Сделайте форк этого репозитория на GitHub, затем в Railway создайте New Project, выберите «Deploy from GitHub Repo» и укажите свой форк. Дождитесь окончания сборки (это займёт некоторое время, так как собирается ещё и дашборд).
Нужно ли что-то подготовить перед развёртыванием?Для развёртывания нужен аккаунт Railway. При желании задайте переменные SUDOUSERNAME и SUDOPASSWORD во вкладке Variables в Railway, чтобы первый админский аккаунт создался автоматически; иначе вы создадите его позже из консоли сервиса.
Как быть с базой данных и настройкой порта?База по умолчанию — SQLite; чтобы вместо неё использовать Postgres-плагин Railway, задайте переменную SQLALCHEMYDATABASEURL. Порт прослушивания Railway подставляет автоматически через $PORT, так что вручную порт настраивать не нужно.
Что такое Marzban?Marzban — веб-панель от Gozargah для управления пользователями и конфигурациями прокси/VPN на Xray; этот репозиторий лишь упаковывает её для хостинга на Railway в один клик.
Зачем клонировать исходники при сборке, а не копировать их в репозиторий?Клонирование при сборке означает, что вы всегда получаете свежий релиз Marzban без устаревших файлов, этот репозиторий остаётся крошечным по размеру, а обновление сводится к повторному развёртыванию на Railway.
Можно ли закрепить конкретную версию Marzban?Да, добавьте аргумент сборки MARZBANREF в railway.toml или в свои настройки Build, чтобы закрепить клонируемую ветку/тег; по умолчанию — master.
Xray сам включён в комплект?Да, Dockerfile устанавливает Xray в ходе сборки образа вместе с дашбордом Marzban.
Creator
x4gpanell
Size
<0.1 MB
Stars
190
Updated
CommitAug 23
Age
1mo
Commits · 90 Days