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

Требования к программному обеспечению сервера

Требования к программному обеспечению, на котором работает Webim Server. Требования описаны для Webim 11.0.

Способы установки

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

  • в кластер Kubernetes — основной способ. Комплект поставки содержит манифесты kustomize или Helm-чарт, а также установщик. Образы загружаются в Ваш реестр образов (container registry); для закрытого контура (air-gap) образы поставляются архивами и импортируются на узлы кластера;

  • через Docker Compose — на серверы без Kubernetes.

Все компоненты Webim Server работают в контейнерах, поэтому устанавливать на серверы Python, Node.js и другие зависимости приложения не нужно. Пакеты RPM и DEB для Webim 11.0 не выпускаются.

Хранилища и брокер сообщений — PostgreSQL, ClickHouse, Valkey или Redis, Apache Kafka и S3-совместимое хранилище; при использовании ускоренного поиска в Истории диалогов — также поисковый движок — для промышленной эксплуатации предоставляет заказчик: на собственных серверах или в виде управляемых (managed) сервисов. Комплект поставки может развернуть их внутри кластера Kubernetes по одному экземпляру без резервирования; такой вариант предназначен для тестовых установок.

Общие требования

ПО Версия Обязательность Особенности
Операционная система серверов Debian 12.5 Да Относится к узлам кластера Kubernetes и к серверам, на которых работает Docker. Установка на другие ОС возможна только после персонального согласования1.
Kubernetes 1.35 Да, при установке в Kubernetes Версия, на которой проводится тестирование (дистрибутив k3s). Требования к кластеру см. ниже.
Helm 3 Да, при установке из Helm-чарта Устанавливается на рабочее место администратора.
Docker Community Edition 29 Да, при установке через Docker Compose Минимально достаточная версия. Также требуется Docker Compose v2 (команда docker compose).
Реляционная СУБД PostgreSQL 18.1 Да Минимальная версия — PostgreSQL 15. MySQL и MariaDB не поддерживаются.
Пул соединений PostgreSQL PgBouncer 1.23 Нет Допускается только режим transaction с параметром max_prepared_statements больше 0, см. ниже.
Колоночная СУБД ClickHouse 26.3 Да Минимальная версия — ClickHouse 24.4. Используется для работы статистики v2.
Резидентная СУБД Valkey 9.0 или Redis 7.4 Да Используется для кэша, блокировок, отслеживания сроков отложенных задач и доставки событий в веб-интерфейсы. Основной вариант — Valkey.
Брокер сообщений Apache Kafka 3.9.0 Да Через Kafka выполняются фоновые и периодические задачи Webim Server; требования см. ниже.
Поисковый движок OpenSearch 2 или Elasticsearch 8.7.1 Нет Используется только для ускоренного поиска в Истории диалогов.
Объектное хранилище S3-совместимое API Да Хранит файлы чатов, аватары, логотипы и статические файлы веб-интерфейсов. В комплект поставки может входить MinIO.
Сервис проверки пунктуации LanguageTool 6.8 Нет Проверяет пунктуацию в сообщениях операторов. Используйте собственный экземпляр сервиса: при обращении к публичному сервису LanguageTool текст сообщений передавался бы третьей стороне. Проверка орфографии встроена в Webim Server и внешних сервисов не требует.
Система мониторинга Prometheus 2.54.1 Нет Входит в комплект поставки как дополнительный компонент вместе с Grafana 11.2.0 и Alertmanager 0.27.0.
Система сбора журналов Graylog 6.0 или OpenObserve 0.12.1 Нет Входит в комплект поставки как дополнительный компонент. Журналы контейнеров доставляет Vector 0.42.0.
Контроллер домена Windows Server Windows Server 2016 Нет Используется для интеграции с Active Directory. При использовании более новых версий Windows Server возможны отличия в деталях настройки от описанного в документации.
Служба каталогов Active Directory в составе Windows Server 2016 Нет Active Directory подключается опционально. Используется для SSO и авторизации операторов.
Протокол аутентификации Kerberos 5 Нет Используется для единого входа (SSO) по Kerberos-билетам.
Протокол доступа к службе каталогов LDAP 3 Нет Используется для авторизации операторов через Active Directory.

Требования к кластеру Kubernetes

Компоненты кластера устанавливает и обслуживает Ваша платформенная команда:

