mistgate Документация
Документация

Документация Mistgate

Mistgate — панель для собственного VPN-флота: один бинарь для панели, один для агента ноды, Hysteria2 и AmneziaWG в одной подписке. Документация описывает то, что код умеет сегодня; то, что ещё в работе, помечено Планируется.

На этой странице

Что где#

Раздел Для чего
Начало работы Основные понятия, что понадобится, и путь от пустого сервера до первого пользователя с рабочей подпиской.
Руководство Повседневная работа в админке: ноды, профили, протоколы, WARP, пользователи, подписки, страница пользователя, DNS.
Эксплуатация Как следить за здоровьем флота, обновлять его и защищать, и что делать, когда что-то сломалось.
Справочник Точные команды, флаги, переменные окружения, API, MCP-сервер и устройство системы.

С чего начать новому администратору#

  1. Обзор и Требования: что такое панель, нода и профиль и какие серверы нужны.
  2. Установка панели, затем Добавление ноды.
  3. Первые пользователи: профиль на ноде, группа, пользователь, ссылка подписки.
  4. Здоровье и Безопасность — до того, как раздавать ссылки другим людям.
  5. Страницы руководства — по мере надобности; справочник — когда пишете скрипты или автоматизируете.

Все страницы#

Начало работы#

  • Обзор: что такое Mistgate и его понятия: панель, нода, профиль, сервер на ноде, пользователь, группа, устройство, подписка, страница пользователя.
  • Требования: что нужно панели и нодам и что нужно для сборки из исходников.
  • Установка панели: от чистого Linux-сервера до аккаунта владельца в админке.
  • Добавление ноды: подключить сервер с агентом и увидеть, как он выходит в онлайн.
  • Первые пользователи: поставить профиль на ноду, дать его группе, создать пользователя и отправить ему ссылку.

Руководство#

  • Ноды: настройки ноды, её состояние и что агент делает на хосте.
  • Профили: что такое профиль и как он становится сервером на ноде.
  • Hysteria2: настройки профиля Hysteria2, сертификаты и обфускация.
  • AmneziaWG: профили AmneziaWG 2.0 и 3.1, userspace или модуль ядра, устройства и ключи.
  • WARP: как пустить трафик профиля через Cloudflare WARP.
  • Пользователи и группы: пользователи, группы, устройства, лимиты трафика и сроки.
  • Подписки: одна ссылка на человека и какой формат получает каждое приложение.
  • Страница пользователя: личная страница человека с инструкциями, QR-кодом и трафиком.
  • DNS: DNS-пресеты для пользователей и групп и DNS на нодах.

Эксплуатация#

  • Здоровье: проверки глазами клиента, доктор нод и алерты.
  • Обновления: самообновление агента, ключи релиза, раскатки и обновление панели.
  • Безопасность: вход в админку, роли, повторное подтверждение входа, сессии, аудит, сайт-ширма и скрытая админка, каталог данных и резервные копии, восстановление доступа.
  • Решение проблем: частые проблемы и как найти их причину.

Справочник#

  • CLI: все команды и флаги mistgate и mistgate-node.
  • Конфигурация: все флаги serve и setup, все переменные окружения MISTGATE_* и устройство каталога данных.
  • API: Connect API, API-токены и их профили.
  • MCP: MCP-сервер, stdio-прокси, инструменты, «план → применить» и одобрения.
  • Архитектура: как панель, агенты и клиенты общаются друг с другом.
  • FAQ: короткие ответы на частые вопросы.