search string side menu

ELMA365 On-Premises > ELMA365 On-Premises Standard / Изменение параметров ELMA365 Standard

Изменение параметров ELMA365 Standard

В процессе эксплуатации ELMA365 Standard (KinD) может потребоваться перенастроить компоненты приложения, например, отредактировать настройки сервисов — изменить настройки почтового сервера, изменить параметры подключения к приложению, настроить дополнительные опции и т. д.

Процесс изменения параметров приложения состоит из двух этапов:

  1. Внесения изменений в конфигурационный файл config-elma365.txt.
  2. Запуск скрипта установки с ключом --upgrade для применения новых параметров.

change-parameters-1

Параметры конфигурационного файла config-elma365.txt

Конфигурационный файл config-elma365.txt создаётся в текущем каталоге при первом запуске скрипта установки.

Параметры в конфигурационном файле config-elma365.txt разбиты на две группы:

  • Основные — параметры минимально необходимые для быстрого разворачивания приложения ELMA365 Standard в Kubernetes-in‑Docker (KinD).
  • Дополнительные — параметры, описывающие взаимодействие ELMA365 Standard (KinD) с внешними системами хранения данных, режимы и протоколы работы приложения.

начало внимание

Необдуманное изменение дополнительных параметров в конфигурационном файле config-elma365.txt может привести к потере работоспособности приложения ELMA365 Standard (KinD). Перед внесением изменений в этот файл рекомендуется создать его резервную копию.

конец внимание

Описание параметров конфигурационного файла config-elma365.txt

Наименование

Описание

Основные параметры установки

ELMA365_HOST

IP- или URL-адрес, по которому будет доступна система.

При установке системы с указанием доменного имени необходимо в DNS‑сервер внести соответствующую А-запись: "myelma365.com" <-> "IP адрес машины с ELMA365". Обратите внимание, имя домена вводится строчными буквами.

Важно: если невозможно настроить разрешение доменного имени, необходимо включить дополнительный параметр установки ELMA365_HOSTALIASES_IP.

Реквизиты для входа супервизора:

ELMA365_EMAIL

Указывается email-адрес, который будет являться логином для входа главного администратора.

Важно: используется при создании компании в момент установки ELMA365. Изменение ELMA365_EMAIL делает невозможным применение новых параметров или обновление ELMA365.

Значение по умолчанию: admin@mail.com.

ELMA365_PASSWORD

Пароль для входа главного администратора.

Важно: используется при создании компании в момент установки ELMA365. Параметр можно изменить через веб-интерфейс, если указан email‑адрес администратора системы.

Язык интерфейса системы:

ELMA365_LANGUAGE

Язык интерфейса системы.

Доступные варианты: "ru-RU", "en-US", "sk-SK".

Редакция системы:


ELMA365_EDITION

Доступные варианты: "standard", "enterprise".

В данной поставке выбор редакции "enterprise" предназначен для лицензирования и не включает дополнения, расширяющие функциональные и инфраструктурные возможности приложения ELMA365.

Настройка соединения с SMTP-сервером (это соединение используется для отправки приглашений новым пользователям, восстановления паролей, отправки уведомлений о новых задачах):

ELMA365_SMTP_HOST

IP или URL-адрес для подключения к SMTP-серверу.

ELMA365_SMTP_PORT

Порт для подключения к SMTP-серверу.

ELMA365_SMTP_FROM

Email-адрес (наименование почтового ящика), от имени которого происходит отправка сообщений.

ELMA365_SMTP_USER

Логин пользователя для подключения к SMTP-серверу.

ELMA365_SMTP_PASSWORD

Пароль пользователя для подключения к SMTP-серверу.

ELMA365_SMTP_TLS

Использование TLS-шифрования SMTP-сервером.

Доступные варианты: true, false.

Настройка TLS-шифрования:

ELMA365_TLS_CRT

Путь до SSL-сертификата (для включения поддержки HTTPS). SSL-сертификат должен быть fullchain.

