upd README.md

README.md

@@ -61,6 +61,80 @@ services:
 - Создать файл config.ini (пример содержимого app/config/config-template.ini)
 - Создать файл dev_list.txt (список устройств)
 
+Пример содержимого config.ini
+
+```text
+# Конфиг для отправки оповещений через телеграм
+[tg]
+# False \ True - включение\отключение отправки оповещения в телеграм
+send: False
+
+# Конфиг для отправки оповещений на почту телеграм
+[mail]
+# False \ True - включение\отключение отправки оповещения на почту
+send: False
+# Адрес smtp сервера
+server: smtp.example.com
+# Порт smtp сервера
+port: 25
+# Адрес с которого отправляются оповещения
+from_address: net-bcp@example.com
+# Адрес или список адресов, на которые отправляется оповещений
+to_address: engineer@example.com, network_manager@example.com
+# Тема письма
+subject: Warning in backup network device
+
+# Конфиг гит репозитория
+[git]
+# False \ True - включение\отключение отправки файлов в удалённый репозиторий
+push: False
+# Пользователь в локальном гите
+user: net-bcp
+mail: net-bcp@example.com
+
+# Настройки для удалённого репозитория
+# Пока только https
+protocol: https
+# url
+remote: gitlab.example.com.ru/secure/backup-network-device.git
+# ветка
+branch: main
+# Удаление локального репозитория после push
+remove_local: False
+
+[bcp]
+# Файл со списком устройств. Должен лежать в папке config
+file: dev_list.txt
+# Регулярное выражение по которому будет парситься список устройств
+pattern:(?P<name>\S+) (?P<ip>\d+\.\d+\.\d+\.\d+) (?P<vendor>\S+) (?P<model>\S+)
+# Во сколько будет делаться бэкап
+start_at: 18:59
+# True \ False - Создание папок внутри репозитория. Если False, то все файлы будут сохраняться в корень
+in_folder: True
+# Регулярное выражение по которому будет парситься имя папки из названия девайса
+folder_name_pattern: ^(.*?)-
+# Если количество строк в конфиге меньше указанного значения - ошибка, изменения не записываются.
+min_string_count: 50
+
+[net_dev]
+# True \ False - создание лога подключения к устройству (для тестов на одном устройстве)
+debug: False
+# Порт на который подключаться по ssh
+ssh_port: 22
+# Время, которое netmiko ждёт результата введённой команды
+read_timeout: 30
+
+[log]
+# Уровень логов в консоль
+console_lvl: 20
+# Уровень логов в файл
+file_lvl: 30
+# Формат даты в логе
+date_format: %Y-%m-%d %H:%M:%S
+# Формат лога
+format: [%(asctime)s.%(msecs)03d] %(module)-25s:%(lineno)4d | %(funcName)-20s| %(levelname)-8s | %(message)s
+```
+
 Пример содержимого dev_list.txt, которое попадёт под регулярное выражение по умолчанию.
 ```text
 HOME-GW01 192.168.254.1 MikroTik RB5009UPr+S+