Files
web-proxy-config/README.md
T

267 lines
7.5 KiB
Markdown

# NAS Config Web
Небольшой локальный веб-интерфейс на Flask/Gunicorn для управления только участками между
`#begin marker` и `#end marker` в файлах Caddyfile и dnsmasq.conf.
Поиск маркеров не зависит от регистра, поэтому вариант `#Begin marker` также поддерживается.
## Важное правило безопасности
Приложению разрешено изменять текст **только между двумя маркерами**.
При каждой записи приложение:
1. требует наличия ровно одного начального маркера и ровно одного конечного маркера;
2. оставляет без изменений весь текст до начального маркера включительно;
3. оставляет без изменений строку с конечным маркером и весь текст после неё;
4. непосредственно перед записью выполняет дополнительную проверку и отменяет операцию,
если какая-либо часть файла вне маркеров отличается от исходной;
5. создаёт резервную копию файла с отметкой времени;
6. атомарно заменяет конфигурационный файл;
7. проверяет полную конфигурацию;
8. перезагружает или перезапускает соответствующий сервис;
9. восстанавливает исходный конфигурационный файл, если проверка или запуск сервиса завершились ошибкой.
Перегенерируется только управляемая часть между маркерами.
Существующие окончания строк CRLF/LF вне управляемой части сохраняются без изменений,
так как чтение и запись выполняются с отключённым преобразованием окончаний строк.
## dnsmasq
В веб-форме требуется указать только домен.
Все новые записи используют один общий IP-адрес, который задаётся в файле:
`/etc/nas-config-web.env`
Например:
```ini
DNSMASQ_TARGET_IP=192.168.7.251
```
Если в форме указать:
```text
.arm.com
```
будет создана запись:
```text
address=/.arm.com/192.168.7.251
```
Существующие записи с другим IP-адресом также отображаются в интерфейсе и могут быть удалены,
но все новые записи всегда используют значение `DNSMASQ_TARGET_IP`.
## Проверка и применение конфигурации
Для Caddy выполняется:
```bash
caddy validate
```
После успешной проверки:
```bash
systemctl reload caddy
```
Для dnsmasq выполняется:
```bash
dnsmasq --test
```
После успешной проверки:
```bash
systemctl restart dnsmasq
```
## Установка
### 1. Установка системных пакетов
На Debian 13 установите необходимые пакеты:
```bash
sudo apt update
sudo apt install -y python3-venv unzip
```
### 2. Размещение приложения
Распакуйте архив приложения и разместите его в `/opt/nas-config-web`.
Например:
```bash
sudo mkdir -p /opt/nas-config-web
sudo unzip nas-config-web.zip -d /opt/
```
После распаковки в каталоге `/opt/nas-config-web` должны находиться как минимум:
```text
app.py
requirements.txt
nas-config-web.service
nas-config-web.env.example
README.md
```
### 3. Создание Python-окружения
Создайте виртуальное окружение:
```bash
sudo python3 -m venv /opt/nas-config-web/venv
```
Установите зависимости:
```bash
sudo /opt/nas-config-web/venv/bin/pip install \
-r /opt/nas-config-web/requirements.txt
```
### 4. Настройка приложения
Скопируйте пример файла настроек:
```bash
sudo cp /opt/nas-config-web/nas-config-web.env.example \
/etc/nas-config-web.env
```
Откройте его для редактирования:
```bash
sudo nano /etc/nas-config-web.env
```
Пример настроек:
```ini
ADMIN_USER=admin
ADMIN_PASSWORD=замените_на_надёжный_пароль
APP_SECRET=замените_на_случайную_строку
CADDYFILE=/etc/caddy/Caddyfile
DNSMASQ_CONF=/etc/dnsmasq.conf
DNSMASQ_TARGET_IP=192.168.7.251
BACKUP_DIR=/var/backups/nas-config-web
LAN_NETWORKS=192.168.7.0/24,10.10.10.0/24
MAX_BACKUPS=50
```
Случайную строку для `APP_SECRET` можно создать командой:
```bash
openssl rand -hex 32
```
Ограничьте доступ к файлу настроек:
```bash
sudo chmod 600 /etc/nas-config-web.env
```
### 5. Установка службы systemd
Скопируйте unit-файл:
```bash
sudo cp /opt/nas-config-web/nas-config-web.service \
/etc/systemd/system/nas-config-web.service
```
Перечитайте конфигурацию systemd:
```bash
sudo systemctl daemon-reload
```
Включите автозапуск и сразу запустите приложение:
```bash
sudo systemctl enable --now nas-config-web
```
Проверьте состояние:
```bash
sudo systemctl status nas-config-web
```
При нормальной работе статус должен содержать:
```text
Active: active (running)
```
### 6. Просмотр журналов
Для просмотра последних сообщений:
```bash
sudo journalctl -u nas-config-web -n 100 --no-pager
```
Для просмотра журнала в реальном времени:
```bash
sudo journalctl -u nas-config-web -f
```
### 7. Локальная проверка
По умолчанию приложение должно быть доступно только на:
```text
127.0.0.1:8090
```
Проверить его с самого мини-ПК можно командой:
```bash
curl http://127.0.0.1:8090
```
Если приложение отвечает, можно настраивать доступ к нему через Caddy.
## Доступ к веб-интерфейсу
Приложение должно слушать только локальный адрес:
```text
127.0.0.1
```
Доступ к нему рекомендуется организовать через Caddy с ограничением только для локальной сети.
Блок Caddy, который проксирует веб-интерфейс NAS Config Web, должен находиться **вне управляемых маркеров**,
чтобы приложение никогда не изменяло собственную точку доступа.
### Пример
```text
proxy.stadidisk.ru {
@lan remote_ip 192.168.7.0/24 10.10.10.0/24
handle @lan {
reverse_proxy 127.0.0.1:8090
}
respond "Forbidden" 403
}
```