Перейти к содержанию

Конфигурация main.ini

Main.ini - главный конфигурационный файл Webim Server, в котором устанавливаются ключевые настройки, необходимые для работы. Помимо него могут существовать и другие конфигурационные файлы (логика их работы заключается в слиянии с main.ini на этапе исполнения кода), но только существование main.ini является обязательным условием работы сервиса.

Параметры в main.ini имеют следующий вид:

some_parameter=some_value

Изначально большая часть параметров пустует и задавать их необходимо вручную путём редактирования ini-файла. Задавать все параметры необязательно, но ключевые обязательно должны быть заданы (такие как my_ips, frontend_ips и связанные с рабочими директориями).

У каждого параметра может быть более одного значения. В этом случае каждое дополнительное значение указывается с новой строки в той же формулировке, что и все остальные, а после наименования параметра указывается []. Пример:

  • some_parameter[]=some_value
  • some_parameter[]=another_value
  • some_parameter[]=one_more_value

При чтении таких параметров их значения группируются по ключу в соответствии со списком найденных значений.

Возможные параметры

Параметр Пример Значение
accounts-base-local-dir /var/pro/client-data/cd Локальный путь к директории, где хранятся данные или конфигурационные файлы, связанные с учетными записями.
blocked_notify_email somemail@example.com Адрес электронной почты для отправки уведомлений о блокировках
browscap-csv-path /var/pro/browscap/browscap.csv Путь к файлу browscap в формате CSV.
browscap-path /var/pro/browscap/browscap.ini Путь к конфигурационному файлу browscap, использующемуся для определения возможностей браузера, таких как тип браузера, версия и поддерживаемые функции.
channels_apple_chat_encrypted_data_length_check_disabled false Отключение/включение проверки длины зашифрованных сообщений в Apple Messages for Business
channels_proxy_api_secret_key s3cr3tK3y123! Секретный ключ для сохранения/удаления кастомного канала общения через proxy API
channels_proxy_api_url https://proxyserver.com Создание/удаление канала связи для хостеда
channels_proxy_base_url https://api.proxyserver.com Базовый URL для сервиса прокси каналов
docker_sub_net 172.195.0.0/28 Подсеть для Docker
frontend_ips[] 192.168.10.10 IP-адреса, на которых будет располагаться фронтэнд Webim Server
hostedmode true Режим работы Webim Server. True - работа в hosted-режиме, False - в облаке
hostedmode_smtp_auth_mode login Тип аутентификации. Может быть login, plain, cram-md5 или пустое значение (``, None).
hostedmode_smtp_encryption tls Определяет тип шифрования, используемый для SMTP-соединений в режиме hosted. Общие значения включают none (без шифрования), ssl и tls. Эта настройка обеспечивает безопасное общение между приложением и SMTP-сервером.
hostedmode_smtp_from_addr noreply@mycompany.com Адрес отправителя для электронных писем, направленных системой на почтовый сервер
hostedmode_smtp_password mypassword Пароль для почтового сервера
hostedmode_smtp_port 4242 Порт для почтового сервера
hostedmode_smtp_server smtp.mailgun.org Адрес почтового сервера для отправки электронной почты хостеду
hostedmode_smtp_skip_ssl_check true Игнорирование проверки SSL/TLS сертификатов. Может принимать значение true или false
hostedmode_smtp_timeout 30 Максимальное время ожидания завершения операции SMTP в режиме hosted в секундах.
https_domains[] somedev.ru Список доменов, на которых размещаются hosted-серверы
mailgun_dev_domain sandbox1234.mailgun.org Доменное имя, используемое с Mailgun для отправки электронных писем в среде разработки. Позволяет приложению использовать определенный домен для тестирования функциональности, не затрагивая рабочую среду.
mailgun_key key-ExamPle3xAMPle Ключ Mailgun
mq_host rabbitmq Хост для RabbitMQ
mq_password password Пароль для RabbitMQ
mq_port 5672 Порт для RabbitMQ
mq_username user Имя пользователя для RabbitMQ
my_ips[] 192.168.10.10\n192.168.10.20\n192.168.10.30/24 Этим параметром задаются IP-адреса или подсети, на которых будет работать Webim Server. Можно указать несколько IP-адресов или подсетей, каждый из них задаётся отдельно с новой строки.
nginx_geosearch false Настраивает функциональность геолокационного поиска в NGINX. Может включать настройки, позволяющие NGINX обрабатывать геолокационные запросы, такие как интеграция с базой данных геолокации или сервисом.
nginx_upload_size 10 Максимальный допустимый размер загружаемого на сервер файла (в Мб)
online_dir /var/cache/webim Путь к директории, используемой для хранения онлайн-ресурсов, файлов или активов.
python_geosearch true Настраивает возможности географического поиска на Python. Может включать API-ключи, URL-адреса конечных точек или другие параметры, необходимые для выполнения геолокационных поисков.
ready_images_dir /var/cache/webim Путь к директории, в которой хранятся обработанные изображения
registration_mail_jira somemail@example.com Адрес электронной почты для отправки уведомлений о регистрации
secure_internal_requests true Указывает, должны ли внутренние запросы в приложении быть защищенными. Может использовать HTTPS для внутренних API-запросов или межсервисной связи для повышения безопасности.
server_monitoring_email somemail@example.com Адрес электронной посты для отправки уведомлений, связанных с мониторингом сервера
service_notifications_emails somemail@example.com Адрес электронной посты для отправки сервисных уведомлений
web_cache_dir /var/cache/webim Директория, в которую будет складываться кэш Webim Server
webim_support_email somemail@example.com Адрес электронной почты службы поддержки