Переменные окружения

Подключение к базе данных

DB_URL - Содержит строку в формате URI для подключения к базе данных PostgreSQL.

# Подключение к базе данных
DB_URL=postgresql://postgres:changeme@127.0.0.1:5432/planr

Подключение к брокеру сообщений

MB_URL - Содержит строку в формате URI для подключения к брокеру сообщений RabbitMQ.

# Подключение к брокеру сообщений
MB_URL=amqp://planr:planr@127.0.0.1/planr

Шифрация и подпись данных

Конфиденциальные данные сохраняемые системой в базе данных или в кеш данных шифруются по алгоритму AES-512. Шифруются:

  • пароли пользователей;
  • настройки подключения к почтовым серверам;
  • настройки подключения к хранилищам файлов;
  • настройки подключения к Active Directory;

SECRET_SALT - Инициализирующий вектор в виде строки передаваемые в алгоритм шифрации.

SECRET_SALT=VS29L0duMK0DTf6wrqfOvg2h0nHOsjBWJdumehfI

SECRET_KEY - Ключ в виде строки передаваемые в алгоритм шифрации

SECRET_KEY=0nveAxy5GiIiFFDPstfe7jFlCnb0DL6zJoAJCTy9

Внимание! Переменные SECRET_SALT и SECRET_KEY должны быть изменены перед первым запуском системы и не должны изменяться в процессе её использования.

JWT_SECRET - Строка для подписи JWT токена аутентификации.

JWT_SECRET=0ehUQ3RXFiq19827BywlAt8ZifiVE1Dr

Внимание! Переменная JWT_SECRET должна быть изменена перед первым запуском системы.

JWT_EXPIRESIN - Время жизни JWT токена аутентификации. По умолчанию 7 дней.

JWT_EXPIRESIN=7d

FILE_TOKEN_SECRET - Строка для подписи JWT токена для выгрузки файлов из системы. В целях безопасности, для того чтобы пользователь мог выгрузить только те файлы которые он запросил в рамках какой либо операции, например при экспорте графика, пользователю отправляется токен для выгрузки файла. По полученному токену в рамках его жизни указанному в переменной FILE_TOKEN_EXPIRESIN пользователь может скачать созданный файл.

FILE_TOKEN_SECRET=qxowf545VL7hivuDL2XF5TdQz8pAp95o

Внимание! Переменная FILE_TOKEN_SECRET должна быть изменена перед первым запуском системы.

FILE_TOKEN_EXPIRESIN - Время жизни JWT токена для выгрузки файлов из системы. По умолчанию 1 день.

FILE_TOKEN_EXPIRESIN=1d

Аутентификация

LOCAL_AUTH_ENABLED - Логическая переменная позволяет включить или выключить локальную аутентификацию пользователей.

Допустимые значения:

  • true - локальная аутентификация включена (умолчанию)
  • false - локальная аутентификация выключена
# включить локальную аутентификацию пользователей
LOCAL_AUTH_ENABLED=true

LDAP_AUTH_ENABLED - Логическая переменная позволяет включить или выключить аутентификацию пользователей с помощью LDAP (Active Directory).

Допустимые значения:

  • true - аутентификация включена
  • false - аутентификация выключена (умолчанию)
# включить аутентификацию пользователей через LDAP (Active Directory)
LDAP_AUTH_ENABLED=false

KERBEROS_ENABLED - Логическая переменная позволяет включить или выключить аутентификацию пользователей с помощью Kerberos.

Допустимые значения:

  • true - аутентификация включена
  • false - аутентификация выключена (умолчанию)
# включить аутентификацию пользователей через Kerberos
KERBEROS_ENABLED=false

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

Допустимые значения:

  • true - аутентификация включена
  • false - аутентификация выключена (умолчанию)
# включить аутентификацию с использованием токенов
API_KEY_AUTH_ENABLED=false

Аутентификации с использованием OpenID

OPENID_ISSUER=https://oidc.domain.com/auth/realms/Development
OPENID_AUTHORIZATIONURL=https://oidc.domain.com/auth/realms/Development/protocol/openid-connect/auth
OPENID_TOKENURL=https://oidc.domain.com/auth/realms/Development/protocol/openid-connect/token
OPENID_USERINFOURL=https://oidc.domain.com/auth/realms/Development/protocol/openid-connect/userinfo
OPENID_CLIENTID=planrclient
OPENID_CLIENTSECRET=lzkfjhwo3587hnafh
OPENID_CALLBACKURL=http://localhost:3000/auth/openid

Получение дистрибутива.