Для Bpium

Настройка конфигурационного файла (config.env)

Bpium использует переменные окружения для хранения настроек. Если переменные окружения не заданы, то Bpium считывает их из файла config.env из папки приложения. Не указывайте в нём параметры, если их значения совпадают со значениями по умолчанию.

Системные настройки

DB_CONNECTION_STRING(обязательный)	string	Строка подключения к базе данных Бипиума. Формат: postgres://логин:пароль@адрес:порт/бд Пример:postgres://user:password@localhost:5432/bpium_db
SERIAL_NUMBER (обязательный)	string	Серийный номер продукта для активации. При его отсутствии будет доступна только одна учетная запись администратора.
PUBLIC_WWW_DIR	string	Относительный путь к директории публичных файлов. Используется для хранения дополнительных модулей. По умолчанию: www.

Безопасность

COOKIE_SECRET (обязательный)	string	Уникальная строка, используется для шифрования авторизованных сессий сотрудников. Придумайте строку.
SCRIPTS_TOKEN_SECRET(обязательный)	string	Уникальная строка, используется для формирования кода доступа к API без авторизации. Такой доступ использует сервер процессов. Придумайте строку.

Сетевые настройки и защищенный канал связи.

Для работы приложения и модуля телефонии

HOST	string	Адрес (домен) сервера для доступа из внешних ресурсов. Например, писем с приглашениями на регистрацию. Формат: domen.ru или 213.48.87.211
PORT_HTTP	int	Порт веб-сервера Bpium для HTTP. Если пуст, то сервер не принимает запросы по HTTP. По умолчанию: 80.
PORT_HTTPS	int	Порт веб-сервера Bpium для HTTPS. Используется для безопасного соединения при установленном флаге HTTPS. По умолчанию: 443.
HTTPS	bool	Использовать протокол HTTPS. Значения: true/false. По умолчанию: false.
HTTPS_FORCE	bool	Включить редирект с PORT_HTTP на PORT_HTTPS. Значения: true/false. По умолчанию: = HTTPS.
REDIRECT_CLIENT_TO_HTTPS	bool	Включить редирект с PORT_HTTP на PORT_HTTPS для выдачи приложения (при этом API продолжит работать без редиректа). Используется для принудительного переключения на HTTPS и для конфигурации, когда приложение стоит за веб-сервером обеспечивающим работу по HTTPS. Значения: true/false.
HTTPS_CERTIFICATE_PATH	string	Путь к файлу сертификата (crt).
HTTPS_KEY_PATH	string	Путь к файлу с ключом сертификата (key).

Настройка почтовой службы.

Для опциональной отправки приглашений сотрудникам на почту.

EMAIL_SERVICE	string	SMTP-сервис. Допустим один из указанных: https://github.com/nodemailer/nodemailer-wellknown
EMAIL_LOGIN	string	Адрес эл. почты для авторизации по SMTP
EMAIL_PASSWORD	string	Пароль от эл. почты

Настройка авторизации

Настройки для проверки пароля через сторонние сервисы, например Active Directory.

AUTH_TYPE	string	Тип авторизации: local — через Бипиум, ldap — через Active Directory. По умолчанию: local.
AUTH_LDAP_URL	string	URL-сервера. Пример: ldap://192.168.0.100 Подробнее о параметрах
AUTH_LDAP_BINDDN	string	Соединение к DN под администратором. Пример: CN=bpiumauth,CN=Users,DC=bpium
AUTH_LDAP_PASSWORD	string	Пароль доступа к AUTH_LDAP_BINDDN
AUTH_LDAP_SEARCHBASE	string	Базовый DN, в котором искать пользователей. Пример: CN=users,DC=bpium
AUTH_LDAP_SEARCHFIELD	string	Поле пользователя AD, в котором содержится логин. По умолчанию: cn.
AUTH_LDAP_SEARCHFILTER	string	Фильтр для поиска пользователя. По умолчанию: {{username}}.
AUTH_LDAP_SESSION_AGE	int	Время жизни авторизационной сессии с AD. Проверка пароля через LDAP операция долгая. Если проверять пароль каждый раз, это замедлит работу сотрудника. Поэтому Бипиум запоминает авторизацию на некое время и периодически перепроверяет её валидность. Если пользователя удалили в AD или изменили пароль, то он продолжит работать в Бипиуме в течение этого времени. Задается в миллисекундах. По умолчанию: 300000. (5 мин)

