Различия

Показаны различия между двумя версиями страницы.

--- external:pro_toilet:02_protoilet_configure:01_settings [2023/10/18 11:51] – создано leonid_sterligov
+++ external:pro_toilet:02_protoilet_configure:01_settings [2023/10/18 13:41] (текущий) – leonid_sterligov
@@ Строка 1: / Строка 1: @@
 ====== Общие настройки ProToilet ======
+ProToilet_settings.yaml - файл конфигурации модуля, он содержит все необходимые настройки для работы модуля.
+Данный файл создается автоматически при первом запуске модуля.
+После изменения параметров в данном файле, для вступлениях их в силу необходимо перезапустить модуль ProToilet.
+Настройки разбиты на 4 группы:
+  * local_server - параметры локального сервера модуля
+  * log - параметры логирования
+  * pin - параметры генерируемых pin-кодов
+  * web_controller - параметры работы c контроллером
+===== local_server =====
+<code>
+# Локальный сервер
+local_server:
+  # IP адрес на котором будет размещен сервер (str)
+  host: 0.0.0.0
+  # Порт сервера (int)
+  port: 11170
+  # Зашифрованный пароль для доступа к серверу (str)
+  password: ''
+  # Максимальное кол-во потоков для сервера (int)
+  threadpool_size: 4
+</code>
+   * **host** - Подсеть, в рамках которой сервер ProToilet принимает и обрабатывает запросы. Значение по умолчанию «0.0.0.0» (обрабатывать запросы из любой подсети). \\ **Важно!** Если вы не знаете зачем нужен этот параметр - не меняйте его значение. \\ **Важно!** Не устанавливать «127.0.0.1».
+   * **port** - Порт на котором работает (принимает запросы) сервер ProToilet (по умолчанию 11190).
+   * **password** - пароль для авторизации в админку.
+   * **threadpool_size**- количество потоков обработки. Изменять не рекомендуется!
+===== log =====
+<code>
+# Логирование
+log:
+  # Уровень логирования (int)
+  level: 4
+  # Срок хранения *.log файлов (int)
+  retention_days: 7
+</code>
+  * **level** - Уровень логирования. Чем выше - тем подробнее. По умолчанию - 4. Возможные значения 1-10.
+  * **retention_days** - Срок хранения *.log файлов (дней). По умолчанию - 7. Возможные значения 1-30.
+===== web_controller =====
+<code>
+# Настройки для веб-контроллера
+web_controller:
+  # Интервал между сообщениями от контроллера (в секундах) (int)
+  interval: 10
+</code>
+  * **interval** - как часто(время в секундах) контроллер будет пинговать сервер. По умолчанию - 10.
+===== code_settings =====
+<code>
+# Настройки генерируемых пин-кодов
+pin:
+  # Длина пин-кода (int)
+  len: 4
+  # Время жизни пин-кода (в минутах) (int)
+  life_time: 15
+  # Кол-во возможных проходов по пин-коду (0 - безлимиты) (int)
+  pass_limit: 0
+</code>
+  * **len** - Длина пин-кода.
+  * **life_time** - Время жизни пин-кода (в минутах).
+  * **pass_limit** - Кол-во возможных проходов по пин-коду (0 - безлимит).