Важно: если в параметре ELMA365_HOST указан IP-адрес, параметр ELMA365_TLS_CRT игнорируется.

ELMA365_TLS_KEY

Путь до закрытого ключа (для включения поддержки HTTPS).

Важно: если в параметре ELMA365_HOST указан IP-адрес, параметр ELMA365_TLS_KEY игнорируется.

ELMA365_TLS_CA

Путь к сертификату корневого CA при использовании самоподписанного сертификата.

Важно: если в параметре ELMA365_HOST указан IP-адреса, параметр ELMA365_TLS_CA игнорируется.

Дополнительные параметры установки

Настройки подключения к внешним базам данных:

ELMA365_DB_PSQL

Строка подключения к PostgreSQL для операций записи и чтения.

Формат: postgresql://user:password@hostname:port/databaseName. Где:

  • user — имя пользователя PostgreSQL с правами доступа к базе данных;
  • password — пароль для пользователя PostgreSQL;
  • hostname — IP или доменное имя сервера PostgreSQL;
  • port — порт для подключения к PostgreSQL, стандартный порт: 5432;
  • databaseName — наименование базы данных;

О необходимой конфигурации PostgreSQL читайте в разделе «Подготовка внешних баз данных».

ELMA365_DB_PSQL_RO

Строка подключения к PostgreSQL для операций чтения.

Формат: postgresql://user:password@hostname:port/databaseName. Где:

  • user — имя пользователя PostgreSQL с правами доступа к базе данных;
  • password — пароль для пользователя PostgreSQL;
  • hostname — IP или доменное имя сервера PostgreSQL;
  • port — порт для подключения к PostgreSQL, стандартный порт: 5432;
  • databaseName — наименование базы данных;

О необходимой конфигурации PostgreSQL читайте в разделе «Подготовка внешних баз данных».

ELMA365_DB_MONGO

Строка подключения к MongoDB.

Формат: mongodb://user:password@hostname:port/databaseName. Где:

  • user — имя пользователя MongoDB с правами доступа к базе данных;
  • password — пароль для пользователя MongoDB;
  • hostname — IP или доменное имя сервера MongoDB;
  • port — порт для подключения к MongoDB, стандартный порт: 27017;
  • databaseName — наименование базы данных;

О необходимой конфигурации MongoDB читайте в разделе «Подготовка внешних баз данных».

ELMA365_DB_REDIS

Строка подключения к Redis.

Формат: redis://user:password@hostname:port/databaseName. Где:

  • user — имя пользователя Redis с правами доступа к базе данных;
  • password — пароль для пользователя Redis;
  • hostname — IP или доменное имя сервера Redis;
  • port — порт для подключения к Redis, стандартный порт: 6379;
  • databaseName — наименование базы данных;

О необходимой конфигурации Redis читайте в разделе «Подготовка внешних баз данных».

ELMA365_DB_AMQP

Строка подключения к RabbitMQ.

Формат: amqp://user:password@hostname:port/vhost. Где:

  • user — имя пользователя RabbitMQ с правами доступа к vhost;
  • password — пароль для пользователя RabbitMQ;
  • hostname — IP или доменное имя сервера RabbitMQ;
  • port — порт для подключения к RabbitMQ, стандартный порт: 5672;
  • databaseName — наименование базы данных;

О необходимой конфигурации RabbitMQ читайте в разделе «Подготовка внешних баз данных».

Настройки подключения к S3-хранилищу файлов:

ELMA365_DB_S3_ADDRESS

Строка подключения к S3.

Формат: hostname:port. Где:

  • hostname — IP или доменное имя сервера S3;
  • port — порт для подключения к S3, стандартный порт: 9000;

О необходимой конфигурации S3 читайте в разделе «Подготовка внешних баз данных».

ELMA365_DB_S3_BUCKET

Наименование бакета в S3.

Важно: если параметр проксирования подключения к внешнему S3 ELMA365_DB_S3_GATEWAY включён, наименование бакета должно соответствовать формату s3elma365*, а именно: s3elma365, s3elma365-dev или s3elma365-prod.

