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

Требования к сетевым настройкам сервера

Информация в этом разделе предназначена для системных администраторов, которые настраивают сетевое и серверное оборудование Вашей компании.

Webim Server требует настройки следующих параметров и доступов:

Параметр Значение Особенности
Порт HTTPS 443 Настройте доступ по 443 TCP-порту извне к Ingress-контроллеру кластера Kubernetes или к балансировщику перед ним. По HTTPS работают веб-интерфейсы, виджет, Webim API/SDK и внешний адрес объектного хранилища.
Порт HTTP 80 Используется для перенаправления запросов на HTTPS и для выпуска сертификатов по протоколу ACME, например через cert-manager. Работа Webim Server по HTTP без шифрования не поддерживается.
Порт веб-сервера Webim Server 8260 Внутренний порт подов веб-сервера: запросы к нему передаёт nginx из комплекта поставки, доступ извне не требуется. При установке через Docker Compose порт должен быть свободен на сервере.
TLS-сертификат (файл) Для работы по шифрованному протоколу HTTPS понадобится TLS-сертификат (SSL — устаревший стандарт, не следует использовать) для доменного имени системы. Если эффективный внешний URL какого-либо бакета или CDN указывает на другой хост, сертификат нужен и для этого имени. Сертификат размещается на Ingress-контроллере или на балансировщике перед кластером. Сертификат, который видят посетители и операторы, должен быть доверенным для их браузеров и мобильных приложений. Подробнее — в разделе «TLS-сертификат» ниже.
Записи в DNS например, webim.example.local (и при необходимости s3.webim.cdn.local) Доменное имя системы должно быть доступно в сети использования чата. Отдельное доменное имя нужно, только если эффективный внешний URL бакета или CDN указывает на другой хост. Имя хоста системы (FQDN) должно быть выделено под Webim целиком (корень /), без размещения других сервисов на этом же имени. Подробнее — в разделе «Требования к доменному имени» ниже.
SMTP(S): server IP, порт, логин-пароль Для отправки сообщений по электронной почте нужны реквизиты сервера, доступного по Secure SMTP, — например, Mailgun. Значение не должно быть пустой строкой.

Требования к доменному имени

Для работы Webim Server требуется полное доменное имя (FQDN) системы. Дополнительное FQDN для объектного хранилища или CDN нужно, только если хотя бы один эффективный внешний URL бакета или CDN указывает на другой хост:

  • доменное имя системы, например webim.example.local. Уровень доменного имени может быть любым, но для доменного имени второго уровня нужно задать базовый домен (см. ниже);

  • при необходимости — доменные имена, на которые указывают эффективные внешние URL бакетов и CDN, например s3.webim.cdn.local. С них браузеры посетителей и операторов загружают статические файлы веб-интерфейсов, аватары и файлы чатов. Адрес задаётся общим S3_BASE_URL или отдельно для бакетов (S3_STATIC_BASE_URL, S3_PUBLIC_BASE_URL, S3_PRIVATE_BASE_URL; для статики также S3_STATIC_CUSTOM_DOMAIN). При использовании управляемого объектного хранилища указывается его доменное имя.

По умолчанию S3_BASE_URL равен /s: если все эффективные URL бакетов и CDN относительные или обслуживаются под FQDN системы, отдельный FQDN не требуется. Даже при относительном общем S3_BASE_URL отдельный бакет или CDN может указывать на абсолютный URL другого хоста — тогда для этого хоста нужны DNS и доверенный TLS.

Работа Webim Server без доменного имени (например, по IP-адресу или на адресе без DNS) не поддерживается: в конфигурации должен быть указан FQDN, который корректно разрешается в DNS и доступен в сети использования чата.

