# Требования к хранилищу

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

  * В реляционной СУБД **PostgreSQL**. Здесь сохраняется вся необходимая для работы сервиса информация: операторы, чаты, категории, опросы, диалоги, настройки и т. д.

  * В колоночной СУБД **ClickHouse**. Здесь сохраняется информация, используемая модулем **Статистики**.

  * В S3-совместимом объектном хранилище. Здесь сохраняются файлы, отправленные посетителями и операторами, файлы, загруженные администраторами (например, аватары операторов и логотипы), а также статические файлы веб-интерфейсов.

  * В резидентной СУБД **Valkey** или **Redis**. Здесь хранятся кэш, блокировки и сроки отложенных задач.

  * В поисковом движке **Elasticsearch** или **OpenSearch**. Здесь хранится поисковый индекс **Истории диалогов**.

  * В брокере сообщений **Apache Kafka**. Здесь в течение срока хранения (retention) хранятся сообщения фоновых задач.

Какой контент мы накапливаем? Это информация о Ваших посетителях, операторах, супервизорах и администраторах, настройки системы, история диалогов с ними, передаваемые между операторами и посетителями файлы, статистика и т. д.

Контейнеры **Webim Server** не хранят данные на локальном диске, поэтому их можно перезапускать и переносить между серверами без потери данных.

Для промышленной эксплуатации размещайте хранилища на отдельных серверах или используйте управляемые (managed) сервисы. Комплект поставки может развернуть хранилища внутри кластера Kubernetes по одному экземпляру без резервирования; такой вариант предназначен для тестовых установок.