ELMA365_DB_S3_USER

Логин пользователя для подключения к серверу S3.

ELMA365_DB_S3_PASSWORD

Пароль пользователя для подключения к серверу S3.

ELMA365_DB_S3_REGION

Регион расположения сервера S3.

ELMA365_DB_S3_METHOD

Метод загрузки файлов в S3.

Доступные варианты: PUT.

ELMA365_DB_S3_SSL

Использование TLS-шифрования сервером S3.

Доступные варианты: true, false.

ELMA365_DB_S3_VIRTUAL_HOSTED_STYLE

Включение режима Virtual-hosted style для S3. В этом режиме имя бакета является частью имени домена в URL‑адресе, например: https://bucketname.example.ru/objectName.

Если параметр отключен, используется модель адресации Path‑style.

Значение по умолчанию: false.

Доступные варианты: true, false.

ELMA365_DB_S3_GATEWAY

Включение проксирования подключения к внешнему S3 (если сервер S3 изолирован в локальной сети).

Доступные варианты: true, false.

Важно: для проксирования подключения к внешнему S3, должны быть заполнены параметры подключения к серверу S3:

  • ELMA365_DB_S3_ADDRESS;
  • ELMA365_DB_S3_BUCKET;
  • ELMA365_DB_S3_USER;
  • ELMA365_DB_S3_PASSWORD;
  • ELMA365_DB_S3_REGION;
  • ELMA365_DB_S3_METHOD;
  • ELMA365_DB_S3_SSL.

ELMA365_DB_S3_DUMP_URL

Адрес сервера S3 для резервного копирования.

Формат:

  • для S3 в Kubernetes-кластере — http(s)://minio.<namespace>.svc.<cluster.local>;
  • для внешнего S3 — http(s)://example.ru:9000.

Настройка директорий для установки системы и создания резервных копий:

ELMA365_INSTALL_DIR

Путь к директории, в которую будет установлена система ELMA365 Standard (KinD).

Значение по умолчанию: "/opt/elma365/docker".

Важно: в случае установки приложения Docker через Snap, путь к директории установки необходимо сменить на /mnt или /media.

Пример: ELMA365_INSTALL_DIR="/mnt/elma365/docker".

ELMA365_BACKUP_DIR

Путь к директории, в которую будут сохраняться резервные копии системы ELMA365 Standard (KinD).

Значение по умолчанию: "/backup".

Настройки для приватного репозитория Docker-образов:

ELMA365_PRIVATE_REGISTRY_URL

Адрес приватного репозитория Docker‑образов.

Формат: hostname:port.

ELMA365_PRIVATE_REGISTRY_CREDS

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

Формат: user:password.

ELMA365_LOCAL_PRIVATE_REGISTRY_ENABLE

Включение создания локального приватного репозитория.

Важно: укажите IP‑адрес машины ELMA365 и порт из параметра ELMA365_PRIVATE_REGISTRY_URL.
Доступные варианты: true, false.

ELMA365_LOCAL_PRIVATE_REGISTRY_PORT

Порт для подключения к локальному репозиторию Docker-образов.

Значение по умолчанию: "5000".

ELMA365_LOCAL_PRIVATE_REGISTRY_DIR

Директория расположения локального репозитория Docker‑образов.

Значение по умолчанию: "/opt/elma365/registry".

Важно: в случае установки приложения Docker через Snap путь к директории расположения локального репозитория Docker-образов необходимо сменить на /mnt или /media.

Пример: ELMA365_PRIVATE_REGISTRY_DIR="/mnt/elma365/registry".

Настройка Docker:

ELMA365_DOCKER_NETWORK

Настройка для смены подсети 172.17.0.0/16, используемой Docker по умолчанию. Укажите диапазон IP-адресов.

Пример формата: 172.25.0.0/16.

ELMA365_DOCKER_SUBNET_SIZE

