Настроить переменные окружения ELMA Cortex

Перед установкой ELMA Cortex задайте значения переменных окружения.

Для этого откройте файл переменных окружения:

  1. Перейдите к загруженным установочным файлам ELMA Cortex.
  2. Откройте папку, соответствующую вашему способу установки — docker-compose или docker-swarm.
  3. Выберите файл .env.

Параметры в файле позволяют настроить:

Параметры, которые вы задаёте, используются при установке ELMA Cortex. Если вы изменяете их значения позже, примените их с помощью скрипта.

Название проекта

Если вам нужно запускать несколько изолированных копий ELMA Cortex на одном хосте, для них нужно задать уникальные названия проектов. Они используются:

  • при использовании Docker Compose — название применяется в качестве значения для параметра COMPOSE_PROJECT_NAME и влияет на имена контейнеров;
  • при использовании Docker Swarm — название становится префиксом в именах сервисов.

По умолчанию установлено значение elma-cortex.

Пользовательское название проекта можно задать двумя способами:

  1. В файле переменных окружения .env — способ удобен, если для каждой копии ELMA Cortex создана отдельная папка с установочными файлами, и скрипты вызываются из неё.

Для указания названия измените значение переменной PROJECT_NAME.

После этого скрипты установки, диагностики и удаления нужно запускать без указания названия проекта. Оно подставится из файла .env.

  1. В скрипте установки — способ позволяет при последующем вызове скриптов указывать определённый проект.

Для указания названия при запуске скрипта установки используйте параметр --project-name. Подробнее читайте в статьях об установке ELMA Cortex.

Тогда при вызове скриптов диагностики и удаления всегда нужно указывать название проекта в этом параметре.

Адрес сервера ELMA Cortex

Заполните переменные:

  • ELMA_CORTEX_HOSTNAME — имя хоста вашего сервера;
  • ELMA_CORTEX_PORT — HTTPS-порт. По умолчанию используется порт 443.

Настройки TLS

В зависимости от используемого удостоверяющего центра установите режим управления TLS-сертификатами и задайте параметры их использования.

Подробнее читайте в статье о настройке TLS-сертификатов для ELMA Cortex.

Авторизация

Выберите способ входа администратора в ELMA Cortex. По умолчанию при открытии ELMA Cortex пользователь сразу авторизован. Для повышения безопасности настройте вход с помощью ELMA365 или ELMA Bot.

Подробнее читайте в статье о настройке авторизации в ELMA Cortex.

Использование внешних сервисов

Если вы используете внешние сервисы, настроенные в вашей инфраструктуре, вместо тех, которые поставляются вместе с ELMA Cortex, отключите использование встроенных сервисов. Для этого в файле .env установите для переменной с названием сервиса значение false:

CADDY_ENABLED=false
REDIS_ENABLED=false
MONGO_ENABLED=false
RABBIT_ENABLED=false
MINIO_ENABLED=false
QDRANT_ENABLED=false
PHOENIX_ENABLED=false

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

Настройки производительности

При масштабировании ELMA Cortex для повышения пропускной способности настройте в файле .env параметры:

  • количество worker HTTP-сервера. Обычно равно числу ядер процессора. По умолчанию 4:

UVICORN_WORKERS=8

  • количество worker для выполнения фоновых задач. По умолчанию 4:

CELERY_WORKER_CONCURRENCY=8

  • включение автоматического масштабирования пулов worker — расширенная настройка, которая позволяет определять параметр CELERY_WORKER_CONCURRENCY отдельно для определённых пулов worker:

CELERY_START_WORKER_MAIN=--autoscale=2,4 -Q celery.gamma.tasks.ingestion,celery.gamma.tasks.search.run,celery.gamma.tasks.agent.run
CELERY_START_WORKER_FAST=--autoscale=4,8 -Q celery.gamma.tasks.search.run,celery.gamma.tasks.agent.run

Применение значений для переменных окружения

Заданные настройки автоматически применятся при установке ELMA Cortex.

Если вы обновляете параметры в файле .env после установки, для их применения используйте команду:

./install.sh