Update docs

docs/SETUP.md

@@ -0,0 +1,89 @@
+## Настройка
+
+Packmate использует настройки из файла `.env` (в той же папке, что и `docker-compose.yml`)
+
+### Основные настройки
+```dotenv
+# Локальный IP сервера, на который приходит игровой трафик
+PACKMATE_LOCAL_IP=10.20.1.1
+# Имя пользователя для web-авторизации
+PACKMATE_WEB_LOGIN=SomeUser
+# Пароль для web-авторизации
+PACKMATE_WEB_PASSWORD=SomeSecurePassword
+```
+
+### Режим работы
+Packmate поддерживает три основных режима работы: `LIVE`, `FILE` и `VIEW`.
+1. `LIVE` - это основной режим работы во время CTF. Packmate обрабатывает живой трафик и сразу выводит результаты.
+2. `FILE` - обрабатывает трафик из pcap файлов. Полезен для анализа трафика с прошедших CTF, где не был запущен Packmate, или тех, где невозможно запустить его на вулнбоксе.
+3. `VIEW` - Packmate не обрабатывает трафик, а только показывает уже обработанные стримы. Полезен для разборов после завершения CTF.
+
+<details>
+  <summary>Настройка LIVE</summary>
+
+Необходимо указать интерфейс, через который проходит игровой трафик.
+На этом же интерфейсе должен располагаться ip, указанный в параметре `PACKMATE_LOCAL_IP`
+
+```dotenv
+# Режим работы - перехват
+PACKMATE_MODE=LIVE
+# Интерфейс, на котором производится перехват трафика
+PACKMATE_INTERFACE=game
+```
+
+</details>
+
+<details>
+  <summary>Настройка FILE</summary>
+
+Необходимо указать название pcap файла, лежащего в папке pcaps. 
+После запуска в веб-интерфейсе появится кнопка, активирующая чтение файла. 
+Важно, чтобы к этому моменту уже были созданы сервисы и паттерны (см. раздел Использование).
+
+```dotenv
+# Режим работы - анализ файла
+PACKMATE_MODE=FILE
+# Название файла в папке pcaps
+PACKMATE_PCAP_FILE=dump.pcap
+```
+
+</details>
+
+<details>
+  <summary>Настройка VIEW</summary>
+
+В этом режиме Packmate просто показывает уже имеющиеся данные. 
+
+```dotenv
+# Режим работы - просмотр
+PACKMATE_MODE=VIEW
+```
+
+</details>
+
+### Очистка БД
+На крупных CTF через какое-то время накапливается большое количество трафика. Это замедляет работу Packmate и занимает много места на диске.
+
+Для оптимизации работы, рекомендуется включить регулярную очистку БД от старых стримов. Это будет работать только в режиме `LIVE`.
+```dotenv
+PACKMATE_OLD_STREAMS_CLEANUP_ENABLED=true
+# Интервал удаления старых стримов (в минутах).
+# Лучше ставить маленькое число, чтобы стримы удалялись маленькими кусками, и это не нагружало систему
+PACKMATE_OLD_STREAMS_CLEANUP_INTERVAL=1
+# Насколько старым стрим должен быть для удаления (в минутах от текущего времени)
+PACKMATE_OLD_STREAMS_CLEANUP_THRESHOLD=240
+```
+
+### Дополнительные настройки
+
+```dotenv
+# Пароль от БД. Из-за того, что БД принимает подключения только с localhost, менять его необязательно, но можно, для дополнительной безопасности.
+PACKMATE_DB_PASSWORD=K604YnL3G1hp2RDkCZNjGpxbyNpNHTRb
+# Версия Packmate. Можно изменить, если нужно использовать другой образ из docker registry.
+BUILD_TAG=latest
+```
+
+Чтобы использовать расшифровку TLS (с RSA), нужно положить соответствующий приватный ключ, который
+использовался для генерации сертификата, в папку `rsa_keys`.
+
+Файлы БД сохраняются в ./data, поэтому для обнуления базы нужно удалить эту папку.