добавлен импорт\экспорт сайтов для dnsmasq и функция отключения авторизации
This commit is contained in:
@@ -1,100 +1,159 @@
|
||||
# web-proxy-config
|
||||
# Proxy Config
|
||||
|
||||
Небольшой локальный веб-интерфейс на Flask/Gunicorn для управления только участками между
|
||||
`#begin marker` и `#end marker` в файлах Caddyfile и dnsmasq.conf.
|
||||
Небольшой локальный веб-интерфейс на Flask/Gunicorn для управления Caddy и dnsmasq.
|
||||
|
||||
Поиск маркеров не зависит от регистра, поэтому вариант `#Begin marker` также поддерживается.
|
||||
Приложение изменяет только участки между маркерами `#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 сервиса;
|
||||
- резервная копия перед изменением;
|
||||
- автоматический откат при ошибке проверки или применения.
|
||||
|
||||
При каждой записи приложение:
|
||||
## Защита файлов вне маркеров
|
||||
|
||||
1. требует наличия ровно одного начального маркера и ровно одного конечного маркера;
|
||||
2. оставляет без изменений весь текст до начального маркера включительно;
|
||||
3. оставляет без изменений строку с конечным маркером и весь текст после неё;
|
||||
4. непосредственно перед записью выполняет дополнительную проверку и отменяет операцию,
|
||||
если какая-либо часть файла вне маркеров отличается от исходной;
|
||||
5. создаёт резервную копию файла с отметкой времени;
|
||||
6. атомарно заменяет конфигурационный файл;
|
||||
7. проверяет полную конфигурацию;
|
||||
8. перезагружает или перезапускает соответствующий сервис;
|
||||
9. восстанавливает исходный конфигурационный файл, если проверка или запуск сервиса завершились ошибкой.
|
||||
Для каждого конфигурационного файла должна существовать ровно одна пара маркеров:
|
||||
|
||||
Перегенерируется только управляемая часть между маркерами.
|
||||
```text
|
||||
#begin marker
|
||||
|
||||
Существующие окончания строк CRLF/LF вне управляемой части сохраняются без изменений,
|
||||
так как чтение и запись выполняются с отключённым преобразованием окончаний строк.
|
||||
... управляемая часть ...
|
||||
|
||||
#end marker
|
||||
```
|
||||
|
||||
Регистр маркеров не важен, поэтому `#Begin marker` также поддерживается.
|
||||
|
||||
При изменении приложение:
|
||||
|
||||
1. требует ровно один начальный и один конечный маркер;
|
||||
2. сохраняет строку начального маркера и весь текст до неё без изменений;
|
||||
3. сохраняет строку конечного маркера и весь текст после неё без изменений;
|
||||
4. перед записью дополнительно сравнивает обе внешние части с исходным файлом;
|
||||
5. отменяет запись, если что-либо вне маркеров изменилось;
|
||||
6. создаёт резервную копию;
|
||||
7. атомарно записывает конфигурацию;
|
||||
8. проверяет конфигурацию;
|
||||
9. применяет её только после успешной проверки;
|
||||
10. при ошибке восстанавливает исходный файл.
|
||||
|
||||
CRLF/LF вне управляемой части также сохраняются без пересборки.
|
||||
|
||||
## dnsmasq
|
||||
|
||||
В веб-форме требуется указать только домен.
|
||||
|
||||
Все новые записи используют один общий IP-адрес, который задаётся в файле:
|
||||
|
||||
`/etc/web-proxy-config.env`
|
||||
|
||||
Например:
|
||||
Все новые записи используют один 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-адресом также отображаются в интерфейсе и могут быть удалены,
|
||||
но все новые записи всегда используют значение `DNSMASQ_TARGET_IP`.
|
||||
Существующие записи с другим 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
|
||||
```
|
||||
|
||||
После успешной проверки:
|
||||
Для Caddy:
|
||||
|
||||
```bash
|
||||
caddy validate --config /etc/caddy/Caddyfile --adapter caddyfile
|
||||
systemctl reload caddy
|
||||
```
|
||||
|
||||
Для dnsmasq выполняется:
|
||||
|
||||
```bash
|
||||
dnsmasq --test
|
||||
```
|
||||
|
||||
После успешной проверки:
|
||||
Для dnsmasq:
|
||||
|
||||
```bash
|
||||
dnsmasq --test --conf-file=/etc/dnsmasq.conf
|
||||
systemctl restart dnsmasq
|
||||
```
|
||||
|
||||
|
||||
## Установка
|
||||
## Установка и обновление
|
||||
|
||||
### 1. Установка системных пакетов
|
||||
|
||||
На Debian 13 установите необходимые пакеты:
|
||||
На Debian 13:
|
||||
|
||||
```bash
|
||||
sudo apt update
|
||||
sudo apt install -y git python3-venv
|
||||
```
|
||||
|
||||
### 2. Обновление кода из Git
|
||||
### 2. Обновление кода
|
||||
|
||||
Перейдите в каталог проекта:
|
||||
|
||||
@@ -102,7 +161,7 @@ sudo apt install -y git python3-venv
|
||||
cd /opt/web-proxy-config
|
||||
```
|
||||
|
||||
Получите последние изменения из Git-репозитория:
|
||||
Получите последнюю версию:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
@@ -110,33 +169,27 @@ git pull
|
||||
|
||||
### 3. Создание виртуального окружения
|
||||
|
||||
Находясь в каталоге проекта, создайте виртуальное окружение `.venv`:
|
||||
Из каталога проекта:
|
||||
|
||||
```bash
|
||||
python3 -m venv .venv
|
||||
```
|
||||
|
||||
Активируйте его:
|
||||
Активируйте окружение:
|
||||
|
||||
```bash
|
||||
source .venv/bin/activate
|
||||
```
|
||||
|
||||
После активации в начале командной строки обычно появится:
|
||||
### 4. Установка зависимостей из venv
|
||||
|
||||
```text
|
||||
(.venv)
|
||||
```
|
||||
|
||||
### 4. Установка зависимостей
|
||||
|
||||
Находясь в активированном виртуальном окружении, установите зависимости:
|
||||
После активации `.venv`:
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
При необходимости после установки можно выйти из виртуального окружения:
|
||||
После установки можно выйти из окружения:
|
||||
|
||||
```bash
|
||||
deactivate
|
||||
@@ -144,129 +197,90 @@ 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
|
||||
|
||||
BACKUP_DIR=/var/backups/web-proxy-config
|
||||
LAN_NETWORKS=192.168.7.0/24,10.10.10.0/24
|
||||
MAX_BACKUPS=50
|
||||
MAX_IMPORT_BYTES=262144
|
||||
```
|
||||
|
||||
Случайную строку для `APP_SECRET` можно создать командой:
|
||||
Случайный `APP_SECRET`:
|
||||
|
||||
```bash
|
||||
openssl rand -hex 32
|
||||
```
|
||||
|
||||
Ограничьте доступ к файлу настроек:
|
||||
Ограничьте доступ к настройкам:
|
||||
|
||||
```bash
|
||||
sudo chmod 600 /etc/web-proxy-config.env
|
||||
```
|
||||
|
||||
### 6. Установка службы systemd
|
||||
|
||||
Находясь в каталоге проекта, скопируйте unit-файл:
|
||||
### 6. Установка systemd-службы
|
||||
|
||||
```bash
|
||||
sudo cp web-proxy-config.service /etc/systemd/system/web-proxy-config.service
|
||||
```
|
||||
|
||||
Перечитайте конфигурацию systemd:
|
||||
|
||||
```bash
|
||||
sudo systemctl daemon-reload
|
||||
```
|
||||
|
||||
Включите автозапуск и сразу запустите приложение:
|
||||
|
||||
```bash
|
||||
sudo systemctl enable --now web-proxy-config
|
||||
```
|
||||
|
||||
Проверьте состояние:
|
||||
После обновления кода достаточно:
|
||||
|
||||
```bash
|
||||
sudo systemctl status web-proxy-config
|
||||
cd /opt/web-proxy-config
|
||||
git pull
|
||||
source .venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
deactivate
|
||||
sudo systemctl restart web-proxy-config
|
||||
```
|
||||
|
||||
При нормальной работе статус должен содержать:
|
||||
|
||||
```text
|
||||
Active: active (running)
|
||||
```
|
||||
|
||||
### 7. Просмотр журналов
|
||||
|
||||
Для просмотра последних сообщений:
|
||||
Проверка состояния:
|
||||
|
||||
```bash
|
||||
sudo journalctl -u web-proxy-config -n 100 --no-pager
|
||||
systemctl status web-proxy-config
|
||||
```
|
||||
|
||||
Для просмотра журнала в реальном времени:
|
||||
Логи:
|
||||
|
||||
```bash
|
||||
sudo journalctl -u web-proxy-config -f
|
||||
journalctl -u web-proxy-config -f
|
||||
```
|
||||
|
||||
### 8. Локальная проверка
|
||||
## Доступ через Caddy
|
||||
|
||||
По умолчанию приложение должно быть доступно только на:
|
||||
Приложение слушает только:
|
||||
|
||||
```text
|
||||
127.0.0.1:8090
|
||||
```
|
||||
|
||||
Проверить его с самого мини-ПК можно командой:
|
||||
Пример LAN-only блока Caddy:
|
||||
|
||||
```bash
|
||||
curl http://127.0.0.1:8090
|
||||
```
|
||||
|
||||
Если приложение отвечает, можно настраивать доступ к нему через Caddy.
|
||||
|
||||
|
||||
## Доступ к веб-интерфейсу
|
||||
|
||||
Приложение должно слушать только локальный адрес:
|
||||
|
||||
```text
|
||||
127.0.0.1
|
||||
```
|
||||
|
||||
Доступ к нему рекомендуется организовать через Caddy с ограничением только для локальной сети.
|
||||
|
||||
Блок Caddy, который проксирует веб-интерфейс web-proxy-config, должен находиться **вне управляемых маркеров**,
|
||||
чтобы приложение никогда не изменяло собственную точку доступа.
|
||||
|
||||
|
||||
|
||||
### Пример
|
||||
|
||||
|
||||
```text
|
||||
```caddyfile
|
||||
proxy.stadidisk.ru {
|
||||
@lan remote_ip 192.168.7.0/24 10.10.10.0/24
|
||||
|
||||
@@ -276,4 +290,6 @@ proxy.stadidisk.ru {
|
||||
|
||||
respond "Forbidden" 403
|
||||
}
|
||||
```
|
||||
```
|
||||
|
||||
Этот блок рекомендуется размещать **вне управляемых маркеров**, чтобы Proxy Config никогда не изменял собственную точку входа.
|
||||
|
||||
Reference in New Issue
Block a user