Серверы хранилищ должны [принимать сетевые подключения](https://webim.ru/kb/11.0/devops/sys-reqs-for-server/sys-reqs-server-nw.html) от **Webim Server** и не принимать анонимных подключений. Исключение — анонимное чтение публичных бакетов объектного хранилища (см. [ниже](#s3)). Требования к дисковым томам приведены в статье [Требования к жёсткому диску](https://webim.ru/kb/11.0/devops/sys-reqs-for-server/sys-reqs-server-hdd.html).

## Реляционная СУБД {: #postgresql }

Требования к **реляционной** СУБД при размещении сервиса на мощностях заказчика (hosted installation):

| Параметр                        | Значение                                                              | Особенности                                                                                                                                  |
|---------------------------------|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
| СУБД                            | PostgreSQL 18.1                                                         | Минимальная версия — PostgreSQL 15, но гарантируется работа с 18.1.                                                                                                          |
| База данных и пользователь СУБД | Отдельная база данных и отдельный пользователь                        | У пользователя должны быть **все** привилегии в рамках базы данных.                                                                          |
| Расширения                      | `pg_trgm`, `citext`                                                   | Если у пользователя нет прав на создание расширений, создайте их в базе данных заранее.                                                      |
| TCP/IP-порт                     | 5432 (по умолчанию для PostgreSQL), 6432 (по умолчанию для PgBouncer) | Можно использовать любой другой порт. Потребуется перенастройка СУБД, **Webim Server** и брандмауэров. Проверьте отсутствие конфликтов по новому порту. |
| Шифрование                      | TLS                                                                   | Режим проверки сертификата (`sslmode`) и корневой сертификат УЦ задаются в параметрах подключения **Webim Server**.                          |
| Объём места под БД              | Зависит от интенсивности работы и срока хранения данных               | См. [Примеры типовых конфигураций](https://webim.ru/kb/11.0/devops/sys-reqs-for-server/sys-reqs-server-hw.html#examples).                                                                          |
| Прочие аппаратные параметры     | Зависят от нагрузки                                                   | См. [Требования к аппаратному обеспечению сервера](https://webim.ru/kb/11.0/devops/sys-reqs-for-server/sys-reqs-server-hw.html).                                                                   |

Создайте базу данных и пользователя. Таблицы создаются автоматически при развёртывании **Webim Server**: служебное задание применяет миграции базы данных.

Каждый процесс **Webim Server** держит собственный пул соединений с базой данных. Общее число соединений складывается так:

  * веб-сервер — число подов × число рабочих процессов в поде (`WEB_WORKERS`) × размер пула (`DB_POOL_SIZE`);

  * остальные процессы — число подов × размер пула (`DB_POOL_SIZE`).

В базовой конфигурации комплекта поставки при максимальном числе подов веб-сервера получается около 860 соединений. Это число не должно превышать лимит клиентских соединений PgBouncer (`max_client_conn`), а при подключении напрямую — значение параметра PostgreSQL `max_connections`.

Webim.Ru рекомендует настроить автоматическое резервирование (backup) своей базы данных. Для высоконагруженных систем для повышения аптайма желательно настроить репликацию на второй сервер СУБД.

## Колоночная СУБД {: #clickhouse }

Требования к **колоночной** СУБД при размещении сервиса на мощностях заказчика (hosted installation):

| Параметр                    | Значение                                                   | Особенности                                                                                                                                                            |
|-----------------------------|------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| СУБД                        | ClickHouse 26.3                                            | Минимальная версия — ClickHouse 24.4.                                                                                                                                  |
| Конфигурация                | Кластер с сервисом координации                             | Требуется даже для одного сервера, см. ниже.                                                                                                                           |
| Пользователи СУБД           | default                                                    | Пользователь default по умолчанию обладает root-правами. Можно использовать его с полным доступом или создать нового пользователя с полным доступом.                   |
| TCP/IP-порт                 | 9000 (native), 8123 (HTTP); при шифровании TLS — 9440 и 8443 | **Webim Server** использует оба протокола, поэтому ClickHouse должен принимать подключения на обоих портах. Можно использовать другие порты. Потребуется перенастройка СУБД, **Webim Server** и брандмауэров. |
| Объём места под БД          | Зависит от интенсивности работы и срока хранения данных    | См. [Примеры типовых конфигураций](https://webim.ru/kb/11.0/devops/sys-reqs-for-server/sys-reqs-server-hw.html#examples).                                                                                                    |
| Прочие аппаратные параметры | Зависят от нагрузки                                        | См. [Требования к аппаратному обеспечению сервера](https://webim.ru/kb/11.0/devops/sys-reqs-for-server/sys-reqs-server-hw.html).                                                                                             |

Таблицы статистики используют движки `ReplicatedReplacingMergeTree` и `Distributed`. Поэтому каждый сервер ClickHouse, даже единственный, должен быть настроен так:

  * в разделе `<remote_servers>` описан кластер; имя кластера указывается в параметре `STATS_CLUSTER_NAME` **Webim Server**;

  * подключён сервис координации ClickHouse Keeper или ZooKeeper (раздел `<zookeeper>`); на одном сервере можно использовать встроенный ClickHouse Keeper (раздел `<keeper_server>`);

  * заданы макросы `<cluster>`, `<shard>` и `<replica>`; у разных шардов значения макроса `<shard>` должны различаться.

Без сервиса координации и макросов **Webim Server** не сможет создать таблицы статистики. Базы данных и таблицы создаются автоматически при развёртывании **Webim Server**.

## Объектное хранилище {: #s3 }

Требования к S3-совместимому объектному хранилищу при размещении сервиса на мощностях заказчика (hosted installation):

| Параметр           | Значение                                                  | Особенности                                                                                          |
|--------------------|-----------------------------------------------------------|------------------------------------------------------------------------------------------------------|
| Хранилище          | S3-совместимое API                                        | Например, MinIO из комплекта поставки или управляемое объектное хранилище.                           |
| Бакеты             | `static`, `public` и `bucket` (имена по умолчанию)        | Бакеты можно разместить в одном хранилище или в разных.                                              |
| Адресация объектов | Path-style                                                | Ссылки на объекты имеют вид `https://<доменное имя хранилища>/<бакет>/<объект>`.                     |
| Учётные данные     | Ключ доступа (access key) и секретный ключ                | Нужны права на чтение и запись во всех бакетах.                                                      |
| Объём места        | Зависит от объёма передаваемых файлов и срока их хранения | См. [Примеры типовых конфигураций](https://webim.ru/kb/11.0/devops/sys-reqs-for-server/sys-reqs-server-hw.html#examples).                                  |

Назначение бакетов:

  * `static` — статические файлы веб-интерфейсов (JavaScript, CSS и т. д.), доступные для анонимного чтения;

  * `public` — аватары, логотипы и другие общедоступные файлы, доступные для анонимного чтения;

  * `bucket` — файлы чатов. Бакет закрыт: файлы выдаются по временным подписанным ссылкам (presigned URL).

**Webim Server** обращается к хранилищу по внутреннему адресу, а браузеры посетителей и операторов — по внешнему адресу HTTPS. Поэтому внешний адрес хранилища должен быть доступен из сети, в которой используется чат (см. [Требования к доменному имени](https://webim.ru/kb/11.0/devops/sys-reqs-for-server/sys-reqs-server-nw.html#domain-name-requirements)).

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

## Резидентная СУБД {: #redis }

Требования к **резидентной** СУБД при размещении сервиса на мощностях заказчика (hosted installation):

| Параметр                      | Значение                                                                             | Особенности                                                               |
|-------------------------------|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
| СУБД                          | Valkey 9.0 или Redis 7.4                                                             | Основной вариант — Valkey.                                                |
| Пользователи СУБД             | default                                                                              | Пользователь СУБД по умолчанию. Рекомендуем защитить подключение паролем. |
| TCP/IP-порт                   | 6379                                                                                 | Порт по умолчанию.                                                        |
| Отказоустойчивость            | Valkey Sentinel или Redis Sentinel                                                   | Поддерживается подключение через Sentinel.                                |
| Шифрование                    | TLS                                                                                  | Поддерживается.                                                           |
| Уведомления о событиях ключей | Параметр `notify-keyspace-events` с флагами `K`, `E` и `x`, например `KEx` или `AKE` | См. ниже.                                                                 |
| Объём места под БД            | Не менее 4 ГБ ОЗУ и 10 ГБ дискового пространства на экземпляр                        | См. [Примеры типовых конфигураций](https://webim.ru/kb/11.0/devops/sys-reqs-for-server/sys-reqs-server-hw.html#examples).       |

Обработчик отложенных задач отслеживает истечение срока ключей в резидентной СУБД. При запуске он сам включает нужные уведомления командой `CONFIG SET notify-keyspace-events`. Если команда `CONFIG` недоступна, например в управляемом сервисе Valkey или Redis, задайте параметр `notify-keyspace-events` в настройках сервиса заранее. Иначе отложенные задачи, например тайм-ауты чатов и контроль SLA, будут выполняться с задержкой — только при периодической проверке просроченных задач.

## Поисковый движок {: #search }

Требования к поисковой системе при размещении сервиса на мощностях заказчика (hosted installation):

| Параметр                    | Значение                                    | Особенности                                                                                                                                                                                                                                                    |
|-----------------------------|---------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| СУБД                        | Elasticsearch 8.x или OpenSearch 2.x        | Тестирование проводится на Elasticsearch 8.7.1.                                                                                                                                                                                                                |
| Пользователи СУБД           | `elastic` (или пользователь **OpenSearch**) | У встроенного пользователя **Elasticsearch** по умолчанию полный доступ. Для **OpenSearch** создайте пользователя с полными правами на индексы.                                                                                                                 |
| TCP/IP-порт                 | 9200                                        | Можно использовать любой другой порт. Потребуется перенастройка СУБД, **Webim Server** и брандмауэров. При подключении к кластеру из нескольких узлов порт у всех узлов должен быть одинаковым.                                                                  |
| Шифрование                  | TLS                                         | Поддерживается, в том числе с сертификатом корпоративного УЦ.                                                                                                                                                                                                  |
| Объём места под БД          | Не менее чем в четыре раза больше объёма используемой оперативной памяти | См. рекомендации для [**Elasticsearch**](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-hardware-prereq.html) или [**OpenSearch**](https://docs.opensearch.org/latest/install-and-configure/install-opensearch/index/).                          |
| Прочие аппаратные параметры | Зависят от нагрузки                         | См. [Требования к аппаратному обеспечению сервера](https://webim.ru/kb/11.0/devops/sys-reqs-for-server/sys-reqs-server-hw.html).                                                                                                                                                                                     |

На серверах Elasticsearch и OpenSearch параметр ядра `vm.max_map_count` должен быть не меньше 262144, иначе поисковый движок не запустится.

## Брокер сообщений {: #kafka }

Требования к брокеру сообщений при размещении сервиса на мощностях заказчика (hosted installation):

| Параметр                    | Значение                                                  | Особенности                                                                                     |
|-----------------------------|-----------------------------------------------------------|-------------------------------------------------------------------------------------------------|
| Брокер                      | Apache Kafka 3.9.0                                        |                                                                                                 |
| Топики                      | Создаются при развёртывании **Webim Server**              | Топики создаёт служебное задание `kafka-setup`; автоматическое создание топиков на брокере не требуется. |
| TCP/IP-порт                 | 9092                                                      | Порт брокера по умолчанию.                                                                      |
| Аутентификация и шифрование | SASL, TLS                                                 | См. [Требования к программному обеспечению](https://webim.ru/kb/11.0/devops/sys-reqs-for-server/sys-reqs-server-sw.html#kafka).                       |
| Объём места                 | Зависит от интенсивности работы и срока хранения сообщений | См. [Примеры типовых конфигураций](https://webim.ru/kb/11.0/devops/sys-reqs-for-server/sys-reqs-server-hw.html#examples).                             |

---

Источник: https://webim.ru/kb/11.0/devops/sys-reqs-for-server/sys-reqs-server-db.html
