Бипуим: Документация
8-800-505-24-05Сайт Бипиум
  • 😎Отвечаем на ваши вопросы
  • 🎂Версии и обновления
  • ❗Обновление до версии 2.0
  • Документация
    • 🆕С чего начать
      • Регистрация и вход
      • Создаем каталоги и записи
      • Формируем отчёты
      • Настраиваем правовую политику
      • Применяем автоматизации
    • ⚙️Конструктор данных
      • Отделы
      • Каталоги
        • Редактирование структуры
        • Настройка отображения
        • Поиск и фильтрация
        • Импорт записей
          • 📗Импорт из Excel
        • Экспорт записей
        • Активность
      • Системные каталоги
        • Сотрудники
        • События
        • Внешние запросы
        • Сценарии
        • Процессы
        • Доступ к сервисам
        • Вебхуки
      • Виды
      • Записи
    • 📊Отчеты
      • Графики
    • 🔑Права
      • Правила
      • Привилегии
      • Правовые группы
      • Правовые виды
      • Права на поля
      • Комбинация прав
    • 🤖Автоматизации
      • События
        • Изменение данных
        • Внешние запросы
      • Сценарии
        • Компоненты
          • Начало процесса
          • Конец процесса
          • Таймер
          • Ошибка
          • Шлюз «ИЛИ» (условное ветвление)
          • Шлюз «И» (распараллеливание)
          • Получить запись
          • Найти записи
          • Изменить запись
          • Создать запись
          • Удалить запись
          • Структура каталога
          • Загрузить файл
          • Сгенерировать документ
          • Назначение переменных
          • Код (Javascript)
          • Веб-запрос
          • SQL-запрос
          • Конвертер
          • Парсер
          • Запуск процесса
          • Получение почты
          • Отправка почты
          • Соединяющая линия
          • Отправить сообщение
        • Переменные
        • Выражения
        • Входные и выходные параметры компонентов
        • Примеры настройки
          • Условие
          • Цикл
      • Ограничения
  • Лицензии
    • 🌐Тип лицензирования
  • Примеры
    • 🔑Права доступа к данным
    • 🤖Автоматизации
      • Выгрузка файлов на Яндекс Диск
      • Отправка на больничный
      • Автоматизация оплаты счетов
      • Создание наименований записей
      • Расчет скидок для клиентов
      • Запрет на создание дубликатов в каталоге
      • Автозаполнение данных по ИНН
      • Переброс данных между связанными каталогами
      • Очередь сценариев
      • Отслеживание заявок с сайта помощью UTM-меток
      • Просрочка задач по дедлайну
      • Реализация механизма согласования записей
      • Массовое изменение записей
      • Создание каталога для рассылки почты
      • Перенос данных между системами Бипиума
      • Импорт данных из Excel
      • Генерация счет-фактуры
      • Генерация excel-отчетов
      • Планировщик задач
      • Импорт банковских выписок
      • Производственный календарь
      • Складской учет
  • Интеграции
    • 🥂Методы интеграции
      • Интеграция данных
        • API
        • Вебхуки (webhooks)
      • Интеграция интерфейса
        • Веб-формы
        • Веб-расширения
      • Примеры интеграций
        • Тильда
          • Прием данных с формы Tilda
          • Интеграция веб-интерфейса в Tilda
        • Интеграция с сервисом «DaData»
        • Интеграция c «Единой информационной системой в сфере закупок»
        • Мессенджеры
          • Интеграция с Telegram-ботом
        • Почтовые сервисы
          • UniSender
          • MailChimp
        • Сервисы Google
          • Google Calendar
        • Телефония
          • Oktell
            • Панель телефонии Oktell
            • Компонент Bpium в Oktell
        • 1C
    • 🔌API
      • Данные
        • Каталоги (Catalogs)
        • Записи (Records)
        • Связи (Relations)
        • Истории (Histories)
        • Файлы (Files)
        • Отделы (Sections)
        • Виды (Views)
        • Сообщения (Messages)
      • Агрегация
        • Разложения (Values)
        • Сводка (Totals)
      • Отчеты
        • Дашборды (Boards)
        • Графики (Widgets)
      • Поисковые выборки
        • Доступные связи (AvailableRecords)
        • Доступные условия фильтра (AvailableFilterRecords)
        • Сотрудники (Users)
        • Контакты (Contacts)
      • Права (Rights)
      • Профиль (Profile/me)
  • Установка на сервер
    • 🧱Архитектура
      • Варианты разворачивания
    • 🖥️Требования
    • 📂Установка как служба
    • 🛳️Установка через Docker
    • 🎛️Мультидоменная среда
    • 🆘Материалы
      • TLS/SSL Сертификат
      • Параметры config.env
        • Для Bpium
        • Для Bpium S3
        • Для Bpium BPM
      • Запуск
      • Обсуживание
        • Активация
        • Обновление
        • Бэкап и восстановление базы
        • Брендирование (Whitelabel)
        • Удаление
      • Перенос базы из облака
      • Возможные проблемы в ходе установки и работы
  • Обучение
    • Базовый курс
      • Урок 1. Отделы
      • Урок 2. Каталоги с данными
      • Урок 3. Карточки записей
      • Урок 4. Связи между данными
      • Урок 5. Фильтры и виды
      • Урок 6. Приглашение сотрудников
      • Урок 7. Права доступа к данным
      • Урок 8. Графические отчеты
      • Урок 9. Бизнес-процессы
      • Урок 10. Интеграции
    • Технический курс
      • Урок 1. Принцип работы автоматизаций
      • Урок 2. Первая автоматизация изнутри
      • Урок 3. Валидация данных
      • Урок 4. Простые вычисления
      • Урок 5. Расчет суммы заказа
      • Урок 6. Генерация счетов/документов
      • Урок 7. Рассылка почтовых сообщений
      • Урок 8. Прием внешних данных
      • Урок 9. Отправка данных на сторонние сервисы
    • Паттерны проектирования ИС
      • Унификация
      • Упорядоченность
      • Разделение
      • Актуализация
      • Вынос параметров
      • Выделение позиций
      • Слияние
      • Дублирование
      • Типизация
      • Информирование
Powered by GitBook
On this page
  • Настройка конфигурационного файла (config.env)
  • Системные настройки
  • Безопасность
  • Сетевые настройки и защищенный канал связи.
  • Настройка почтовой службы.
  • Настройка авторизации
  • Настройка файлового сервера
  • Настройка сервера процессов
  • Лимитирование запросов к API
  • Лимитирование запросов авторизации
  • Кеш
  • Лайфхаки
  1. Установка на сервер
  2. Материалы
  3. Параметры config.env

Для 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

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.

PreviousПараметры config.envNextДля Bpium S3

Last updated 17 days ago

SMTP-сервис. Допустим один из указанных:

🆘
https://github.com/nodemailer/nodemailer-wellknown
Подробнее о параметрах