Скрипт установки¶

install.sh разворачивает панель на Docker Compose одной командой и без вопросов: проверяет окружение, кладёт compose-файлы, сам генерирует секреты, поднимает стек и ждёт, пока панель реально ответит. Всё, что нужно решить человеку, укладывается в один флаг — профиль.

Три профиля¶

curl -fsSL https://raw.githubusercontent.com/AlexeyShalaev/vpn-hub/master/deploy/scripts/install.sh | bash

curl -fsSL https://raw.githubusercontent.com/AlexeyShalaev/vpn-hub/master/deploy/scripts/install.sh \
  | bash -s -- --domain vpn.example.com     # ← подставьте свой домен

curl -fsSL https://raw.githubusercontent.com/AlexeyShalaev/vpn-hub/master/deploy/scripts/install.sh -o install.sh
less install.sh          # прочитайте, что скрипт собирается сделать
bash install.sh --domain vpn.example.com

В конце скрипт печатает адрес панели, напоминание про мастер-ключ и — последней строкой — машиночитаемый JSON ({"url":…,"dir":…,"profile":…}) для автоматизации.

Повторный запуск = настройка¶

.env идемпотентен: секреты никогда не перезаписываются. Но явно переданные флаги меняют конфигурацию существующей установки — скрипт печатает дифф «старое → новое»:

$ bash install.sh --domain vpn.example.com
[ ok ] COMPOSE_FILE: compose.yaml → compose.yaml:caddy.compose.yaml
[ ok ] VPNHUB_BASE_URL: http://localhost:8000 → https://vpn.example.com
[ ok ] VPNHUB_DOMAIN = vpn.example.com

Так локальная установка «дорастает» до HTTPS одной командой. Обратно — --local. Не меняются повторным запуском только мастер-ключ и база данных (см. ниже).

Флаги¶

Каждый флаг имеет env-эквивалент (в скобках) — удобно для cloud-init/Terraform.

Скрипт валидирует ввод до каких-либо изменений на диске: обрезает случайно вставленную схему у домена (https://Foo.Bar.com/x → foo.bar.com), отказывается от литерального vpn.example.com, проверяет пару админа и формат host:port.

Внешняя база данных¶

bash install.sh --domain vpn.example.com \
  --external-db 'postgresql+asyncpg://vpnhub:PA%40ss@db.example.com:5432/vpnhub?ssl=require'

DSN тоже проверяется до установки: postgres:// и postgresql:// автоматически переписываются на обязательный postgresql+asyncpg:// (с предупреждением), при отсутствии ssl= для не-локального хоста скрипт напомнит про ?ssl=require, а $ в пароле экранируется для compose. Спецсимволы URL-кодируйте (@→%40, :→%3A). Подробнее — Внешняя база данных.

Перенос и восстановление¶

Мастер-ключ и база существующей установки скриптом не меняются — это защита от потери данных. Перенос на новую машину: снимите .vhb-бэкап, поставьте панель заново с --master-key <ваш прежний ключ> и восстановитесь из бэкапа (Первый запуск → Из бэкапа).

Предпросмотр без изменений¶

bash install.sh --dry-run --domain vpn.example.com

Печатает все шаги (что скачает, что запишет в .env, какие команды выполнит), ничего не делая. Не требует Docker и сети.

Как это устроено внутри¶

• Скрипт пишет в .env строку COMPOSE_FILE=compose.yaml:caddy.compose.yaml (для --domain) — Docker Compose читает её сам, поэтому update.sh, uninstall.sh и любой docker compose … из каталога установки всегда видят весь стек. Двойной -f не нужен.
• Домен попадает в Caddyfile через плейсхолдер {$VPNHUB_DOMAIN} — файл не редактируется.
• Вместе с секретами генерируется VPNHUB_METRICS_TOKEN — /metrics закрыт с первого запуска (Переменные окружения).
• После up скрипт ждёт /healthz (до 2 минут: на первом старте идут миграции) и честно падает с командой для логов, если панель не поднялась.

Обновление¶

Обновляйтесь скриптом update.sh из того же каталога: он тянет новый образ и пересоздаёт контейнеры. .env и тома (БД, бэкапы) не трогаются; набор файлов берётся из COMPOSE_FILE, поэтому Caddy-оверлей переживает обновления.

curl -fsSL https://raw.githubusercontent.com/AlexeyShalaev/vpn-hub/master/deploy/scripts/update.sh | bash

Сменить версию — флагом --tag (запишет VPNHUB_TAG в .env):

bash update.sh --tag 1.3.0        # по умолчанию обновляет $HOME/vpn-hub; другой каталог — --dir PATH

Удаление¶

uninstall.sh по умолчанию безопасен: контейнеры удаляются, тома с данными и .env сохраняются (перед удалением томов — явное подтверждение).

curl -fsSL https://raw.githubusercontent.com/AlexeyShalaev/vpn-hub/master/deploy/scripts/uninstall.sh | bash

Windows¶

На Windows Docker работает поверх WSL2 (нужен Docker Desktop). install.ps1 повторяет install.sh, включая профили и повторный запуск с параметрами:

irm https://raw.githubusercontent.com/AlexeyShalaev/vpn-hub/master/deploy/scripts/install.ps1 | iex

irm https://raw.githubusercontent.com/AlexeyShalaev/vpn-hub/master/deploy/scripts/install.ps1 -OutFile install.ps1
# прочитайте install.ps1, затем:
powershell -ExecutionPolicy Bypass -File .\install.ps1 -Domain vpn.example.com

Параметры зеркалят bash-флаги: -Domain, -Lan, -LocalOnly, -ExternalDb, -Tag, -MasterKey, -AdminPhone/-AdminPassword, -BaseUrl, -HttpAddr, -InstallDir, -Ref, -NoPull, -DryRun. Env-эквиваленты — те же, что у install.sh.

Дальше: Первый запуск и вход → · Обновление → · Переменные окружения →