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

Почта и внешние сервисы

Подключение к SMTP-серверу для отправки писем, параметры работы с Telegram Bot API и параметры исходящих HTTP-соединений.

Как изменить параметры и применить изменения, описано в разделе Параметры .env. Все параметры на этой странице необязательные.

Отправка почты

Параметры SMTP-сервера, через который Webim отправляет письма: пароли сотрудников, письма для восстановления пароля, уведомления и истории диалогов. Если в настройке Constance CUSTOM_POST_SERVER_URL задан HTTP-сервер отправки почты, письма аккаунта отправляются через него (см. Custom Post Server).

Параметр Тип По умолчанию Описание
EMAIL_HOST Строка mailhog Адрес SMTP-сервера, например smtp.example.local. Значение по умолчанию — тестовый почтовый сервер среды разработки; в рабочей установке задайте адрес Вашего SMTP-сервера. Пустое значение равносильно отсутствующему параметру.
EMAIL_PORT Целое число 1025 Порт SMTP-сервера. Обычно используются порты 587 (вместе с EMAIL_USE_TLS=True), 465 (вместе с EMAIL_USE_SSL=True) или 25. Пустое значение равносильно отсутствующему параметру.
EMAIL_USE_TLS Логический False Шифрование соединения командой STARTTLS, обычно на порту 587.
EMAIL_USE_SSL Логический False Шифрованное соединение SSL/TLS с момента подключения, обычно на порту 465. Не включайте одновременно с EMAIL_USE_TLS.
EMAIL_HOST_USER Строка Пусто Имя пользователя для аутентификации на SMTP-сервере. Пустое значение — письма отправляются без аутентификации.
EMAIL_HOST_PASSWORD Строка Пусто Пароль для аутентификации на SMTP-сервере.
EMAIL_TIMEOUT Целое число, секунды 20 Тайм-аут операций с SMTP-сервером.
DEFAULT_FROM_EMAIL Строка no-reply@example.local Адрес отправителя писем Webim по умолчанию, например no-reply@chat.example.local. Укажите адрес, с которого Ваш SMTP-сервер разрешает отправку.
MAIL_CHANNEL_TIMEOUT_SECONDS Целое число, секунды 20 Тайм-аут операций с IMAP- и SMTP-серверами почтовых каналов.

Telegram

Параметр Тип По умолчанию Описание
TELEGRAM_BOT_API_URL URL Пусто Адрес собственного сервера Telegram Bot API для всей установки, например https://tg-api.example.local. Используется для каналов Telegram, в настройках которых не задан свой адрес, если не задана и настройка Constance TELEGRAM_BOT_API_URL (см. Каналы, боты и опросы). Пустое значение — используется api.telegram.org.
Адрес должен начинаться с http:// или https:// и содержать имя хоста, иначе Webim не запускается.
TELEGRAM_BOT_API_SSL_VERIFY_SKIP Логический False Отключает проверку SSL-сертификата сервера Telegram Bot API для каналов, в настройках которых этот параметр не задан явно. Проверку также отключает настройка Constance TELEGRAM_BOT_API_SSL_VERIFY_SKIP. Используйте только для собственного сервера Bot API с самоподписанным сертификатом.
TELEGRAM_WEBHOOK_PROXY_URL URL Пусто Адрес прокси-сервера для регистрации вебхуков Telegram, например https://tg-proxy.example.local. Используется для каналов, в настройках которых не задан свой прокси-сервер.
При регистрации вебхука Webim отправляет запрос GET <адрес>/register?url=<адрес вебхука> (путь /register добавляется, если его нет в адресе) и регистрирует в Telegram адрес из поля url JSON-ответа.
Адрес должен начинаться с http:// или https:// и содержать имя хоста, иначе Webim не запускается.
TELEGRAM_WEBHOOK_PROXY_SSL_VERIFY_SKIP Логический False Отключает проверку SSL-сертификата при запросе к прокси-серверу из TELEGRAM_WEBHOOK_PROXY_URL. На запросы к Telegram Bot API и к прокси-серверам из настроек каналов не влияет.

Исходящие HTTP-соединения

Параметры соединений Webim с внешними сервисами: ботами, обработчиками событий, API каналов и другими.

Параметр Тип По умолчанию Описание
HTTP_CA_BUNDLE Путь к файлу Набор сертификатов пакета certifi Файл с сертификатами доверенных удостоверяющих центров (PEM) для проверки сертификатов при исходящих HTTPS-соединениях: с ботами, обработчиками вебхуков, API каналов, S3-хранилищем и SMTP-сервером. Пустое значение — используется хранилище сертификатов операционной системы.
Чтобы доверять сертификатам внутреннего удостоверяющего центра, укажите файл, который содержит и стандартные корневые сертификаты, и сертификат Вашего удостоверяющего центра. Сертификаты для подключения к PostgreSQL, Kafka и другим инфраструктурным сервисам задаются отдельными параметрами (DATABASE_SSL_ROOT_CERT, *_SSL_CA_LOCATION).
HTTP_POOL_ENABLED Логический True Повторное использование соединений для исходящих HTTP-запросов (пул соединений). Без пула каждый запрос к внешнему сервису устанавливает новое соединение. Выключайте только по рекомендации технической поддержки Webim.
HTTP_POOL_CONNECTIONS_PER_HOST Целое число 4 Максимальное число одновременных соединений с одним внешним хостом в одном процессе. Общее число соединений с хостом равно этому значению, умноженному на число процессов Webim.
HTTP_POOL_HOSTS_PER_SESSION Целое число 32 Максимальное число внешних хостов, соединения с которыми хранятся в пуле одного процесса. При превышении закрываются соединения с хостом, к которому дольше всего не было запросов.
HTTP_POOL_MAX_CLIENTS Целое число 32 Максимальное число пулов соединений в одном процессе. Отдельный пул создаётся для каждого сочетания прокси-сервера и режима проверки сертификатов.
HTTP_POOL_KEEPALIVE_EXPIRY_SECONDS Целое число, секунды 30 Время, после которого неиспользуемое соединение закрывается.
CHANNEL_PROXY_TEST_TIMEOUT_SECONDS Целое число, секунды 10 Тайм-аут проверки прокси-сервера в настройках канала.
CHANNEL_OUTBOUND_RETRY_DELAYS_SECONDS Список чисел через запятую, секунды 1,3,10 Паузы между повторными попытками отправить сообщение в пользовательский канал (Custom Channel) при ответе с кодом 5xx, тайм-ауте или ошибке соединения. Число значений равно числу повторных попыток.
Значение не может быть пустым, иначе Webim не запускается.