diff --git a/README.md b/README.md index b36de02..bb7614e 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,162 @@ dnsmasq --test 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. + + ## Доступ к веб-интерфейсу Приложение должно слушать только локальный адрес: @@ -94,3 +250,18 @@ systemctl restart dnsmasq Блок 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 +} +``` \ No newline at end of file