Важно: при указании подсети в параметре ELMA365_DOCKER_NETWORK обозначьте длину маски создаваемых сетей Docker.

ELMA365_DOCKER_MTU

Настройка MTU для Docker.

Проброс портов к БД внутри Docker:

ELMA365_PORT_FORWARD_PSQL

Проброс локального порта на порт в поде к БД Postgres, указывается номер локального порта.

ELMA365_PORT_FORWARD_MONGO

Проброс локального порта на порт в поде к БД MongoDB, указывается номер локального порта.

ELMA365_PORT_FORWARD_AMQP

Проброс локального порта на Web порт в поде к БД RabbitMQ, указывается номер локального порта.

ELMA365_PORT_FORWARD_REDIS

Проброс локального порта на порт в поде к БД Redis, указывается номер локального порта.

ELMA365_PORT_FORWARD_S3

Проброс локального порта на Web-порт в поде к хранилищу данных MinIO S3, указывается номер локального порта.

Настройка подключения ELMA365 к proxy-серверу:

HTTPS_PROXY

URL подключения к proxy-серверу для протокола https.

Формат: http://proxy_user:proxy_pass@host:port/.

где:

  • proxy_user — имя пользователя для авторизации на proxy‑сервере;
  • proxy_pass — пароль для авторизации на proxy‑сервере;
  • host — хост используемого proxy‑сервера;
  • port — порт используемого proxy‑сервера.

HTTP_PROXY

URL подключения к proxy-серверу для протокола http.

Формат: http://proxy_user:proxy_pass@host:port/.

где:

  • proxy_user — имя пользователя для авторизации на proxy‑сервере;
  • proxy_pass — пароль для авторизации на proxy‑сервере;
  • host — хост используемого proxy‑сервера;
  • port — порт используемого proxy‑сервера.

NO_PROXY

Указываются сетевые адреса, диапазоны сетевых адресов и домены, которые следует исключить из использования proxy.

Значение по умолчанию: localhost,example.com,127.0.0.0/8,10.0.0.0/8,169.254.0.0/16, 192.168.0.0/16,100.64.0.0/10,172.16.0.0/12,cluster.local,linkerd.svc.

https_proxy

URL подключения к proxy-серверу для протокола https.

Формат: http://proxy_user:proxy_pass@host:port/.

где:

  • proxy_user — имя пользователя для авторизации на proxy‑сервере;
  • proxy_pass — пароль для авторизации на proxy‑сервере;
  • host — хост используемого proxy‑сервера;
  • port — порт используемого proxy‑сервера.

http_proxy

URL подключения к proxy-серверу для протокола http.

Формат: http://proxy_user:proxy_pass@host:port/.

где:

  • proxy_user — имя пользователя для авторизации на proxy‑сервере;
  • proxy_pass — пароль для авторизации на proxy‑сервере;
  • host — хост используемого proxy‑сервера;
  • port — порт используемого proxy‑сервера.

no_proxy

Указываются сетевые адреса, диапазоны сетевых адресов и домены, которые следует исключить из использования прокси.

Значение по умолчанию: localhost,example.com,127.0.0.0/8,10.0.0.0/8,169.254.0.0/16, 192.168.0.0/16,100.64.0.0/10,172.16.0.0/12,cluster.local,linkerd.svc

Параметры, не имеющие группы:

ELMA365_HOSTALIASES_IP

Задаёт HOSTALIASES для доменного имени, указанного в параметре ELMA365_HOST, связывая его с указанным IP‑адресом (IP‑адрес машины с ELMA365).

Важно: эту настройку следует использовать при установке системы с указанием доменного имени, если невозможно создать в DNS‑сервере соответствующей ААА записи ("myelma365.com" <-> "IP адрес машины с ELMA365") для доменного имени, указанного в ELMA365_HOST.

По доменному имени, указанному в ELMA365_HOST, проверяется возможность соединения из среды Kubernetes для корректной работы сервиса diskjockey. Отсутствие разрешения доменного имени, указанного в ELMA365_HOST, приведёт к сбою установки ELMA365 Standard (KinD).

