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

Конфигурация 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-соединений: 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 Адрес почтового сервера для отправки электронной почты в hosted-режиме.
hostedmode_smtp_skip_ssl_check true Игнорирование проверки SSL/TLS сертификатов (true/false).
hostedmode_smtp_timeout 30 Максимальное время ожидания операции SMTP (секунды).
https_domains[] somedev.ru Список доменов, на которых размещаются hosted-серверы.
mailgun_dev_domain sandbox1234.mailgun.org Домен для работы с Mailgun в среде разработки. Позволяет тестировать отправку писем, не затрагивая рабочую среду.
channels_email_mailgun_api_key_v2 3f9a1d1c58b7e0b6c1a... Новый API-ключ Mailgun для исходящих запросов (отправка писем, управление вебхуками). Указывать без префикса key-. Обязателен для новых аккаунтов Mailgun.
channels_email_mailgun_webhook_signing_key 6c72bb3a1f0d4e8a9c... Ключ проверки подписи вебхуков Mailgun. Используется для валидации параметров timestamp, token, signature во входящих запросах. Обязателен при приёме почты через Mailgun.
mailgun_key key-ExamPle3xAMPle Устаревший параметр для старых аккаунтов Mailgun. Применяется только для исходящих запросов и не используется для проверки подписи вебхуков. Для новых аккаунтов используйте channels_email_mailgun_api_key_v2 и channels_email_mailgun_webhook_signing_key.
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. Можно указать несколько значений, каждое с новой строки.
nginx_geosearch false Включение геолокационного поиска в NGINX. Может включать интеграцию с базой геоданных или сервисом.
nginx_upload_size 10 Максимальный размер загружаемого файла (МБ).
online_dir /var/cache/webim Директория для хранения онлайн-ресурсов и файлов.
python_geosearch true Включение возможностей геопоиска на стороне Python: ключи, endpoint’ы и прочие параметры.
ready_images_dir /var/cache/webim Директория для сохранения обработанных изображений.
registration_mail_jira somemail@example.com Адрес электронной почты для отправки уведомлений о регистрации.
secure_internal_requests true Требование защищённых внутренних запросов приложения (например, использование HTTPS для межсервисного взаимодействия).
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 Адрес электронной почты службы поддержки.