From a83d897b70c79a705f28de0708fb1ffd7698bf99 Mon Sep 17 00:00:00 2001 From: DizelBadCoder Date: Wed, 14 Oct 2026 03:26:50 +0300 Subject: [PATCH] Add first-run web setup and Compose without environment or secrets --- .dockerignore | 1 + .gitea/workflows/release.yaml | 1 + Dockerfile | 5 +- README.md | 16 ++-- REGISTRY.md | 17 ++-- SIMPLE.md | 54 ++++++++++++ VERSION | 2 +- WEB.md | 3 + ci/check_compose.py | 10 +++ ci/smoke_setup.py | 111 ++++++++++++++++++++++++ compose.registry.yaml | 2 +- compose.simple.yaml | 20 +++++ compose.yaml | 6 +- homegate.py | 23 +++-- homegate_ui.py | 118 +++++++++++++++++++++---- standalone.py | 111 ++++++++++++++++++++++++ tests/test_setup.py | 158 ++++++++++++++++++++++++++++++++++ ui/dist/app.js | 13 +-- ui/dist/index.html | 1 + ui/dist/settings.js | 70 +++++++++++++++ 20 files changed, 689 insertions(+), 53 deletions(-) create mode 100644 SIMPLE.md create mode 100644 ci/smoke_setup.py create mode 100644 compose.simple.yaml create mode 100644 standalone.py create mode 100644 tests/test_setup.py create mode 100644 ui/dist/settings.js diff --git a/.dockerignore b/.dockerignore index 44065ed..01d44cb 100644 --- a/.dockerignore +++ b/.dockerignore @@ -8,4 +8,5 @@ !ui/dist/ !ui/dist/** !bootstrap.py +!standalone.py !VERSION diff --git a/.gitea/workflows/release.yaml b/.gitea/workflows/release.yaml index 1ae3388..23bd8f8 100644 --- a/.gitea/workflows/release.yaml +++ b/.gitea/workflows/release.yaml @@ -33,6 +33,7 @@ jobs: - name: JavaScript and shell syntax run: | node --check ui/dist/app.js + node --check ui/dist/settings.js for script in setup.sh run-local.sh ci/smoke_image.sh; do sh -n "$script"; done - name: Compose contracts env: diff --git a/Dockerfile b/Dockerfile index 01b339d..e0255f8 100644 --- a/Dockerfile +++ b/Dockerfile @@ -2,12 +2,13 @@ FROM python:3.13-slim-bookworm WORKDIR /app COPY requirements.txt . RUN pip install --no-cache-dir -r requirements.txt -COPY homegate.py sync_ssh.py homegate_ui.py bootstrap.py VERSION . +COPY homegate.py sync_ssh.py homegate_ui.py bootstrap.py standalone.py VERSION . COPY ui/dist ./ui/dist -ARG VERSION=0.4.0 +ARG VERSION=0.4.1 LABEL org.opencontainers.image.title="Homegate" \ org.opencontainers.image.description="LAN DNS, HTTPS and SSH management for Pi-hole and NPM" \ org.opencontainers.image.version=$VERSION +RUN mkdir -p /config /data /control && chown 1000:1000 /config /data /control USER 1000:1000 ENTRYPOINT ["python", "/app/homegate.py"] CMD ["run"] diff --git a/README.md b/README.md index 4b75667..3112035 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Homegate 0.4 +# Homegate 0.4.1 Дополнение к **существующим Pi-hole и Nginx Proxy Manager** для домашней сети: @@ -6,12 +6,14 @@ https://pve.home → NPM:443 → https://192.168.0.137:8006 ``` -Вы описываете сервисы в `config/services.yaml`. Homegate создаёт локальные DNS-записи, +Вы добавляете сервисы в веб-панели. Homegate создаёт локальные DNS-записи, сертификаты и Proxy Hosts, затем поддерживает их актуальными. Развёртывание — Docker Compose. Веб-панель Homegate управляет сервисами, доменными зонами, SSH и настройками сети. -Отдельный контейнер публикует SSH-конфиг без авторизации для устройств домашней подсети. +SSH-конфиг публикуется без авторизации для устройств домашней подсети. -Новое в 0.4: [один Compose-файл, готовый образ и Gitea Actions](REGISTRY.md). +**Простой запуск 0.4.1: [Compose без env и secrets, вся настройка в UI](SIMPLE.md).** +Откройте `http://IP-СЕРВЕРА:8098` и заполните адреса NPM/Pi-hole в форме. Пароль панели не нужен. +Расширенный вариант с отдельными контейнерами: [Compose и Gitea Actions](REGISTRY.md). Также доступны: [веб-панель и локальный запуск](WEB.md), [SSH-конфиг и скрипт для ПК](SSH.md), [кастомные доменные зоны и миграция CA](DOMAINS.md). **Для HTTPS без предупреждений нужно один раз установить `root-ca.crt` на каждое @@ -63,12 +65,12 @@ DNS указывает на **NPM**, а не на Proxmox. Порт и прот - Если Pi-hole и NPM на одном IP, их web-порты должны различаться: например NPM `80/81/443`, Pi-hole web `8080`, DNS `53`. Homegate этот конфликт автоматически не исправляет. -Проверены Compose-конфигурация, shell-синтаксис и 55 тестов: сертификаты, настоящее TLS-рукопожатие +Проверены Compose-конфигурация, shell-синтаксис и 63 теста: сертификаты, настоящее TLS-рукопожатие в стандартных и кастомных зонах, продление, повторный запуск, конфликты, ошибки API, смена CA, HTTP-обработчик выгрузки, LAN ACL и отказ опасных SSH-директив. Подключение дополнительного файла также проверено настоящим `ssh -G` с сохранением личных настроек. -HTTP API в тестах имитируются по официальным контрактам. **Запуск образа, реальные API NPM/Pi-hole, -HTTPS-сервисы и noVNC на вашем сервере ещё не проверены:** локальная служба Docker при подготовке не работала. +HTTP API в тестах имитируются по официальным контрактам. Сборка и локальный запуск контейнеров +проверены отдельно. Реальные API NPM/Pi-hole, HTTPS-сервисы и noVNC на вашем сервере не проверены. ## Быстрый запуск из исходников diff --git a/REGISTRY.md b/REGISTRY.md index 50ddfd9..d533095 100644 --- a/REGISTRY.md +++ b/REGISTRY.md @@ -1,5 +1,8 @@ # Один Compose-файл и Gitea Container Registry +Для запуска без environment, secrets и пароля панели используйте [compose.simple.yaml](SIMPLE.md): +все адреса и подключения задаются в UI. Ниже описан расширенный вариант с отдельными контейнерами. + Homegate 0.4 поддерживает два способа установки: | Файл | Назначение | @@ -72,7 +75,7 @@ Homegate 0.4 поддерживает два способа установки: По умолчанию registry берётся из адреса Gitea, image — из `owner/repository` в нижнем регистре: ```text -git.example.home/your-user/homegate:0.4.0 +git.example.home/your-user/homegate:0.4.1 ``` Если registry доступен по другому имени/порту, задайте Actions **variable** `REGISTRY`, @@ -86,11 +89,11 @@ git.example.home/your-user/homegate:0.4.0 ## 2. Выпустите образ -Файл `VERSION` сейчас содержит `0.4.0`. После загрузки проверенного кода в Gitea: +Файл `VERSION` сейчас содержит `0.4.1`. После загрузки проверенного кода в Gitea: ```sh -git tag v0.4.0 -git push origin v0.4.0 +git tag v0.4.1 +git push origin v0.4.1 ``` При следующем выпуске измените `VERSION`, закоммитьте его вместе с изменениями и создайте @@ -107,7 +110,7 @@ Workflow `.gitea/workflows/release.yaml` выполняет: 3. Только для push тега `v*`, после успешных проверок — проверку `VERSION`, сборку `linux/amd64` + `linux/arm64` и публикацию в Gitea Container Registry. -Образ получает два тега: `0.4.0` и `sha-<полный SHA коммита>`. Тег `latest` не создаётся. +Образ получает два тега: `0.4.1` и `sha-<полный SHA коммита>`. Тег `latest` не создаётся. `org.opencontainers.image.source` связывает метаданные образа с URL исходников. Права на просмотр/скачивание пакета проверьте в Gitea Packages отдельно от доступа к коду. Workflow не запускает контейнеры Homegate и не развёртывает приложение. @@ -133,7 +136,7 @@ sh ci/smoke_image.sh homegate:test В Bash укажите свои адреса. Здесь `.10`, `.11` и `.2` — примеры: ```bash -export HOMEGATE_IMAGE=git.example.home/your-user/homegate:0.4.0 +export HOMEGATE_IMAGE=git.example.home/your-user/homegate:0.4.1 export HOMEGATE_LAN_IP=192.168.0.10 export HOMEGATE_PROXY_IP=192.168.0.11 export HOMEGATE_ALLOWED_NETWORKS='[192.168.0.0/24]' @@ -263,7 +266,7 @@ docker compose start homegate ui ssh-export ## Что проверено -Локально проходят 55 тестов, включая первый запуск, сохранение пользовательских изменений +Локально проходят 63 теста, включая первый запуск, сохранение пользовательских изменений и CA, отказ от повреждённого конфига и проверку адреса/версии публикуемого образа. Оба Compose-файла проверяются установленным Docker Compose, включая совместимость `read_only` с источниками configs/secrets. Синтаксис shell, JavaScript и YAML workflow проверен. diff --git a/SIMPLE.md b/SIMPLE.md new file mode 100644 index 0000000..88efd57 --- /dev/null +++ b/SIMPLE.md @@ -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, сборка и публикация образа. diff --git a/VERSION b/VERSION index 1d0ba9e..267577d 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.4.0 +0.4.1 diff --git a/WEB.md b/WEB.md index 00fd189..0bce439 100644 --- a/WEB.md +++ b/WEB.md @@ -54,6 +54,9 @@ sh outputs/homegate/run-local.sh ## Панель для домашней сети через Docker +В версии 0.4.1 есть [простой Compose](SIMPLE.md): панель без логина, первичная настройка +и подключения к NPM/Pi-hole целиком в UI. `UI_ORIGIN`, LAN-IP и credentials в окружении не нужны. + Для готового образа и автоматического создания volumes используйте [один Compose-файл](REGISTRY.md). Ниже — вариант сборки из исходников. diff --git a/ci/check_compose.py b/ci/check_compose.py index 8097d4d..c13a8e1 100644 --- a/ci/check_compose.py +++ b/ci/check_compose.py @@ -23,6 +23,16 @@ def check_read_only_resources(model): def main(): + simple = json.loads(subprocess.check_output( + ['docker', 'compose', '--env-file', os.devnull, '-f', 'compose.simple.yaml', + 'config', '--format', 'json'])) + assert set(simple['services']) == {'homegate'} + service = simple['services']['homegate'] + assert not service.get('environment') and not service.get('env_file') + assert not simple.get('secrets') and not simple.get('configs') + assert service['image'] == 'gitea.hyperdog.dev/dizyaka/homegate:' + Path('VERSION').read_text().strip() + assert {p['published'] for p in service['ports']} == {'8098', '8099'} + assert {v['source'] for v in service['volumes']} == {'config', 'state', 'control'} env = dict(os.environ, HOMEGATE_IMAGE='registry.example/homegate/homegate:0.4.0', HOMEGATE_LAN_IP='192.168.0.10', HOMEGATE_PROXY_IP='192.168.0.10', HOMEGATE_ALLOWED_NETWORKS='[192.168.0.0/24]', HOMEGATE_ZONES='[home, home.arpa]', diff --git a/ci/smoke_setup.py b/ci/smoke_setup.py new file mode 100644 index 0000000..f2d7609 --- /dev/null +++ b/ci/smoke_setup.py @@ -0,0 +1,111 @@ +"""Run manually inside a disposable standalone container: python - write|verify < this file.""" +import hashlib +import http.cookiejar +from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer +import json +from pathlib import Path +import sys +import threading +import time +import urllib.error +import urllib.request + +origin = 'http://127.0.0.1:8081' +opener = urllib.request.build_opener(urllib.request.ProxyHandler({}), + urllib.request.HTTPCookieProcessor(http.cookiejar.CookieJar())) +csrf = '' +def request(path, body=None): + headers = {} + if body is not None: + headers = {'Origin': origin, 'Content-Type': 'application/json', 'X-Homegate-CSRF': csrf} + payload = json.dumps(body).encode() if body is not None else None + with opener.open(urllib.request.Request(origin + path, payload, headers), timeout=3) as response: + data = response.read() + return json.loads(data) if 'application/json' in response.headers.get('Content-Type', '') else data + +def wait_for(predicate): + deadline = time.monotonic() + 20 + while time.monotonic() < deadline: + value = predicate() + if value: + return value + time.sleep(0.25) + raise AssertionError('Timed out waiting for controller') + +def session_ready(): + try: + return request('/api/session') + except urllib.error.HTTPError: + raise + except urllib.error.URLError: + return None + +session = wait_for(session_ready) +assert session['authenticated'] +csrf = session['csrf'] +state = request('/api/state') +assert not state['auth_required'] +assert b'renderManagedSettings' in request('/settings.js') + +if sys.argv[-1] == 'write': + assert state['setup_required'] + seen = [] + class API(BaseHTTPRequestHandler): + def do_GET(self): + length = int(self.headers.get('Content-Length', '0')) + body = json.loads(self.rfile.read(length)) if length else None + if self.path == '/api/tokens': + seen.append((self.server.server_port, body['identity'], body['secret'])) + value = {'token': 'disposable-token'} + elif self.path == '/api/auth': + value = {'session': {'valid': True, 'sid': 'disposable-sid', 'csrf': 'disposable-csrf'}} + elif self.path == '/api/config/dns': + value = {'config': {'dns': {'hosts': [], 'cnameRecords': []}}} + else: + value = [] + data = json.dumps(value).encode() + self.send_response(200) + self.send_header('Content-Type', 'application/json') + self.send_header('Content-Length', str(len(data))) + self.end_headers() + self.wfile.write(data) + do_POST = do_GET + do_DELETE = do_GET + def log_message(self, *args): + pass + servers = [ThreadingHTTPServer(('127.0.0.1', port), API) for port in (18181, 18182)] + for server in servers: + threading.Thread(target=server.serve_forever, daemon=True).start() + try: + config = state['config'] + config.update(proxy_ip='192.168.42.11', allowed_networks=['10.0.0.0/8', '172.16.0.0/12', '192.168.0.0/16'], + ssh_hosts=[{'aliases': ['qa-nas'], 'host': '192.168.42.50', 'port': 22, 'user': 'test'}]) + links = {'npm_url': 'http://127.0.0.1:18181', 'npm_identity': 'test@example.invalid', + 'npm_password': 'disposable-npm-password', 'pihole_url': 'http://127.0.0.1:18181', + 'pihole_password': 'disposable-pihole-password'} + state = request('/api/settings', {'config': config, 'connections': links, 'revision': state['revision']}) + assert not state['setup_required'] + wait_for(lambda: request('/api/state')['controller'].get('ok')) + assert (18181, 'test@example.invalid', 'disposable-npm-password') in seen + ca_before = Path('/data/root-ca.crt').read_bytes() + links.update(npm_url='http://127.0.0.1:18182', npm_password='changed-npm-password') + request('/api/settings', {'config': config, 'connections': links, 'revision': state['revision']}) + wait_for(lambda: (18182, 'test@example.invalid', 'changed-npm-password') in seen) + assert Path('/data/root-ca.crt').read_bytes() == ca_before + assert 'changed-npm-password' not in json.dumps(request('/api/state')) + with opener.open('http://127.0.0.1:8080/healthz') as response: + assert response.status == 200 + assert b'Host qa-nas' in request('/downloads/ssh-config') + Path('/data/.qa-fingerprint').write_text(hashlib.sha256(ca_before).hexdigest()) + print('Standalone: no-env onboarding, real HTTP settings, NPM/Pi-hole mock login, live API reload, CA and SSH verified.') + finally: + for server in servers: + server.shutdown() +else: + assert not state['setup_required'] + assert state['connections']['npm_url'] == 'http://127.0.0.1:18182' + assert state['connections']['npm_password_set'] + assert state['config']['ssh_hosts'][0]['aliases'] == ['qa-nas'] + assert hashlib.sha256(Path('/data/root-ca.crt').read_bytes()).hexdigest() == Path('/data/.qa-fingerprint').read_text() + assert b'Host qa-nas' in request('/downloads/ssh-config') + print('Standalone restart: setup, credentials, SSH inventory and CA retained; no login or environment required.') diff --git a/compose.registry.yaml b/compose.registry.yaml index 3fac43d..4ddd48b 100644 --- a/compose.registry.yaml +++ b/compose.registry.yaml @@ -1,6 +1,6 @@ # Download this file only. Supply settings/passwords via the shell or an optional .env. # Docker Compose >= 2.30.0 (not docker stack deploy). See REGISTRY.md. -# Example image: git.example.home/your-user/homegate:0.4.0 +# Example image: git.example.home/your-user/homegate:0.4.1 name: homegate x-runtime: &runtime diff --git a/compose.simple.yaml b/compose.simple.yaml new file mode 100644 index 0000000..468f904 --- /dev/null +++ b/compose.simple.yaml @@ -0,0 +1,20 @@ +name: homegate + +services: + homegate: + image: gitea.hyperdog.dev/dizyaka/homegate:0.4.1 + entrypoint: [python, /app/standalone.py] + restart: unless-stopped + init: true + ports: + - "8098:8081" + - "8099:8080" + volumes: + - config:/config + - state:/data + - control:/control + +volumes: + config: + state: + control: diff --git a/compose.yaml b/compose.yaml index 4eaa053..faa56d8 100644 --- a/compose.yaml +++ b/compose.yaml @@ -2,7 +2,7 @@ name: homegate services: homegate: build: . - image: homegate:0.4.0 + image: homegate:0.4.1 restart: unless-stopped init: true user: "${LOCAL_UID:-1000}:${LOCAL_GID:-1000}" @@ -50,7 +50,7 @@ services: ssh-export: build: . - image: homegate:0.4.0 + image: homegate:0.4.1 command: [serve] restart: unless-stopped init: true @@ -87,7 +87,7 @@ services: ui: build: . - image: homegate:0.4.0 + image: homegate:0.4.1 entrypoint: [python, /app/homegate_ui.py] command: [] restart: unless-stopped diff --git a/homegate.py b/homegate.py index 7f3fe84..66d1e55 100644 --- a/homegate.py +++ b/homegate.py @@ -359,9 +359,11 @@ def export_handler(config_path): def serve_export(config_path): load_config(config_path) - # Compose requires an explicit private host IP; never publish on every host interface. - bind_ip = private_address(os.environ.get("SSH_BIND_IP", "")) - require(ipaddress.ip_address(bind_ip).version == 4, "SSH_BIND_IP must be a private IPv4 address") + # The standalone deployment enforces LAN access through the configured subnets. + bind_ip = "LAN (configured in the web panel)" + if os.environ.get("HOMEGATE_MANAGED_UI") != "1": + bind_ip = private_address(os.environ.get("SSH_BIND_IP", "")) + require(ipaddress.ip_address(bind_ip).version == 4, "SSH_BIND_IP must be a private IPv4 address") with ThreadingHTTPServer(("0.0.0.0", 8080), export_handler(config_path)) as server: LOG.info("SSH export available through Docker binding %s; path /ssh-config", bind_ip) server.serve_forever() @@ -565,15 +567,22 @@ def secret(name): def cycle(config, state, ca, registry): verify = os.environ.get("API_CA_BUNDLE") or True - npm = NPM(os.environ.get("NPM_URL", ""), "NPM", verify) + settings_file = os.environ.get("HOMEGATE_CONNECTIONS") + settings = read_json(Path(settings_file)) if settings_file else None + if settings is not None and settings.get("api_ca_pem"): + ca_path = Path(settings_file).with_name("management-ca.pem") + atomic(ca_path, settings["api_ca_pem"].encode(), 0o600) + verify = str(ca_path) + npm = NPM(settings["npm_url"] if settings is not None else os.environ.get("NPM_URL", ""), "NPM", verify) dns = None dns_error = False try: - npm.login(os.environ.get("NPM_IDENTITY", ""), secret("NPM")) + npm.login(settings["npm_identity"] if settings is not None else os.environ.get("NPM_IDENTITY", ""), + settings["npm_password"] if settings is not None else secret("NPM")) if config["dns_mode"] == "pihole6": - dns = PiHole(os.environ.get("PIHOLE_URL", ""), "PIHOLE", verify) + dns = PiHole(settings["pihole_url"] if settings is not None else os.environ.get("PIHOLE_URL", ""), "PIHOLE", verify) try: - dns.login(secret("PIHOLE")) + dns.login(settings["pihole_password"] if settings is not None else secret("PIHOLE")) except (Error, OSError) as exc: LOG.error("Pi-hole login unavailable; continuing proxy maintenance: %s", exc) dns.close() diff --git a/homegate_ui.py b/homegate_ui.py index 679e723..ac4f562 100644 --- a/homegate_ui.py +++ b/homegate_ui.py @@ -31,26 +31,32 @@ class UIError(Exception): class Panel: - def __init__(self, config, control, origin, local=False, password_file=None, ssh_url=""): + def __init__(self, config, control, origin, local=False, password_file=None, ssh_url="", auth_required=True, connections_file=None): self.config = Path(config) self.control = Path(control) + self.connections_file = Path(connections_file) if connections_file else None self.origin = origin.rstrip("/") self.authority = urlsplit(self.origin).netloc parsed_origin = urlsplit(self.origin) - if (parsed_origin.scheme not in ("http", "https") or not self.authority + if not (self.connections_file and not self.origin) and (parsed_origin.scheme not in ("http", "https") or not self.authority or parsed_origin.path or parsed_origin.query or parsed_origin.fragment or parsed_origin.username): raise UIError("UI_ORIGIN must be the exact http(s)://host:port of the panel") self.local = local + self.auth_required = auth_required and not local self.password_file = password_file self.ssh_url = ssh_url self.sessions = {} self.attempts = defaultdict(list) self.mutex = threading.RLock() - if not local and (not password_file or len(Path(password_file).read_text().strip()) < 12): + if self.auth_required and (not password_file or len(Path(password_file).read_text().strip()) < 12): raise UIError("UI password must contain at least 12 characters; run setup.sh") - h.load_config(self.config) + if self.config.exists() or not self.connections_file: + h.load_config(self.config) def config_data(self): + if self.connections_file and not self.config.exists(): + return {"proxy_ip": "", "allowed_networks": [], "domain_zones": ["home", "home.arpa"], + "dns_mode": "pihole6", "interval_seconds": 60, "services": [], "ssh_hosts": []}, "" raw = self.config.read_bytes() value = yaml.safe_load(raw) h.validate_config(value) @@ -64,6 +70,8 @@ class Panel: return True if self.local: return False + if self.connections_file and not self.config.exists(): + return any(address.version == net.version and address in net for net in h.PRIVATE) c = h.load_config(self.config) return any(address.version == net.version and address in net for net in (ipaddress.ip_network(n) for n in c["allowed_networks"])) @@ -107,8 +115,52 @@ class Panel: snapshot = h.read_json(self.control / "status.json", {}) fresh = bool(snapshot) and time.time() - snapshot.get("time", 0) < snapshot.get("max_age", 180) history = h.read_json(self.control / "ui-history.json", []) + connections = h.read_json(self.connections_file, {}) if self.connections_file else None + public_connections = None if connections is None else { + **{key: connections.get(key, "") for key in ("npm_url", "npm_identity", "pihole_url", "ssh_public_url", "api_ca_pem")}, + **{key + "_set": bool(connections.get(key)) for key in ("npm_password", "pihole_password")}, + } return {"config": value, "revision": revision, "mode": "local" if self.local else "lan", - "ssh_url": self.ssh_url, "controller": {**snapshot, "fresh": fresh}, "history": history[:8]} + "setup_required": self.connections_file is not None and (not self.config.exists() or not self.connections_file.exists()), + "connections": public_connections, + "auth_required": self.auth_required, + "ssh_url": connections.get("ssh_public_url", "") if connections is not None else self.ssh_url, + "controller": {**snapshot, "fresh": fresh}, "history": history[:8]} + + def save_settings(self, config, connections, revision): + if self.connections_file is None: + raise UIError("Connections are managed by the existing deployment", 409) + h.validate_config(config) + h.require(isinstance(connections, dict), "Connections must be an object") + with self.mutex: + if self.config_data()[1] != revision: + raise UIError("Настройки уже изменились. Обновите страницу.", 409) + values = h.read_json(self.connections_file, {}) + allowed = {"npm_url", "npm_identity", "npm_password", "pihole_url", "pihole_password", "ssh_public_url", "api_ca_pem"} + h.require(not set(connections) - allowed, "Unknown connection field") + for key, value in connections.items(): + h.require(isinstance(value, str), f"{key} must be text") + if key.endswith("_password") and not value and values.get(key): + continue + values[key] = value if key.endswith("_password") else value.strip() + h.require(bool(values.get("npm_identity")), "Укажите логин Nginx Proxy Manager") + h.require(bool(values.get("npm_password")), "Укажите пароль Nginx Proxy Manager") + for key in ("npm_url", "pihole_url"): + if key == "pihole_url" and config["dns_mode"] == "manual" and not values.get(key): + continue + client = h.API(values.get(key, ""), key.removesuffix("_url").upper()) + client.close() + values.setdefault("pihole_password", "") + if values.get("ssh_public_url"): + url = urlsplit(values["ssh_public_url"]) + h.require(url.scheme in ("http", "https") and url.hostname and not url.username and not url.fragment, + "Укажите полный http(s) URL SSH-конфига") + if values.get("api_ca_pem"): + h.require(bool(h.x509.load_pem_x509_certificates(values["api_ca_pem"].encode())), "Некорректный PEM сертификата API") + h.save_json(self.connections_file, values) + result = self.save(config, revision) + self.request_sync() + return result def save(self, value, revision): h.validate_config(value) @@ -117,11 +169,13 @@ class Panel: lock_path = self.config.parent / ".ui-config.lock" with lock_path.open("a") as lock: fcntl.flock(lock, fcntl.LOCK_EX) - original = self.config.read_bytes() - if hashlib.sha256(original).hexdigest() != revision: + original = self.config.read_bytes() if self.config.exists() else None + current_revision = hashlib.sha256(original).hexdigest() if original is not None else "" + if current_revision != revision: raise UIError("Настройки уже изменились. Обновите страницу и повторите сохранение.", 409) backup = self.config.parent / "backups" / f"services-{time.time_ns()}.yaml" - h.atomic(backup, original) + if original is not None: + h.atomic(backup, original) # Preserve readability for the export container running under the same UID. h.atomic(self.config, data, 0o644) backups = sorted(backup.parent.glob("services-*.yaml")) @@ -167,24 +221,44 @@ def handler_for(panel): self.wfile.write(body) def dispatch(self): - if self.headers.get("Host", "") != panel.authority: + host = self.headers.get("Host", "") + if panel.authority and host != panel.authority: raise UIError("Unexpected Host", 403) + if not panel.authority: + parsed = urlsplit("http://" + host) + if not parsed.hostname or parsed.username or parsed.path or parsed.query or parsed.fragment: + raise UIError("Unexpected Host", 403) + try: + address = ipaddress.ip_address(parsed.hostname) + allowed_host = address.is_loopback or any(address.version == net.version and address in net for net in h.PRIVATE) + except ValueError: + zones = panel.config_data()[0].get("domain_zones", h.DEFAULT_ZONES) + allowed_host = parsed.hostname == "localhost" or any(parsed.hostname == zone or parsed.hostname.endswith("." + zone) for zone in zones) + if not allowed_host: + raise UIError("Open the panel using the server LAN IP or a configured local domain", 403) if not panel.allowed(self.client_address[0]): raise UIError("Доступ разрешён только из домашней сети", 403) path = urlsplit(self.path).path - if self.command == "GET" and path in ("/", "/app.js", "/style.css", "/favicon.svg"): - name = {"/": "index.html", "/app.js": "app.js", "/style.css": "style.css", "/favicon.svg": "favicon.svg"}[path] + if self.command == "GET" and path == "/healthz": + return self.respond(200, {"ok": True}) + if self.command == "GET" and path in ("/", "/app.js", "/settings.js", "/style.css", "/favicon.svg"): + name = {"/": "index.html", "/app.js": "app.js", "/settings.js": "settings.js", "/style.css": "style.css", "/favicon.svg": "favicon.svg"}[path] content_type = {"index.html": "text/html; charset=utf-8", "app.js": "text/javascript; charset=utf-8", - "style.css": "text/css; charset=utf-8", "favicon.svg": "image/svg+xml"}[name] + "settings.js": "text/javascript; charset=utf-8", "style.css": "text/css; charset=utf-8", "favicon.svg": "image/svg+xml"}[name] return self.respond(200, (BASE / "ui" / "dist" / name).read_bytes(), content_type) token, session = panel.session(self.headers.get("Cookie")) if self.command == "GET" and path == "/api/session": - if panel.local and session is None: + if not panel.auth_required and session is None: token, session = panel.new_session() return self.respond(200, {"authenticated": bool(session), "local": panel.local, "csrf": session["csrf"] if session else None}, cookie=token if session else None) if self.command == "POST": - if self.headers.get("Origin") != panel.origin: + origin = self.headers.get("Origin", "") + parsed = urlsplit(origin) + valid_origin = origin == panel.origin if panel.origin else ( + parsed.scheme in ("http", "https") and parsed.netloc == host + and not parsed.path and not parsed.query and not parsed.fragment and not parsed.username) + if not valid_origin: raise UIError("Invalid request origin", 403) if self.headers.get("Content-Type", "").split(";")[0] != "application/json": raise UIError("JSON required", 415) @@ -194,7 +268,7 @@ def handler_for(panel): body = json.loads(self.rfile.read(size)) if not isinstance(body, dict): raise UIError("JSON object required") - if path == "/api/login" and not panel.local: + if path == "/api/login" and panel.auth_required: token, session = panel.login(body.get("password"), self.client_address[0]) return self.respond(200, {"csrf": session["csrf"]}, cookie=token) if session is None: @@ -222,6 +296,8 @@ def handler_for(panel): raise UIError("Invalid session token", 403) if path == "/api/config": return self.respond(200, panel.save(body["config"], body["revision"])) + if path == "/api/settings": + return self.respond(200, panel.save_settings(body["config"], body["connections"], body["revision"])) if path == "/api/sync": return self.respond(202, panel.request_sync()) if path == "/api/logout": @@ -257,17 +333,21 @@ def main(): args = p.parse_args() if args.local and args.host != "127.0.0.1": raise UIError("Local no-login mode must bind to loopback") - if not args.local: + managed = os.environ.get("HOMEGATE_MANAGED_UI") == "1" + if not args.local and not managed: bind_ip = os.environ.get("UI_BIND_IP", "") h.private_address(bind_ip) h.require(ipaddress.ip_address(bind_ip).version == 4, "UI_BIND_IP must be a private IPv4 address") - origin = os.environ.get("UI_ORIGIN", f"http://{args.host}:{args.port}") + origin = os.environ.get("UI_ORIGIN", "" if managed else f"http://{args.host}:{args.port}") + auth_mode = os.environ.get("UI_AUTH_MODE", "password") + h.require(auth_mode in ("password", "none"), "UI_AUTH_MODE must be password or none") panel = Panel(os.environ.get("HOMEGATE_CONFIG", "/config/services.yaml"), os.environ.get("HOMEGATE_CONTROL", "/control"), origin, args.local, os.environ.get("UI_PASSWORD_FILE", "/run/secrets/ui_password"), - os.environ.get("SSH_PUBLIC_URL", "")) + os.environ.get("SSH_PUBLIC_URL", ""), auth_required=auth_mode != "none", + connections_file=os.environ.get("HOMEGATE_CONNECTIONS") if managed else None) with ThreadingHTTPServer((args.host, args.port), handler_for(panel)) as server: - print(f"Homegate Local: {origin}", flush=True) + print(f"Homegate UI: {origin or f'http://{args.host}:{args.port}'}", flush=True) server.serve_forever() diff --git a/standalone.py b/standalone.py new file mode 100644 index 0000000..7268c51 --- /dev/null +++ b/standalone.py @@ -0,0 +1,111 @@ +"""Run the controller, passwordless LAN panel and SSH export in one container.""" +import argparse +import os +from pathlib import Path +import signal +import subprocess +import sys +import threading +import time +import urllib.request + +import yaml +import homegate as h + +BASE = Path(__file__).resolve().parent + + +def runtime_environment(source): + env = dict(source) + defaults = { + "HOMEGATE_CONFIG": "/config/services.yaml", "HOMEGATE_STATE": "/data", + "HOMEGATE_CONTROL": "/control", "HOMEGATE_CONNECTIONS": "/config/connections.json", + "HOMEGATE_MANAGED_UI": "1", + "UI_AUTH_MODE": "none", "UI_LISTEN_HOST": "0.0.0.0", "UI_LISTEN_PORT": "8081", + "PYTHONDONTWRITEBYTECODE": "1", "PYTHONUNBUFFERED": "1", + } + for key, value in defaults.items(): + env.setdefault(key, value) + return env + + +def prepare(env): + for directory in (Path(env["HOMEGATE_CONFIG"]).parent, Path(env["HOMEGATE_STATE"]), Path(env["HOMEGATE_CONTROL"])): + directory.mkdir(parents=True, exist_ok=True) + + +def configured(env): + return all(Path(env[key]).is_file() for key in ("HOMEGATE_CONFIG", "HOMEGATE_CONNECTIONS")) + + +def supervise(commands, env, deferred=()): + stopped = threading.Event() + previous = {sig: signal.signal(sig, lambda *_: stopped.set()) + for sig in (signal.SIGTERM, signal.SIGINT)} + children = [] + try: + for command in commands: + if stopped.is_set(): + return 0 + children.append(subprocess.Popen(command, env=env)) + while not stopped.wait(0.25): + if deferred and configured(env): + for command in deferred: + children.append(subprocess.Popen(command, env=env)) + deferred = () + for child in children: + if child.poll() is not None: + print(f"Homegate process exited with status {child.returncode}; restarting the container", flush=True) + return 1 + return 0 + finally: + for child in children: + if child.poll() is None: + child.terminate() + deadline = time.monotonic() + 8 + for child in children: + try: + child.wait(timeout=max(0, deadline - time.monotonic())) + except subprocess.TimeoutExpired: + child.kill() + child.wait() + for sig, handler in previous.items(): + signal.signal(sig, handler) + + +def health(env): + opener = urllib.request.build_opener(urllib.request.ProxyHandler({})) + requests = ["http://127.0.0.1:8081/healthz"] + if configured(env): + requests.append("http://127.0.0.1:8080/healthz") + for request in requests: + with opener.open(request, timeout=3) as response: + response.read() + return 0 + + +def main(): + os.umask(0o077) + parser = argparse.ArgumentParser(description=__doc__) + parser.add_argument("command", nargs="?", default="all", + choices=("all", "once", "validate", "fingerprint", "rotate-ca", "ssh-config")) + parser.add_argument("--health", action="store_true") + args = parser.parse_args() + env = runtime_environment(os.environ) + if args.health: + return health(env) + prepare(env) + controller = [sys.executable, str(BASE / "homegate.py")] + if args.command != "all": + h.require(configured(env), "Complete the first-run setup in the web panel") + return subprocess.call(controller + [args.command], env=env) + return supervise([[sys.executable, str(BASE / "homegate_ui.py")]], env, + deferred=[controller + ["run"], controller + ["serve"]]) + + +if __name__ == "__main__": + try: + sys.exit(main()) + except (h.Error, OSError, ValueError, TypeError, KeyError, yaml.YAMLError) as exc: + print(f"Homegate: {exc}", file=sys.stderr) + sys.exit(1) diff --git a/tests/test_setup.py b/tests/test_setup.py new file mode 100644 index 0000000..644c9cf --- /dev/null +++ b/tests/test_setup.py @@ -0,0 +1,158 @@ +"""First-run UI, stored connections, live controller reload and process supervision.""" +import copy +import json +import os +from pathlib import Path +import subprocess +import sys +import tempfile +import unittest +from unittest.mock import patch + +import homegate as h +import homegate_ui as ui +import standalone +from test_ssh_and_zones import MemorySocket + + +class SetupTests(unittest.TestCase): + def setUp(self): + temp = tempfile.TemporaryDirectory() + self.addCleanup(temp.cleanup) + self.root = Path(temp.name) + self.config = self.root / 'config/services.yaml' + self.config.parent.mkdir() + self.connections = self.config.with_name('connections.json') + self.control = self.root / 'control' + self.panel = ui.Panel(self.config, self.control, '', auth_required=False, connections_file=self.connections) + self.cookie = '' + self.csrf = '' + self.settings = {'config': {'proxy_ip': '192.168.0.11', 'allowed_networks': ['192.168.0.0/24'], + 'domain_zones': ['home', 'home.arpa'], 'dns_mode': 'pihole6', 'interval_seconds': 60, + 'services': [], 'ssh_hosts': []}, 'connections': {'npm_url': 'http://192.168.0.11:81', + 'npm_identity': 'admin@example.com', 'npm_password': 'test-npm-secret', + 'pihole_url': 'http://192.168.0.2', 'pihole_password': 'test-pihole-secret'}, 'revision': ''} + + def request(self, path='/api/state', body=None, peer='192.168.0.20', headers=None): + method = 'GET' if body is None else 'POST' + payload = b'' if body is None else json.dumps(body).encode() + heads = {'Host': '192.168.0.10:8098', 'Cookie': self.cookie} + if body is not None: + heads.update({'Origin': 'http://192.168.0.10:8098', 'Content-Type': 'application/json', + 'Content-Length': str(len(payload)), 'X-Homegate-CSRF': self.csrf}) + heads.update(headers or {}) + raw = f'{method} {path} HTTP/1.1\r\n' + ''.join(f'{k}: {v}\r\n' for k, v in heads.items()) + '\r\n' + sock = MemorySocket(raw.encode() + payload) + ui.handler_for(self.panel)(sock, (peer, 5000), None) + head, data = sock.output.split(b'\r\n\r\n', 1) + response_headers = dict(line.decode().split(': ', 1) for line in head.split(b'\r\n')[1:]) + if 'application/json' in response_headers.get('Content-Type', ''): + data = json.loads(data) + return int(head.split()[1]), data, response_headers + + def connect(self): + code, body, headers = self.request('/api/session') + self.assertEqual(code, 200) + self.assertTrue(body['authenticated']) + self.cookie = headers['Set-Cookie'].split(';')[0] + self.csrf = body['csrf'] + + def install(self): + self.connect() + code, state, _ = self.request('/api/settings', self.settings) + self.assertEqual(code, 200, state) + self.assertFalse(state['setup_required']) + return state + + def test_blank_volume_opens_setup_without_password_or_env(self): + self.connect() + code, state, _ = self.request() + self.assertEqual(code, 200) + self.assertTrue(state['setup_required']) + self.assertFalse(state['auth_required']) + self.assertEqual(state['config']['services'], []) + self.assertEqual(self.request('/healthz')[0], 200) + self.assertEqual(self.request('/settings.js')[0], 200) + self.assertFalse(self.config.exists()) + + def test_setup_persists_and_keeps_secrets_out_of_state_and_exports(self): + state = self.install() + stored = h.read_json(self.connections) + self.assertEqual(stored['npm_password'], 'test-npm-secret') + self.assertEqual(self.connections.stat().st_mode & 0o777, 0o600) + self.assertTrue(state['connections']['npm_password_set']) + self.assertNotIn('test-npm-secret', json.dumps(state)) + self.assertNotIn(b'test-npm-secret', self.request('/downloads/services.yaml')[1]) + self.assertTrue((self.control / 'sync-request.json').exists()) + restarted = ui.Panel(self.config, self.control, '', auth_required=False, connections_file=self.connections) + self.assertFalse(restarted.status()['setup_required']) + self.assertEqual(restarted.status()['connections']['npm_url'], stored['npm_url']) + + def test_save_again_preserves_blank_passwords_and_changes_api_url(self): + state = self.install() + settings = copy.deepcopy(self.settings) + settings['revision'] = state['revision'] + settings['connections']['npm_url'] = 'http://192.168.0.12:81' + settings['connections']['npm_password'] = '' + code, _, _ = self.request('/api/settings', settings) + self.assertEqual(code, 200) + stored = h.read_json(self.connections) + self.assertEqual(stored['npm_password'], 'test-npm-secret') + self.assertEqual(stored['npm_url'], 'http://192.168.0.12:81') + + def test_invalid_settings_and_stale_revision_do_not_change_credentials(self): + state = self.install() + before = self.connections.read_bytes() + for field, value in [('npm_url', 'http://192.168.0.12/api'), ('api_ca_pem', 'not a certificate')]: + settings = copy.deepcopy(self.settings) + settings['revision'] = state['revision'] + settings['connections'][field] = value + self.assertEqual(self.request('/api/settings', settings)[0], 400) + self.assertEqual(self.connections.read_bytes(), before) + self.assertEqual(self.request('/api/settings', self.settings)[0], 409) + self.assertEqual(self.connections.read_bytes(), before) + + def test_acl_host_and_same_origin_work_without_fixed_origin(self): + self.connect() + self.assertEqual(self.request(peer='8.8.8.8')[0], 403) + for headers in ({'Host': 'attacker.example'}, {'Origin': 'http://attacker.example'}, {'X-Homegate-CSRF': ''}): + self.assertEqual(self.request('/api/settings', self.settings, headers=headers)[0], 403) + self.install() + self.assertEqual(self.request(peer='192.168.1.20')[0], 403) + self.assertEqual(self.request(headers={'Host': 'homegate.home'})[0], 200) + + def test_controller_reloads_connections_on_each_cycle(self): + self.install() + with patch.dict(os.environ, {'HOMEGATE_CONNECTIONS': str(self.connections)}, clear=True), patch.object(h, 'NPM') as npm, patch.object(h, 'PiHole') as dns, patch.object(h, 'reconcile'): + h.cycle(self.settings['config'], self.root, None, {}) + npm.assert_called_with('http://192.168.0.11:81', 'NPM', True) + npm.return_value.login.assert_called_with('admin@example.com', 'test-npm-secret') + dns.return_value.login.assert_called_with('test-pihole-secret') + settings = h.read_json(self.connections) + settings.update(npm_url='http://192.168.0.12:81', npm_password='changed') + h.save_json(self.connections, settings) + h.cycle(self.settings['config'], self.root, None, {}) + npm.assert_called_with('http://192.168.0.12:81', 'NPM', True) + npm.return_value.login.assert_called_with('admin@example.com', 'changed') + + +class StandaloneTests(unittest.TestCase): + def test_no_user_environment_required(self): + env = standalone.runtime_environment({}) + self.assertEqual(env['UI_AUTH_MODE'], 'none') + self.assertEqual(env['HOMEGATE_MANAGED_UI'], '1') + self.assertNotIn('HOMEGATE_LAN_IP', env) + self.assertNotIn('NPM_PASSWORD', env) + + def test_child_failure_stops_remaining_processes(self): + processes = [] + popen = subprocess.Popen + def start(*args, **kwargs): + process = popen(*args, **kwargs) + processes.append(process) + return process + with patch.object(standalone.subprocess, 'Popen', side_effect=start): + result = standalone.supervise([[sys.executable, '-c', 'raise SystemExit(3)'], + [sys.executable, '-c', 'import time; time.sleep(60)']], {}) + self.assertEqual(result, 1) + self.assertTrue(all(process.poll() is not None for process in processes)) diff --git a/ui/dist/app.js b/ui/dist/app.js index 1e6c4af..363820f 100644 --- a/ui/dist/app.js +++ b/ui/dist/app.js @@ -31,13 +31,14 @@ const services = () => data.config.services || []; const sshEntries = () => [...services().filter(r=>r.enabled!==false&&r.ssh&&r.ssh.enabled!==false).map(r=>({aliases:[...(r.ssh.alias?[r.ssh.alias]:[]),r.hostname].filter((x,i,a)=>a.indexOf(x)===i),host:r.ssh.host||new URL(r.upstream).hostname,port:r.ssh.port||22,user:r.ssh.user})),...(data.config.ssh_hosts||[]).filter(r=>r.enabled!==false)]; const controller = () => data.controller || {}; const isApplied = () => controller().fresh && controller().ok && controller().applied_revision===data.revision; -const sshUrl = () => data.ssh_url || `http://${data.config.proxy_ip}:8099/ssh-config`; +const sshUrl = () => data.ssh_url || `http://${location.hostname}:8099/ssh-config`; -async function api(path, body) { +async function api(path, body, retry=true) { const options = {credentials:'same-origin',headers:{}}; if(body!==undefined){options.method='POST';options.headers={'Content-Type':'application/json','X-Homegate-CSRF':csrf};options.body=JSON.stringify(body);} const r=await fetch(path,options); const value=(r.headers.get('content-type')||'').includes('application/json')?await r.json():await r.text(); + if(r.status===401 && retry && path!=='/api/session' && data?.auth_required===false){const session=await api('/api/session');csrf=session.csrf;return api(path,body,false);} if(!r.ok) {if(r.status===401&&path!=='/api/login')showLogin();throw new Error(value.error||`Ошибка ${r.status}`);} return value; } @@ -50,7 +51,7 @@ function nav(){ $('#navigation').innerHTML=pages.map(([id,label,i])=>`${icon(i,18)}${label}${id==='services'?`${services().length}`:''}`).join(''); $('#crumb').textContent=pages.find(p=>p[0]===tab)[1]; } -function statusStrip(){const c=controller();if(!c.fresh)return `
${icon('info',15)}Контроллер пока не подключён. Настройки сохраняются здесь. Для применения запустите Homegate в Docker.
`; +function statusStrip(){const c=controller();if(!c.fresh&&data.connections)return `
${icon('clock',15)}Контроллер запускается. Состояние подключений появится здесь автоматически.
`;if(!c.fresh)return `
${icon('info',15)}Контроллер пока не подключён. Настройки сохраняются здесь. Для применения запустите Homegate в Docker.
`; if(!c.ok)return `
${icon('info',15)}Не удалось применить настройки. ${esc(c.error||'Проверьте подключение к Pi-hole и NPM.')}
`; if(!isApplied())return `
${icon('clock',15)}Есть новые настройки. Контроллер применит их в следующем цикле.
`; return `
${icon('check',15)}Конфигурация применена в ${time(c.time)}. Доступность самих VM проверяется отдельно.
`; @@ -69,9 +70,9 @@ function renderServices(){const c=controller();const first=services().find(r=>r. function renderDomains(){const root=controller().root;return heading('Доменные зоны','Свои имена для разных частей вашей домашней сети.',``)+`
${zones().map((z,i)=>{const count=services().filter(r=>r.hostname===z||r.hostname.endsWith('.'+z)).length;const covered=root&&root.zones.some(p=>z===p||z.endsWith('.'+p));return `
${icon('globe',21)}
.${esc(z)}

${count} ${count===1?'сервис':'сервисов'} в этой зоне

${root?(covered?badge('Разрешена CA','success'):badge('Нужна смена CA')):badge('CA ещё не создан','muted')}DNS / TLS
`;}).join('')}
${icon('info',19)}

Домены работают внутри вашей сети.
Pi-hole направляет имена на NPM. Для домашних сетей подходит home.arpa; можно использовать и собственные зоны.

${root?`
${icon('shield',19)}

Новая зона может потребовать нового корневого сертификата.
Если зона вне ограничений текущего CA, выполните миграцию и установите новый корень на устройства.

`:''}`;} function renderSSH(){const entries=sshEntries();return heading('SSH-доступ','Один дополнительный конфиг для всех ваших компьютеров.',`${icon('download',14)} Скрипт для ПК${icon('download',14)} Скачать конфиг`)+`
~/.ssh/config.d/homegate.conf
Загружаем конфиг…
Подключите за пару минут
1
Скачайте скрипт на компьютер

Python 3.9+ и OpenSSH. Приватные ключи остаются у вас.

${icon('download',12)} sync_ssh.py
2
Подключите дополнительный файл

Основной SSH-конфиг сохраняется. Для Windows используйте py -3.

python3 sync_ssh.py ${esc(sshUrl())} --install
3
Подключайтесь по имени

При следующих обновлениях запустите скрипт без --install.

ssh ${esc(entries[0]?.aliases[0]||'имя-сервера')}
${icon('lock',18)}

Открытая выгрузка только для вашей LAN.
${esc(sshUrl())}
${data.mode==='local'?'Этот адрес заработает после запуска ssh-export в Docker. Сейчас конфиг можно скачать кнопкой выше.':'Доступ ограничен разрешёнными подсетями. Пароль панели для этой выгрузки не нужен.'}

Серверы без веб-интерфейса ${(data.config.ssh_hosts||[]).length}

${(data.config.ssh_hosts||[]).map((r,i)=>``).join('')||``}
ПсевдонимыАдресПользователь
${esc(r.aliases.join(', '))} ${r.enabled===false?badge('Выключен','muted'):''}${esc(r.host)}:${r.port||22}${esc(r.user||'Из личного конфига')}
${icon('server',25)}

Здесь можно добавить NAS, backup-сервер или любую машину с SSH.
SSH веб-сервисов настраивается в карточке сервиса.

`;} function renderCertificates(){const root=controller().root;const certs=controller().certificates||[];return heading('Сертификаты','Доверенный HTTPS для локальных адресов.',`${root?`${icon('download',14)} Скачать корневой CA`:''}`)+`
${icon('shield',29)}

Homegate Local Root CA

Ваш центр сертификации внутри домашней сети.

Состояние${root?badge('Создан','success'):badge('Ожидает запуска','muted')}
Действует до${date(root?.expires)}
Зоны в сертификате${esc(root?.zones.join(', ')||'Определятся при первом запуске')}
Срок сертификата сервиса90 дней
ПродлениеКогда осталось менее 30 дней
${root?`Отпечаток SHA-256
${esc(root.fingerprint)}
`:`
${icon('info',17)}

Корень создаётся контроллером. Сейчас панель не видит его данные.

`}
Установите доверие на устройства

Сертификат на сервере не добавляет доверие на компьютере или телефоне.

1
Скачайте только root-ca.crt

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

2
Импортируйте как доверенный корневой CA

Windows — доверенные корневые центры.
macOS — Связка ключей → System → Always Trust.
iOS — включите Full Trust после установки.

3
Откройте сервис по доменному имени

Например, https://${esc(services()[0]?.hostname||'service.home')}. Проверка сертификата по IP — другой запрос.

${icon('shield',17)}

Проверка TLS между NPM и самой VM настраивается отдельно для каждого сервиса.

Сертификаты сервисов

Данные контроллера
${certs.map(c=>``).join('')||''}
ДоменДействует до
${date(c.expires)}

После первого применения здесь появятся выданные сертификаты.

`;} -function renderSettings(){const c=data.config;return heading('Настройки сети','Адрес прокси, разрешённые подсети и частота обновления.')+`

Ваша локальная сеть

Доменные имена сервисов будут указывать на адрес NPM.

Локальный DNS

Выберите, кто создаёт записи для сервисов.

Подключения

Пароли остаются в Docker secrets на сервере.

${icon('globe',19)}
Pi-hole${c.dns_mode==='manual'?'Ручное управление DNS':'DNS-записи через API'}
${badge(controller().fresh&&controller().ok?'Синхронизирован':'Нет данных',controller().fresh&&controller().ok?'success':'muted')}
${icon('route',19)}
Nginx Proxy ManagerПрокси и HTTPS
${badge(controller().fresh&&controller().ok?'Синхронизирован':'Нет данных',controller().fresh&&controller().ok?'success':'muted')}

Адреса API и учётные данные задаются в .env и secrets/ при установке.

Последние изменения
${data.history.length?data.history.map(item=>`
${icon('check',13)}

${esc(item.text)}

`).join(''):'

Здесь появятся сохранения из панели.

'}
${icon('download',14)} Скачать текущий YAML
`;} +function renderSettings(){if(data.connections)return renderManagedSettings();const c=data.config;return heading('Настройки сети','Адрес прокси, разрешённые подсети и частота обновления.')+`

Ваша локальная сеть

Доменные имена сервисов будут указывать на адрес NPM.

Локальный DNS

Выберите, кто создаёт записи для сервисов.

Подключения

Пароли остаются в Docker secrets на сервере.

${icon('globe',19)}
Pi-hole${c.dns_mode==='manual'?'Ручное управление DNS':'DNS-записи через API'}
${badge(controller().fresh&&controller().ok?'Синхронизирован':'Нет данных',controller().fresh&&controller().ok?'success':'muted')}
${icon('route',19)}
Nginx Proxy ManagerПрокси и HTTPS
${badge(controller().fresh&&controller().ok?'Синхронизирован':'Нет данных',controller().fresh&&controller().ok?'success':'muted')}

Адреса API и учётные данные задаются в .env и secrets/ при установке.

Последние изменения
${data.history.length?data.history.map(item=>`
${icon('check',13)}

${esc(item.text)}

`).join(''):'

Здесь появятся сохранения из панели.

'}
${icon('download',14)} Скачать текущий YAML
`;} -function render(){if(!data)return;tab=pages.some(p=>p[0]===location.hash.slice(1))?location.hash.slice(1):'services';nav();$('#content').innerHTML=({services:renderServices,domains:renderDomains,ssh:renderSSH,certificates:renderCertificates,settings:renderSettings})[tab]();$('#yaml-download').innerHTML=icon('download',16);$('#logout').hidden=data.mode==='local';$('#service-search')?.addEventListener('input',e=>{search=e.target.value;$('#service-rows').innerHTML=serviceRows();});if(tab==='ssh')api('/api/ssh-config').then(text=>{if($('#ssh-preview'))$('#ssh-preview').textContent=text;}).catch(e=>toast(e.message,true));if(tab==='settings'){const form=$('#settings-form');form.addEventListener('input',()=>settingsDirty=true);form.addEventListener('submit',saveSettings);}} +function render(){if(!data)return;tab=pages.some(p=>p[0]===location.hash.slice(1))?location.hash.slice(1):'services';if(data.setup_required)tab='settings';nav();$('#content').innerHTML=({services:renderServices,domains:renderDomains,ssh:renderSSH,certificates:renderCertificates,settings:renderSettings})[tab]();$('#yaml-download').innerHTML=icon('download',16);$('#logout').hidden=data.auth_required===false;$('#yaml-download').hidden=data.setup_required;$('#service-search')?.addEventListener('input',e=>{search=e.target.value;$('#service-rows').innerHTML=serviceRows();});if(tab==='ssh')api('/api/ssh-config').then(text=>{if($('#ssh-preview'))$('#ssh-preview').textContent=text;}).catch(e=>toast(e.message,true));if(tab==='settings'){const form=$('#settings-form');form.addEventListener('input',()=>settingsDirty=true);form.addEventListener('submit',data.connections?saveManagedSettings:saveSettings);if(data.connections)bindManagedSettings(form);}} async function refresh(){data=await api('/api/state');render();} async function saveConfig(config){if(busy)throw new Error('Подождите завершения сохранения');busy=true;try{data=await api('/api/config',{config,revision:data.revision});settingsDirty=false;render();toast(controller().fresh?'Настройки сохранены. Контроллер применит их в следующем цикле.':'Настройки сохранены локально. Для применения подключите контроллер.');}finally{busy=false;}} @@ -85,7 +86,7 @@ async function modalSave(config){try{await saveConfig(config);$('#modal').close( function zoneModal(){showModal('Новая доменная зона','Все сервисы этой зоны будут доступны через локальный DNS.',``,modalFooter('Добавить зону'));$('#modal-form').addEventListener('submit',async e=>{e.preventDefault();const z=new FormData(e.target).get('zone').trim().toLowerCase().replace(/^\.+|\.+$/g,'');const c=clone(data.config);c.domain_zones=[...zones(),z];await modalSave(c);});} function sshModal(index=-1){const r=index<0?{}:data.config.ssh_hosts[index];showModal(index<0?'Новый SSH-хост':'Настройки SSH-хоста','Прямое подключение к машине без создания веб-прокси.',``,modalFooter());$('#modal-form').addEventListener('submit',async e=>{e.preventDefault();const f=new FormData(e.target);const item={aliases:f.get('aliases').split(',').map(x=>x.trim().toLowerCase()).filter(Boolean),host:f.get('host').trim(),port:Number(f.get('port')),enabled:f.has('enabled')};if(f.get('user').trim())item.user=f.get('user').trim();const c=clone(data.config);c.ssh_hosts||=[];if(index<0)c.ssh_hosts.push(item);else c.ssh_hosts[index]=item;await modalSave(c);});} function confirmModal(title,text,action){showModal(title,'',``,``);$('#confirm-action').addEventListener('click',action);} -function guide(ca=false){const command=ca?'docker compose stop homegate\ndocker compose run --rm homegate rotate-ca\n# Установите новый state/root-ca.crt на устройства\ndocker compose up -d homegate':'sh setup.sh\n# Укажите адреса и пароли в .env / secrets\ndocker compose up -d --build';showModal(ca?'Смена корневого сертификата':'Подключите Homegate к вашей сети',ca?'Выполните на Docker-хосте после добавления новых зон.':'Панель готовит конфигурацию. Контроллер применяет её к Pi-hole и NPM.',``,``);$('#copy-guide').addEventListener('click',()=>copy(command));} +function guide(ca=false){if(!ca&&data.connections){location.hash='settings';return;}const command=ca?'docker compose stop homegate\ndocker compose run --rm homegate rotate-ca\n# Установите новый state/root-ca.crt на устройства\ndocker compose up -d homegate':'sh setup.sh\n# Укажите адреса и пароли в .env / secrets\ndocker compose up -d --build';showModal(ca?'Смена корневого сертификата':'Подключите Homegate к вашей сети',ca?'Выполните на Docker-хосте после добавления новых зон.':'Панель готовит конфигурацию. Контроллер применяет её к Pi-hole и NPM.',``,``);$('#copy-guide').addEventListener('click',()=>copy(command));} async function saveSettings(e){e.preventDefault();const f=new FormData(e.target);const c=clone(data.config);c.proxy_ip=f.get('proxy_ip').trim();c.allowed_networks=f.get('allowed_networks').split(/\n|,/).map(x=>x.trim()).filter(Boolean);c.dns_mode=f.get('dns_mode');c.interval_seconds=Number(f.get('interval_seconds'));try{await saveConfig(c);}catch(err){$('#settings-error').hidden=false;$('#settings-error').textContent=friendlyError(err);}} document.addEventListener('click',async e=>{const button=e.target.closest('[data-action]');if(!button)return;const i=Number(button.dataset.index);const a=button.dataset.action;try{ diff --git a/ui/dist/index.html b/ui/dist/index.html index 4f53086..6d4c1f7 100644 --- a/ui/dist/index.html +++ b/ui/dist/index.html @@ -8,6 +8,7 @@ + diff --git a/ui/dist/settings.js b/ui/dist/settings.js new file mode 100644 index 0000000..c199c49 --- /dev/null +++ b/ui/dist/settings.js @@ -0,0 +1,70 @@ +function renderManagedSettings() { + const c = data.config, links = data.connections, first = data.setup_required; + const passwordField = (name, title) => ``; + return heading(first ? 'Подключим вашу домашнюю сеть' : 'Настройки и подключения', + first ? 'Заполните адреса здесь — Homegate сохранит настройки и начнёт работать.' : 'Все параметры сохраняются здесь и применяются автоматически.') + ` +
+

Ваша сеть

Сервисы будут открываться через Nginx Proxy Manager.

+
+ + + + +
+
+

Nginx Proxy Manager

Homegate создаёт прокси и загружает сертификаты через API.

+
+ + + ${passwordField('npm_password', 'Пароль NPM')} +
+
+

DNS

+ +
+ + ${passwordField('pihole_password', 'Пароль Pi-hole')} +
+
+
Дополнительные настройки
+ + +
+ +
${first ? 'Всё настраивается здесь' : 'Подключения'}
+

Адреса, домены и доступ к вашим сервисам сохраняются на сервере. После перезапуска ничего вводить заново не нужно.

+
${icon('route',19)}
Nginx Proxy ManagerПрокси и HTTPS для ваших VM
+
${icon('globe',19)}
Pi-holeЛокальные DNS-записи
+

Пароли в форме — от уже работающих NPM и Pi-hole. Панель Homegate открывается без логина.

+
${!first ? statusStrip() : ''}
`; +} + +function bindManagedSettings(form) { + form.elements.dns_mode.addEventListener('change', () => { + const manual = form.elements.dns_mode.value === 'manual'; + document.querySelector('#pihole-fields').hidden = manual; + form.elements.pihole_url.required = !manual; + }); +} + +async function saveManagedSettings(event) { + event.preventDefault(); + const form = event.target, fields = new FormData(form), config = clone(data.config); + const list = name => fields.get(name).split(/\n|,/).map(value => value.trim()).filter(Boolean); + Object.assign(config, {proxy_ip: fields.get('proxy_ip').trim(), allowed_networks: list('allowed_networks'), + domain_zones: list('domain_zones'), dns_mode: fields.get('dns_mode'), interval_seconds: Number(fields.get('interval_seconds'))}); + const connections = Object.fromEntries(['npm_url','npm_identity','npm_password','pihole_url','pihole_password','ssh_public_url','api_ca_pem'].map(key => [key, fields.get(key)])); + const first = data.setup_required, button = form.querySelector('[type=submit]'); + button.disabled = true; + try { + data = await api('/api/settings', {config, connections, revision: data.revision}); + settingsDirty = false; + if(first) location.hash = 'services'; + render(); + toast(first ? 'Готово. Добавьте первый сервис.' : 'Настройки сохранены. Подключения обновляются.'); + } catch(error) { + document.querySelector('#settings-error').hidden = false; + document.querySelector('#settings-error').textContent = friendlyError(error); + button.disabled = false; + } +}