Команды Marzban

Marzban предоставляет ряд команд для управления экземпляром приложения. Ниже приведен подробный обзор доступных команд.

Команды

up

Запускает все необходимые сервисы приложения.

Используйте эту команду для инициализации всех компонентов Marzban.

sudo marzban up

down

Останавливает все запущенные сервисы.

Это безопасный способ остановить все процессы, связанные с Marzban.

sudo marzban down

restart

Перезапускает все сервисы.

Эта команда полезна для применения изменений в конфигурации.

sudo marzban restart

status

Отображает текущий статус всех сервисов приложения.

Используйте эту команду, чтобы проверить, активны ли нужные сервисы.

sudo marzban status

logs

Показывает логи для всех сервисов.

Это может быть полезно для отладки и поиска причин возможных проблем.

sudo marzban logs

cli

Предоставляет доступ к интерфейсу командной строки Marzban для выполнения специфических задач.

sudo marzban cli

install

Выполняет установку Marzban на вашей системе.

Эта команда готовит все необходимое для запуска приложения.

sudo marzban install

update

Обновляет приложение до последней версии.

Рекомендуется выполнять обновление регулярно, чтобы использовать последние функции и исправления.

sudo marzban update

uninstall

Удаляет Marzban из вашей системы.

sudo marzban uninstall

CLI

Использование:

[ОПЦИИ] КОМАНДА [АРГУМЕНТЫ]...

Опции:

• --help: Показать это сообщение и выйти.

Команды:

• admin
• subscription
• user

admin

Использование:

admin [ОПЦИИ] КОМАНДА [АРГУМЕНТЫ]...

Опции:

• --help: Показать это сообщение и выйти.

Команды:

• create: Создает админа
• delete: Удаляет указанного админа
• import-from-env: Импортирует суперадмина из переменных окружения
• list: Отображает таблицу админов
• update: Обновляет указанного админа

admin create

Создает админа

Пароль также может быть установлен через переменную окружения MARZBAN_ADMIN_PASSWORD для использования без взаимодействия с пользователем.

Использование:

admin create [ОПЦИИ]

Опции:

• -u, --username TEXT: [обязательно]
• --sudo / --no-sudo
• --help: Показать это сообщение и выйти.

admin delete

Удаляет указанного админа

Подтверждение можно пропустить с помощью опции --yes/-y.

Использование:

admin delete [ОПЦИИ]

Опции:

• -u, --username TEXT: [обязательно]
• -y, --yes: Пропускает подтверждения
• --help: Показать это сообщение и выйти.

admin import-from-env

Импортирует суперадмина из переменных окружения

Подтверждение можно пропустить с помощью опции --yes/-y.

Что делает эта команда?

• Создает суперадмина согласно SUDO_USERNAME и SUDO_PASSWORD.
• Связывает любого пользователя, у которого нет admin_id, с импортированным суперадмином.

Использование:

admin import-from-env [ОПЦИИ]

Опции:

• -y, --yes: Пропускает подтверждения
• --help: Показать это сообщение и выйти.

admin list

Отображает таблицу админов

Использование:

admin list [ОПЦИИ]

Опции:

• -o, --offset INTEGER
• -l, --limit INTEGER
• -u, --username TEXT: Поиск по имени пользователя
• --help: Показать это сообщение и выйти.

admin update

Обновляет указанного админа

ПРИМЕЧАНИЕ: Эту команду НЕЛЬЗЯ использовать в режиме без взаимодействия с пользователем.

Использование:

admin update [ОПЦИИ]

Опции:

• -u, --username TEXT: [обязательно]
• --help: Показать это сообщение и выйти.

subscription

Использование:

subscription [ОПЦИИ] КОМАНДА [АРГУМЕНТЫ]...

Опции:

• --help: Показать это сообщение и выйти.

Команды:

• get-config: Генерирует конфигурацию подписки.
• get-link: Выводит ссылку на подписку указанного пользователя.

subscription get-config

Генерирует конфигурацию подписки.

Генерирует конфигурацию подписки для указанного пользователя в указанном формате.

Выходные данные будут записаны в выходной файл, если указан output-file, в противном случае будут показаны в терминале.

Использование:

subscription get-config [ОПЦИИ]

Опции:

• -u, --username TEXT: [обязательно]
• -f, --format [v2ray|clash]: [обязательно]
• -o, --output TEXT: Записывает сгенерированную конфигурацию в файл, если указано
• --base64: Кодирует выходные данные в формате base64, если указано
• --help: Показать это сообщение и выйти.

subscription get-link

Выводит ссылку на подписку указанного пользователя.

ПРИМЕЧАНИЕ: Для корректной работы этой команды необходимо установить переменную окружения XRAY_SUBSCRIPTION_URL_PREFIX.

Использование:

subscription get-link [ОПЦИИ]

Опции:

• -u, --username TEXT: [обязательно]
• --help: Показать это сообщение и выйти.

user

Использование:

user [ОПЦИИ] КОМАНДА [АРГУМЕНТЫ]...

Опции:

• --help: Показать это сообщение и выйти.

Команды:

• list: Отображает таблицу пользователей
• set-owner: Передает право владения пользователя

user list

Отображает таблицу пользователей

ПРИМЕЧАНИЕ: В настоящее время сортировка недоступна.

Использование:

user list [ОПЦИИ]

Опции:

• -o, --offset INTEGER
• -l, --limit INTEGER
• -u, --username TEXT: Поиск по имени пользователя
• --status [active|disabled|limited|expired]
• --admin, --owner TEXT: Поиск по имени админа-владельца
• --help: Показать это сообщение и выйти.

user set-owner

Передает право владения пользователя

ПРИМЕЧАНИЕ: Эта команда требует дополнительного подтверждения для пользователей, у которых уже есть владелец.

Использование:

user set-owner [ОПЦИИ]

Опции:

• -u, --username TEXT
• --admin, --owner TEXT: Имя пользователя админа
• -y, --yes: Пропускает подтверждения
• --help: Показать это сообщение и выйти.