Add first-run web setup and Compose without environment or secrets
This commit is contained in:
54
SIMPLE.md
Normal file
54
SIMPLE.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# Homegate: запуск и настройка через браузер
|
||||
|
||||
Используйте образ `gitea.hyperdog.dev/dizyaka/homegate:0.4.1` после успешной публикации
|
||||
версии в Gitea Actions. Содержимое [compose.simple.yaml](compose.simple.yaml) сохраните
|
||||
на сервере как `compose.yaml`. Файл не содержит адресов, environment, secrets или паролей.
|
||||
|
||||
```sh
|
||||
docker compose pull
|
||||
docker compose up -d --remove-orphans
|
||||
```
|
||||
|
||||
Для приватного пакета один раз выполните `docker login gitea.hyperdog.dev`.
|
||||
Это авторизация скачивания образа; параметры Homegate через неё не передаются.
|
||||
|
||||
Откройте `http://IP-СЕРВЕРА:8098`. Панель открывается без логина и показывает форму
|
||||
первой настройки. Укажите прямо в ней:
|
||||
|
||||
- IP NPM, домашние подсети и доменные зоны;
|
||||
- URL административного API NPM, его логин и пароль;
|
||||
- URL Pi-hole 6 и его пароль либо ручной режим DNS;
|
||||
- при необходимости другой URL SSH-конфига и PEM корневого CA для HTTPS API.
|
||||
|
||||
Нажмите **Сохранить и начать**, затем добавляйте сервисы и SSH-хосты. Вся последующая
|
||||
настройка доступна в разделе **Настройки**. Адреса и credentials перечитываются
|
||||
контроллером без перезапуска. Пустое поле пароля при редактировании сохраняет прежнее значение.
|
||||
|
||||
UI, контроллер и SSH-export работают в одном контейнере. До завершения первой настройки
|
||||
работает только UI; запросы к NPM/Pi-hole ещё не выполняются. Открытые порты: `8098` для
|
||||
панели и `8099` для `/ssh-config`. До настройки UI принимает подключения с loopback,
|
||||
RFC1918 и ULA адресов; после настройки действует список разрешённых подсетей.
|
||||
|
||||
Пароли NPM/Pi-hole нужны их API, вводятся в форме и сохраняются в config volume.
|
||||
Они не возвращаются в API состояния, скачиваемом YAML или SSH-конфиге.
|
||||
Локальные HTTPS сертификаты и ключ CA Homegate создаёт сам. Публичный корневой сертификат
|
||||
скачивается в разделе **Сертификаты**; установите его на клиентские устройства для доверия HTTPS.
|
||||
|
||||
## Обновление с прежнего Compose
|
||||
|
||||
Сохраните имя проекта `homegate` и volumes `config`, `state`, `control` из прежнего файла.
|
||||
Новый Compose использует те же данные: сервисы, SSH, история и CA сохраняются.
|
||||
Замените файл на `compose.simple.yaml` и выполните команды выше. `--remove-orphans`
|
||||
удаляет прежние отдельные контейнеры `initialize`, `ui`, `ssh-export`, освобождая их порты;
|
||||
volumes остаются. Адреса и credentials API из прежнего окружения один раз введите в UI.
|
||||
|
||||
## Проверки
|
||||
|
||||
Unit/HTTP-тесты проверяют первичную настройку без env, LAN-доступ, сохранение credentials,
|
||||
их отсутствие в публичных ответах, изменение API-подключений и остановку дочерних процессов.
|
||||
`ci/check_compose.py` проверяет, что простой Compose не требует environment/configs/secrets.
|
||||
|
||||
Контейнерную проверку запускайте только локально на отдельном временном Compose-проекте:
|
||||
`ci/smoke_setup.py` выполняется внутри контейнера с аргументом `write`, а после перезапуска —
|
||||
с `verify`. Используются API-заглушки на loopback и временные пароли. В Gitea Actions
|
||||
контейнеры Homegate не запускаются: только тесты, проверка Compose, сборка и публикация образа.
|
||||
Reference in New Issue
Block a user