Files
web-proxy-config/README.md
T

296 lines
8.3 KiB
Markdown

# Proxy Config
Небольшой локальный веб-интерфейс на Flask/Gunicorn для управления Caddy и dnsmasq.
Приложение изменяет только участки между маркерами `#begin marker` и `#end marker` в `Caddyfile` и `dnsmasq.conf`. Содержимое файлов вне этих маркеров не изменяется.
## Возможности
- добавление и удаление reverse proxy в Caddy;
- создание обычных и LAN-only proxy-блоков;
- добавление и удаление доменов dnsmasq;
- единый IP для всех новых dnsmasq-записей через `DNSMASQ_TARGET_IP`;
- импорт списка доменов dnsmasq из текстового файла;
- экспорт списка доменов dnsmasq в текстовый файл;
- опциональная HTTP Basic Auth;
- проверка конфигурации перед применением;
- автоматический reload/restart сервиса;
- резервная копия перед изменением;
- автоматический откат при ошибке проверки или применения.
## Защита файлов вне маркеров
Для каждого конфигурационного файла должна существовать ровно одна пара маркеров:
```text
#begin marker
... управляемая часть ...
#end marker
```
Регистр маркеров не важен, поэтому `#Begin marker` также поддерживается.
При изменении приложение:
1. требует ровно один начальный и один конечный маркер;
2. сохраняет строку начального маркера и весь текст до неё без изменений;
3. сохраняет строку конечного маркера и весь текст после неё без изменений;
4. перед записью дополнительно сравнивает обе внешние части с исходным файлом;
5. отменяет запись, если что-либо вне маркеров изменилось;
6. создаёт резервную копию;
7. атомарно записывает конфигурацию;
8. проверяет конфигурацию;
9. применяет её только после успешной проверки;
10. при ошибке восстанавливает исходный файл.
CRLF/LF вне управляемой части также сохраняются без пересборки.
## dnsmasq
Все новые записи используют один IP из `/etc/web-proxy-config.env`:
```ini
DNSMASQ_TARGET_IP=192.168.7.251
```
В интерфейсе достаточно указать только домен, например:
```text
.arm.com
```
Будет создана запись:
```text
address=/.arm.com/192.168.7.251
```
Существующие записи с другим IP отображаются как есть. Они не переписываются автоматически.
### Импорт доменов
Для импорта используется текстовый UTF-8 файл, по одному домену на строку:
```text
ifconfig.me
.keil.arm.com
.arm.com
```
Пустые строки и строки, начинающиеся с `#`, игнорируются.
Импорт:
- принимает только доменные имена;
- не позволяет импортировать произвольные строки `dnsmasq.conf`;
- использует `DNSMASQ_TARGET_IP` для всех новых записей;
- пропускает домены, которые уже существуют;
- перед применением выполняет обычную проверку `dnsmasq --test`.
### Экспорт доменов
Кнопка экспорта создаёт файл `dnsmasq-sites.txt` в формате:
```text
ifconfig.me
.keil.arm.com
.arm.com
```
Экспортируется только список доменов из управляемой части, без IP-адресов.
## Авторизация
Авторизация управляется параметром:
```ini
AUTH_ENABLED=true
```
При включённой авторизации используются:
```ini
ADMIN_USER=admin
ADMIN_PASSWORD=CHANGE_ME_TO_A_LONG_RANDOM_PASSWORD
```
Если доступ к Proxy Config уже ограничен доверенной локальной сетью через Caddy, авторизацию можно отключить:
```ini
AUTH_ENABLED=false
```
При `AUTH_ENABLED=false` значения `ADMIN_USER` и `ADMIN_PASSWORD` не используются.
> Proxy Config может изменять Caddy и dnsmasq и перезапускать системные сервисы. Отключайте авторизацию только если доступ к `proxy.stadidisk.ru` действительно ограничен доверенными устройствами/сетями.
## Проверка и применение конфигурации
Для Caddy:
```bash
caddy validate --config /etc/caddy/Caddyfile --adapter caddyfile
systemctl reload caddy
```
Для dnsmasq:
```bash
dnsmasq --test --conf-file=/etc/dnsmasq.conf
systemctl restart dnsmasq
```
## Установка и обновление
### 1. Установка системных пакетов
На Debian 13:
```bash
sudo apt update
sudo apt install -y git python3-venv
```
### 2. Обновление кода
Перейдите в каталог проекта:
```bash
cd /opt/web-proxy-config
```
Получите последнюю версию:
```bash
git pull
```
### 3. Создание виртуального окружения
Из каталога проекта:
```bash
python3 -m venv .venv
```
Активируйте окружение:
```bash
source .venv/bin/activate
```
### 4. Установка зависимостей из venv
После активации `.venv`:
```bash
pip install -r requirements.txt
```
После установки можно выйти из окружения:
```bash
deactivate
```
### 5. Настройка приложения
Скопируйте пример настроек:
```bash
sudo cp web-proxy-config.env.example /etc/web-proxy-config.env
```
Откройте файл:
```bash
sudo nano /etc/web-proxy-config.env
```
Пример:
```ini
AUTH_ENABLED=true
ADMIN_USER=admin
ADMIN_PASSWORD=замените_на_надёжный_пароль
APP_SECRET=замените_на_случайную_строку
CADDYFILE=/etc/caddy/Caddyfile
DNSMASQ_CONF=/etc/dnsmasq.conf
BACKUP_DIR=/var/backups/web-proxy-config
DNSMASQ_TARGET_IP=192.168.7.251
LAN_NETWORKS=192.168.7.0/24,10.10.10.0/24
MAX_BACKUPS=50
MAX_IMPORT_BYTES=262144
```
Случайный `APP_SECRET`:
```bash
openssl rand -hex 32
```
Ограничьте доступ к настройкам:
```bash
sudo chmod 600 /etc/web-proxy-config.env
```
### 6. Установка systemd-службы
```bash
sudo cp web-proxy-config.service /etc/systemd/system/web-proxy-config.service
sudo systemctl daemon-reload
sudo systemctl enable --now web-proxy-config
```
После обновления кода достаточно:
```bash
cd /opt/web-proxy-config
git pull
source .venv/bin/activate
pip install -r requirements.txt
deactivate
sudo systemctl restart web-proxy-config
```
Проверка состояния:
```bash
systemctl status web-proxy-config
```
Логи:
```bash
journalctl -u web-proxy-config -f
```
## Доступ через Caddy
Приложение слушает только:
```text
127.0.0.1:8090
```
Пример LAN-only блока Caddy:
```caddyfile
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
}
```
Этот блок рекомендуется размещать **вне управляемых маркеров**, чтобы Proxy Config никогда не изменял собственную точку входа.