Файлы и S3-хранилище
Подключение к S3-совместимому хранилищу (например, MinIO), бакеты, параметры клиента хранилища и ограничения размера файлов и изображений. В хранилище Webim хранит файлы диалогов, аватары, логотипы и статические файлы интерфейса.
Как изменить параметры и применить изменения, описано в разделе Параметры .env.
Подключение к хранилищу
| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
S3_ENDPOINT_URL |
URL | Не задано | Да | Адрес S3-хранилища, по которому к нему обращаются серверы Webim, например http://minio.example.local:9000. Обычно это внутренний адрес: браузеры получают файлы по адресу из S3_BASE_URL. |
S3_ACCESS_KEY_ID |
Строка | Не задано | Да | Идентификатор ключа доступа к хранилищу. |
S3_SECRET_ACCESS_KEY |
Строка | Не задано | Да | Секретный ключ доступа к хранилищу. |
S3_REGION_NAME |
Строка | Не задано | Да | Регион хранилища, например us-east-1. Для MinIO укажите регион из настроек MinIO; по умолчанию MinIO использует us-east-1. |
S3_USE_HTTPS |
Логический | По схеме S3_ENDPOINT_URL |
Нет | Подключение к хранилищу по HTTPS. Значение должно соответствовать схеме S3_ENDPOINT_URL: True для https://, False для http://. Если параметр не задан, значение определяется по схеме S3_ENDPOINT_URL.Сертификат хранилища проверяется по набору сертификатов из HTTP_CA_BUNDLE (см. Почта и внешние сервисы). |
S3_BASE_URL |
Строка | /s |
Нет | Адрес, по которому браузеры и внешние сервисы получают файлы из хранилища. По умолчанию это путь /s на домене Webim: веб-сервер nginx передаёт запросы к нему в хранилище. Если хранилище доступно напрямую, укажите полный адрес, например https://files.example.local.Значение должно начинаться с / или https://, иначе Webim не запускается. Встраивается в интерфейс при сборке, поэтому после изменения требуется повторное развёртывание Webim. |
Бакеты
| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
S3_PRIVATE_BUCKET_NAME |
Строка | bucket |
Нет | Бакет для файлов диалогов, временных частей загружаемых файлов и стикеров. Доступ к бакету без аутентификации не нужен. |
S3_PUBLIC_BUCKET_NAME |
Строка | public |
Нет | Бакет для общедоступных файлов: аватаров, логотипов, изображений кнопок и аватаров в приглашениях. Файлы выдаются по постоянным ссылкам без подписи, поэтому бакет должен быть доступен для чтения без аутентификации. |
S3_STATIC_BUCKET_NAME |
Строка | Пусто | Нет | Бакет для статических файлов интерфейса: JavaScript, CSS и изображений. Файлы хранятся в каталоге с именем версии сборки, поэтому при заданном бакете параметр VERSION не должен быть пустым.Пустое значение — статические файлы выдаются сервером по адресу /static/. Этот режим предназначен для разработки; в рабочей установке задайте бакет.Встраивается в интерфейс при сборке, поэтому после изменения требуется повторное развёртывание Webim. |
S3_STATIC_CUSTOM_DOMAIN |
Строка | Пусто | Нет | Домен без схемы, с которого браузеры загружают статические файлы, например static.example.local (CDN или отдельный домен хранилища). Если домен задан, адрес статических файлов имеет вид https://<домен>/<версия>/. |
Отдельные параметры бакетов
По умолчанию все бакеты используют общие параметры подключения. Для отдельного бакета их можно переопределить, например чтобы хранить статические файлы в другом хранилище или выдавать общедоступные файлы с отдельного домена.
Имя параметра состоит из префикса S3_, имени бакета <B> и имени общего параметра. Вместо <B> подставьте STATIC, PUBLIC или PRIVATE: например, S3_STATIC_ENDPOINT_URL задаёт адрес хранилища для статических файлов.
| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
S3_<B>_ENDPOINT_URL |
URL | Значение S3_ENDPOINT_URL |
Нет | Адрес хранилища бакета. |
S3_<B>_BASE_URL |
Строка | Значение S3_BASE_URL |
Нет | Адрес, по которому браузеры получают файлы бакета. Значение должно начинаться с / или https://, иначе Webim не запускается. |
S3_<B>_ACCESS_KEY_ID |
Строка | Значение S3_ACCESS_KEY_ID |
Нет | Идентификатор ключа доступа к хранилищу бакета. |
S3_<B>_SECRET_ACCESS_KEY |
Строка | Значение S3_SECRET_ACCESS_KEY |
Нет | Секретный ключ доступа к хранилищу бакета. |
S3_<B>_REGION_NAME |
Строка | Значение S3_REGION_NAME |
Нет | Регион хранилища бакета. |
S3_<B>_USE_HTTPS |
Логический | Значение S3_USE_HTTPS |
Нет | Подключение к хранилищу бакета по HTTPS. Если не задан ни этот параметр, ни S3_USE_HTTPS, значение определяется по схеме адреса хранилища бакета. |
S3_<B>_DEDICATED_DOMAIN |
Логический | False |
Нет | Бакет выдаётся с отдельного домена, указанного в S3_<B>_BASE_URL: имя бакета не добавляется в путь ссылки. Например, ссылка имеет вид https://media.example.local/<ключ> вместо https://media.example.local/public/<ключ>. В этом случае прокси-сервер перед хранилищем должен сам добавлять имя бакета в путь запроса. |
Параметры клиента хранилища
| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
S3_MAX_POOL_CONNECTIONS |
Целое число | 10 |
Нет | Максимальное число соединений с хранилищем для одного бакета в одном процессе. |
S3_CONNECT_TIMEOUT_SECONDS |
Целое число, секунды | 5 |
Нет | Тайм-аут установки соединения с хранилищем. |
S3_READ_TIMEOUT_SECONDS |
Целое число, секунды | 30 |
Нет | Максимальная пауза при получении данных от хранилища. Ограничивает не всю операцию, а ожидание очередной порции данных. |
S3_KEEPALIVE_TIMEOUT_SECONDS |
Целое число, секунды | 12 |
Нет | Время, после которого неиспользуемое соединение с хранилищем закрывается. Должно быть меньше тайм-аута простоя соединений на стороне хранилища или прокси-сервера перед ним. |
S3_MAX_ATTEMPTS |
Целое число | 3 |
Нет | Общее число попыток выполнить запрос к хранилищу, включая первую. |
S3_FILE_URL_CACHE_TIMEOUT |
Целое число, секунды | 86400 |
Нет | Срок хранения в кэше адресов аватаров операторов, которые Webim передаёт в каналы Viber и LINE вместе с сообщениями. |
S3_ORPHAN_CHUNK_MAX_AGE_HOURS |
Целое число, часы | 24 |
Нет | Через сколько времени удаляются части файлов, загрузка которых не была завершена. Проверка выполняется раз в час. |
Ограничения файлов и изображений
| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
NGINX_UPLOAD_SIZE |
Целое число, мегабайты | 10 |
Нет | Максимальный размер загружаемого файла для всей установки. Ограничивает настройки Constance MAX_VISITOR_UPLOAD_FILE_SIZE и MAX_ROBOT_UPLOAD_FILE_SIZE (см. Файлы, почта и уведомления): действует меньшее из значений.Если значение не является целым числом, используется 10. |
PIL_MAX_IMAGE_PIXELS |
Целое число | 500000000 |
Нет | Максимальное число пикселей в изображениях, которые обрабатывает сервер: по умолчанию 500 млн, то есть примерно 22 360 × 22 360. Защищает сервер от изображений, распаковка которых требует слишком много памяти. Для аватаров, изображений кнопок и стикеров действуют более строгие настройки Constance AVATAR_MAX_PIXELS, BUTTON_MAX_PIXELS и STICKER_MAX_PIXELS. |
ATTACHMENT_PREVIEW_MAX_PIXELS |
Целое число | 50000000 |
Нет | Максимальное число пикселей в изображении из диалога, для которого строится превью: по умолчанию 50 млн. Для изображений крупнее превью не строится, вместо него выдаётся исходный файл. |
FFMPEG_CONVERT_TIMEOUT_SECONDS |
Целое число, секунды | 60 |
Нет | Максимальная длительность преобразования голосовых сообщений и аудиофайлов программой FFmpeg. |