Доменное имя системы используется для обращений к веб-интерфейсам, виджету, API и мобильным SDK. Статические файлы и вложения загружаются по эффективным внешним URL бакетов и CDN: при относительных URL (по умолчанию /s) — с того же домена системы, при абсолютных — с указанных хостов. Домены должны соответствовать следующим требованиям:

  • Домены должны быть доступны в той сети, где будет использоваться чат:

    • если чат используется в публичном интернете — домены должны быть опубликованы в публичном DNS и указывать на доступный извне адрес или балансировщик;

    • если чат используется только во внутренней сети — доменные имена должны корректно разрешаться во внутреннем DNS и быть доступными из этой сети.

  • Доменное имя системы (FQDN) должно быть выделено под Webim целиком: на этом имени хоста приложение обслуживает корень / и собственные пути (/agent/, /api/, /l/ и др.). Размещение Webim «под путём» вместе с другими приложениями (например, https://example.local/webim) не поддерживается: одного URL-префикса /webim/* недостаточно.

    • Другие сервисы могут работать на соседних именах хостов в той же родительской зоне (например, portal.example.local рядом с webim.example.local). Если базовый домен cookie (BASE_DOMAIN) совпадает с родительской зоной, cookie Webim будут видны на соседних хостах — задайте BASE_DOMAIN равным доменному имени системы (см. «Базовый домен»).
  • Веб-интерфейсы, виджет и API работают по одному доменному имени системы, указанному в параметре ROOT_URL. Разнести их по разным доменам нельзя: исходящие ссылки (письма, вебхуки каналов, push) строятся от ROOT_URL, а сессионные cookie привязаны к хосту. Статические файлы и вложения могут отдаваться с отдельных доменов, если эффективные внешние URL бакетов или CDN указывают на другие хосты — см. выше. IP-адрес вместо доменного имени системы не поддерживается.

  • Домены должны быть доступны:

    • со стороны посетителей (браузеры/мобильные SDK) и рабочих мест операторов/администраторов;

    • с узлов кластера и серверов Webim Server (например, если используются обращения по доменному имени через прокси/балансировщик). Рекомендуется обеспечить корректное разрешение имени и маршрутизацию.

  • Домены, которые видят посетители и операторы, должны иметь действующий TLS-сертификат, которому эти клиенты доверяют (см. строку «TLS-сертификат» выше).

Базовый домен

Веб-интерфейсы операторов хранят часть данных, например текущий статус оператора, в cookie базового домена. Базовый домен задаётся параметром BASE_DOMAIN. По умолчанию это доменное имя системы без первой метки: для webim.example.local — example.local, для chat.support.example.local — support.example.local.

Базовый домен не должен быть доменной зоной (публичным суффиксом), например local, ru или co.uk. Браузеры не принимают cookie для доменных зон, и тогда, например, статус оператора не восстанавливается после обновления страницы. Значение по умолчанию оказывается доменной зоной, если доменное имя системы второго уровня (например, example.local) или если его родительский домен — публичный суффикс. В этих случаях задайте параметр BASE_DOMAIN равным доменному имени системы.

Сетевые подключения

Входящие подключения (INBOUND)

В таблице перечислены порты, на которых Webim Server принимает входящие TCP-соединения извне.

Назначение Порт/протокол (по умолчанию) Доступность Примечание
Веб-интерфейсы и API (HTTPS) 443/tcp Из сети, где используется чат (публичная или корпоративная сеть) Ingress-контроллер кластера или балансировщик перед ним. Webim API/SDK также работают по HTTPS/443.
Объектное хранилище (HTTPS) 443/tcp Из сети, где используется чат Внешний адрес объектного хранилища. Для MinIO из комплекта поставки запросы к доменному имени хранилища направляются через Ingress на порт MinIO 9000/tcp.
HTTP 80/tcp Из сети, где используется чат Только для перенаправления на HTTPS и выпуска сертификатов по протоколу ACME.

Внутри кластера компоненты Webim Server принимают соединения на следующих портах. Доступ к ним извне не требуется.

Компонент Порт/протокол Примечание
nginx 80/tcp Принимает запросы от Ingress-контроллера.
Веб-сервер 8260/tcp Принимает запросы от nginx (через сервис Kubernetes chatback-web на порту 80/tcp). На этом же порту доступен /metrics для Prometheus.
Prometheus Pushgateway 9091/tcp Принимает метрики фоновых задач Webim Server.
Экспортёры метрик nginx 9113/tcp, 4040/tcp Опрашиваются Prometheus.

При установке через Docker Compose ограничьте доступ к портам nginx и веб-сервера доверенной сетью, например подсетью балансировщика.

Исходящие подключения (OUTBOUND)

Разрешите исходящие соединения с узлов кластера (или серверов Docker) на хранилища и внешние сервисы.

Указаны значения по умолчанию. Если порт изменён в конфигурации сервиса, используйте фактическое значение.

Назначение Порт/протокол (по умолчанию) Когда требуется
PostgreSQL 5432/tcp При подключении к PostgreSQL напрямую.
PgBouncer 6432/tcp При подключении к PostgreSQL через PgBouncer.
ClickHouse (native) 9000/tcp, с TLS — 9440/tcp Всегда.
ClickHouse (HTTP) 8123/tcp, с TLS — 8443/tcp Всегда: по HTTP создаются таблицы BI при развёртывании Webim Server.
Valkey / Redis 6379/tcp Всегда. В управляемых сервисах для подключений с TLS может использоваться другой порт, например 6380/tcp.
Sentinel 26379/tcp При подключении к Valkey или Redis через Sentinel.
Apache Kafka 9092/tcp или порт брокера Всегда.
Elasticsearch / OpenSearch 9200/tcp Если используется поисковый движок OpenSearch/Elasticsearch.
Объектное хранилище S3 443/tcp или порт хранилища (для MinIO — 9000/tcp) Всегда.
LanguageTool 8010/tcp Если включена проверка пунктуации.
SMTP(S)-сервер Порт SMTP-сервера (например, 465/tcp или 587/tcp) Если включена отправка e-mail уведомлений. Откройте исходящие соединения на порт, указанный в настройках SMTP. Если почта идёт через SMTP-релей, с серверов Webim Server должен быть доступен релей, а с хоста релея — целевой SMTP.
Active Directory 389/tcp (LDAP), 636/tcp (LDAPS), 88/tcp и 88/udp (Kerberos) При интеграции с Active Directory.
Внешние API 443/tcp При подключении каналов, ботов, вебхуков и интеграций, а также для отправки push-уведомлений в мобильные приложения (APNs, FCM, Huawei Push Kit).

Подробные требования к хранилищам (включая версии и дополнительные параметры) приведены в статье Требования к хранилищу.

Prometheus

Webim Server не устанавливает исходящих соединений к Prometheus: Prometheus сам опрашивает endpoint /metrics. Метрики фоновых задач Webim Server отправляет в Prometheus Pushgateway из комплекта поставки.

Если Prometheus развёрнут вне кластера, разрешите входящие соединения с Prometheus на порты, с которых собираются метрики:

  • веб-сервер: /metrics на порту 8260/tcp каждого пода;
  • Prometheus Pushgateway: порт 9091/tcp;
  • nginx: экспортёры метрик на портах 9113/tcp (состояние nginx) и 4040/tcp (время обработки запросов по журналу nginx).

TLS-сертификат

Необходим TLS-сертификат для доменного имени системы, по которому посетители и операторы обращаются к сервису чата. Если эффективный внешний URL какого-либо бакета или CDN указывает на другой хост, сертификат нужен и для этого имени. Сертификат размещается на Ingress-контроллере (например, его выпускает cert-manager) или на балансировщике перед кластером.

Использование устаревшего SSL не рекомендуется.

Сертификат внешнего домена (тот, который "видят" браузеры и мобильные приложения) должен быть доверенным для этих клиентов. Если хранилища принимают подключения по TLS с сертификатами корпоративного УЦ, корневой сертификат УЦ указывается в параметрах подключения Webim Server.

Дополнительно

По требованию заказчика может быть интегрирована система мониторинга, автоматического резервирования (backup/restore), балансировки нагрузки (рекомендуются). Система мониторинга (Prometheus, Grafana, Alertmanager) и система сбора журналов (Graylog или OpenObserve) могут входить в комплект поставки.