Files
web-proxy-config/README.md
T

97 lines
4.0 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
```
## Доступ к веб-интерфейсу
Приложение должно слушать только локальный адрес:
```text
127.0.0.1
```
Доступ к нему рекомендуется организовать через Caddy с ограничением только для локальной сети.
Блок Caddy, который проксирует веб-интерфейс NAS Config Web, должен находиться **вне управляемых маркеров**,
чтобы приложение никогда не изменяло собственную точку доступа.