Компонент Обязательность Назначение
Ingress-контроллер Да Принимает внешние запросы и передаёт их в nginx из комплекта поставки. Пример манифеста Ingress в комплекте поставки рассчитан на ingress-nginx; для других контроллеров, например Traefik, используйте эквивалентные настройки.
metrics-server Да Предоставляет метрики загрузки CPU для автоматического масштабирования веб-сервера (HorizontalPodAutoscaler).
StorageClass по умолчанию с динамическим выделением томов Да, если хранилища разворачиваются в кластере Используется для томов PostgreSQL, ClickHouse, Kafka, Elasticsearch и MinIO.
KEDA 2.20.1 Нет Масштабирует Kafka-обработчики по отставанию (lag) групп потребителей. Для Kubernetes 1.35 требуется версия KEDA 2.20.1 или новее.
cert-manager Нет Выпускает и продлевает TLS-сертификаты для Ingress.
External Secrets Operator Нет Загружает пароли и ключи Webim Server из внешнего хранилища секретов.

Также необходимо обеспечить:

  • доступ узлов кластера к реестру образов с образами Webim Server. При установке в закрытом контуре образы импортируются на каждый узел;

  • отдельное пространство имён (namespace) для Webim Server;

  • лимит подов на узел, достаточный для размещения подов Webim Server: в базовой конфигурации комплекта поставки их более 80, см. Требования к аппаратному обеспечению. По умолчанию kubelet размещает на узле не более 110 подов;

  • на рабочем месте администратора — kubectl и openssl (их использует установщик), а при установке из Helm-чарта — Helm 3;

  • если Elasticsearch разворачивается в кластере, параметр ядра vm.max_map_count=262144 на узлах.


Требования к серверу реляционной СУБД

Webim Server работает с PostgreSQL, а также Platform V Pangolin DB. Минимальная версия — PostgreSQL 15, но тестирование проводится на PostgreSQL 18.1, поэтому гарантируется работа именно на этой версии.

Webim Server подключается к PostgreSQL напрямую, через Patroni или через пул соединений PgBouncer. PgBouncer должен работать в режиме transaction с параметром max_prepared_statements больше 0 (параметр поддерживается начиная с PgBouncer 1.21): Webim Server использует подготовленные запросы (prepared statements), и без этого параметра запросы завершаются ошибками.

Поддерживаемые операционные системы, ограничения и требования к окружению проверяйте по документации PostgreSQL.


Требования к серверу аналитической (колоночной) СУБД

Webim Server работает с ClickHouse версии 24.4 и выше, тестирование проводится на ClickHouse 26.3, работа гарантируется именно на этой версии. В более ранних версиях нет настроек, которые Webim Server использует при удалении данных статистики.

Таблицы статистики реплицируемые и распределённые, поэтому даже единственный сервер ClickHouse настраивается как кластер с сервисом координации (ClickHouse Keeper или ZooKeeper). Подробнее — в статье Требования к хранилищу.

Согласно официальной документации, ClickHouse может быть установлен на любой ОС на базе Linux, FreeBSD или Mac OS X с CPU-архитектурой x86_64, ARM или PowerPC64LE.


Требования к серверу резидентной СУБД

Webim Server работает с резидентной СУБД Valkey 9.0 и Redis 7.4. Поддерживаются подключение через Sentinel и шифрование TLS.

Обработчику отложенных задач нужны уведомления об истечении срока ключей (параметр notify-keyspace-events). Подробнее — в статье Требования к хранилищу.

Поддерживаемые операционные системы и требования к окружению проверяйте по документации Valkey или Redis.


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

Webim Server поддерживает Elasticsearch 8.x и OpenSearch 2.x. Тестирование проводится на Elasticsearch 8.7.1.

Требования к окружению и поддерживаемым операционным системам смотрите в документации выбранного поискового движка:


Требования к Apache Kafka

Apache Kafka обязательна для работы Webim Server 11.0+: через её топики передаются все фоновые задачи, включая периодические задачи планировщика. Тестирование проводится на Apache Kafka 3.9.0 в режиме KRaft.

Необходимо обеспечить:

  • доступ к брокерам Kafka (bootstrap servers) со всех узлов или серверов, на которых работает Webim Server;

  • права сервисной учётной записи на создание топиков и увеличение числа их партиций. Топики создаёт служебное задание kafka-setup при развёртывании Webim Server, поэтому автоматическое создание топиков на брокере можно отключить;

  • права на запись и чтение топиков и на работу с группами потребителей (consumer groups);

  • при использовании защищённых подключений — корректные параметры аутентификации и шифрования. Поддерживаются протоколы SASL_PLAINTEXT, SASL_SSL и SSL и механизмы SASL PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, GSSAPI и OAUTHBEARER.


  1. За исключением операционных систем, доступ к которым со стороны Webim затруднён (свободный доступ отсутствует, заблокирован для пользователей из РФ и т. п.). ↩