ELMA365_PROXY_WITH_SSL

Режим работы сервера ELMA365 за прокси HTTPS.

Доступные варианты: true, false.

ELMA365_DEBUG

Режим отладки платформы ELMA365

Доступные варианты: true, false.

ELMA365_EXTRA_ARGS

Включение дополнительных параметров. Указывать необходимо в формате: "exampleArgs1:'111' exampleArgs2:'true' exampleArgs3:22m".

Например, для увеличения допустимого объёма загружаемых в систему файлов применяется ELMA365_EXTRA_ARGS="maxFileSizeMB":"400".

 
Необходимость включения дополнительных параметров и их список уточняйте у менеджеров ELMA365.

ELMA365_ENABLED_FEATUREFLAGS

Включение дополнительных фича-флагов. Указывать необходимо в формате: "exampleFlags1","exampleFlags2".

 
Необходимость включения фича-флагов и их список уточняйте у менеджеров ELMA365.

ELMA365_AUDIT

Подключить сервис Аудит безопасности.

Доступные варианты: true, false.

После установки модуля сервис Аудит безопасности внутри кластера будет доступен по URL‑адресу http://audit.audit.svc:3000.

ELMA365_AUDIT_PSQL_URL

Строка подключения к PostgreSQL для операций записи и чтения.

Параметр указывается, если в ELMA365_DB_PSQL задана строка подключения к PostgreSQL. О необходимой конфигурации PostgreSQL читайте в статье «Подготовка внешних баз данных».

Если параметр не настроен, используется встроенная база данных PostgreSQL.

Формат: postgresql://user:password@hostname:port/databaseName, где

user — имя пользователя PostgreSQL с правами доступа к базе данных;

password — пароль для пользователя PostgreSQL;

hostname — IP или доменное имя сервера PostgreSQL;

port — порт для подключения к PostgreSQL, стандартный порт: 5432;

databaseName — наименование базы данных.

Раскомментируйте и внесите правки в нужные параметры конфигурационного файла config-elma365.txt, сохраните изменения.

Применение новых параметров для ELMA365 Standard

  1. Для внесения изменений в параметры приложения ELMA365 Standard (KinD) выполните обновление приложения с помощью скрипта установки (elma365-docker.sh), запущенного с ключом --upgrade.

Начало внимание

Параметры ELMA365_EMAIL и ELMA365_PASSWORD используются только при первичной установке системы, далее их изменения игнорируются скриптом.

Конец внимание

  1. Внесите изменения в параметры приложения ELMA365 Standard:

sudo ./elma365-docker.sh --upgrade

sudo ./elma365-docker.sh --offline --upgrade

  1. После запуска скрипт установки определит версию установленной версии ELMA365 Standard (KinD) и предложит перейти на новую версию.

начало внимание

В случае простого применения новых параметров, версии ELMA365 Standard (KinD) должны совпадать.

конец внимание

Согласитесь с переходом на новую версию, прописав [Y]. Указание любого другого символа прервёт обновление приложения.

change-parameters-2

  1. Следующим шагом в скрипте установки вы увидите оповещение о необходимости сделать резервную копию перед обновлением ELMA365 Standard (KinD).

Для продолжения обновления приложения введите один из вариантов:

  • [B] — создание резервной копии (Backup);
  • [С] — пропустить создание резервной копии (Continue);
  • [E] — прервать обновление приложения (Exit).
  1. Создайте резервную копию и продолжите обновление ELMA365 Standard (KinD), указав для этого [B] или нажав клавишу ENTER.

Скрипт установки выполнит резервное копирование и приступит к обновлению приложения.

change-parameters-3

  1. Дождитесь окончания обновления приложения. Вы увидите сообщение “Upgrade ELMA365 application successful”.

Обновление параметров ELMA365 Standard (KinD) завершено.

install-kind-offline.html version-update-standard.html