Настройка файлового сервера

Настройки для доступа на сервер Amazon S3 или локальный сервер-хранилище Bpium S3.

S3_LOCAL	bool	Использовать локальное хранилище или Amazon. true — локальное, false — Amazon. По умолчанию: true.
S3_HOST(обязательный)	string	Публичный (локальный) адрес хранилища, доступный с компьютеров сотрудников (localhost не допустим). Пример: files.company.ru или 211.129.48.11. Для Amazon формируется сам.
S3_PORT	int	Порт локального хранилища. По умолчанию: 2020. Для Amazon формируется сам.
S3_REGION	string	Регион дата-центра Amazon. Не используется для локального хранилища.
S3_BUCKET	string	Идентификатор хранилища. По умолчанию: storage.
S3_KEY(обязательный)	string	Публичный ключ доступа. Для Amazon предоставляется Amazon. Для локального хранилища — придумайте строку.
S3_SECRET(обязательный)	string	Секретный код доступа. Для Amazon предоставляется Amazon. Для локального хранилища — придумайте строку.
S3_HTTPS	bool	Использовать SSL-сертификаты и протокол HTTPS. Значения: true/false. По умолчанию: false.

Настройка сервера процессов

Настройка для запуска на исполнение процессов через сервер Bpium BPM.

BPM_HOST	string	Публичный/локальный адрес сервера. Пример: bpm.company.ru или 211.129.48.11.
BPM_PORT	int	Порт сервера процессов. По умолчанию: 2030.
BPM_SECRET	string	Секретный код доступа. Придумайте уникальную строку.
BPM_HTTPS	bool	Использовать SSL-сертификаты и протокол HTTPS. Значения: true/false. По умолчанию: false.

Лимитирование запросов к API

Для предотвращения перегрузки сервера

LIMIT_USER_REQUEST_DURATION	int	Интервал оценки числа запросов от одного аккаунта. В миллисекундах. По умолчанию: 30000.
LIMIT_USER_MAX_REQUESTS	int	Макс. число запросов от одного аккаунта за интервал. По умолчанию: 100.
LIMIT_IP_REQUEST_DURATION	int	Интервал оценки числа запросов с одного IP-адреса. В миллисекундах. По умолчанию: 30000.
LIMIT_IP_MAX_REQUESTS	int	Макс. число запросов с одного IP-адреса за интервал. По умолчанию: 1000.

Лимитирование запросов авторизации

Для предотвращения перебора паролей

LOGIN_LIMIT_MAX_AUTH_INTERVAL	int	Каждая неудачная попытка авторизации логарифмически увеличивает время до разрешенной следующей попытки. Макс. время блокировки попыток авторизации. В миллисекундах. По умолчанию: 300000. (5 мин)
LOGIN_LIMIT_MAX_AUTH_ATTEMPTS	int	Макс. число неудачных попыток авторизации под одним логином. По умолчанию: Infinity. (бесконечно)

Кеш

COMPANY_CACHE_LIFE_TIME	int	Бипиум кеширует служебные данные для увеличения производительности. Параметр определяет время жизни данных в кеше (в мс). 0 — не использовать. По умолчанию: не задан (бесконечно).

Лайфхаки

Любую переменную окружения можно передать с префиксом BPIUM_ или без префикса. Если указаны оба, то приоритет за тем что с префиксом. Примеры:

Без префикса:

PARAMETER_NAME_STRING=string_value

С префиксом:

BPIUM_PARAMETER_NAME_STRING=string_value

NODE_TLS_REJECT_UNAUTHORIZED	int	Параметр позволяет Бипиуму отправлять запросы (вебхуки) к системе с самоподписным сертификатом. Не безопасно! Для активации укажите: 0.