Справка

Конфигурационные параметры

Безоблачный Pyrus

В этом разделе представлены обязательные и опциональные параметры, которые используются для настройки Pyrus Datacenter.

Чтобы добавить или изменить параметр, выполните команду:

$ docker-compose run --rm pyrus-setup --setup -id [ID_SETUP_PARAM] -v [NEW_VALUE]

Пример:

$ docker-compose run --rm pyrus-setup --setup -id 101301 -v smtp.mycompany.org

Чтобы запустить сервисы, сконфигурируйте следующие параметры.

  • Лицензия приложения. Ее нужно получить у вашего аккаунт-менеджера или партнера.
  • Домен приложения, по которому ваши пользователи будут обращаться к системе, например: pyrus.yourdomain.org.
  • Параметры доступа к вашему SMTP-серверу. Pyrus использует электронную почту для доставки одноразовых кодов доступа и уведомлений. Возможно настроить при первом запуске системы.
  • Настройка хранения файлов. По умолчанию поддерживается хранение файлов в базе данных, также доступны внешние облачные хранилища S3 и Azure Storage.

Обязательные параметры

100000 LICENSEЛицензия приложения.
100001 HOSTNAMEДомен основного приложения, пример: pyrus.yourdomain.org.
101301 SMTP_SERVERИмя SMTP-сервера, пример: mx‑out.youdomain.org.
101302 SMTP_PORTSMTP-порт. Значение по умолчанию: 25.
101401 SMTP_USE_SSLИспользование SSL для подключения к SMTP-серверу. Значение по умолчанию: false.
101501 SMTP_CREDENTIALSИспользование Credentials (bool) для подключения к SMTP-серверу. Значение по умолчанию: false. В значении true должны быть заданы параметры SMTP_USERNAME и SMTP_PASSWORD.
101554 SMTP_NOTIFIER_ADDRESSПочтовый адрес, от имени которого необходимо отправлять уведомления на почту, пример: notifier@youdomain.org.
101555 SMTP_LOST_PASSWORD_ADDRESSПочтовый адрес, от имени которого необходимо отправлять запрос на создание/восстановление пароля, пример: recover.password@youdomain.org.
9910001 USE_DATABASE_FILE_STORAGEИспользование локальной БД для хранения файлов (bool). Если вы планируете хранить файлов только в БД, дополнительная настройка не требуется. Значение по умолчанию: true. Если установлен в false, то в опциональных параметрах должен быть указан один из альтернативных сервисов для хранения файлов.

Опциональные параметры

101502 SMTP_USERNAMEЛогин для подключения к к SMTP-серверу. Используется, если параметр SMTP_CREDENTIALS установлен в true.
101503 SMTP_PASSWORDПароль для подключения к к SMTP-серверу. Используется, если параметр SMTP_CREDENTIALS установлен в true.
9910004 USE_S3_FILE_STORAGEИспользование S3 для хранения файлов (bool). Значение по умолчанию: false.
9910002 S3_BLOB_STORAGE_ENDPOINTАдрес S3 для хранения файлов. Для AWS S3 можно указать имя региона, например, eu-west-2. Для остальных хранилищ необходимо указать адрес сервера, например, https://s3mts.ru:443 для MTS S3, https://storage.cloud.croc.ru для Крок S3, https://hb.bizmrg.com для Mail S3 и т.д.
9900151 S3_ACCESS_KEYКлюч для доступа к хранилищу файлов S3.
9900152 S3_ACCESS_SECRETСекретный ключ для доступа к хранилищу файлов S3.
9900153 S3_BUCKETИмя корзины S3, в которой хранятся файлы.
9910006 S3_FORCE_PATHSTYLEИспользование path style для формирования запросов к S3. Подробнее узнать о path style можно в официальной документации S3 Необходимо выставить при использовании таких хранилищ как VK Cloud S3, Minio. Значение по умолчанию: false.
9910003 USE_AZURE_FILE_STORAGEИспользование Azure Storage для хранения файлов (bool). Значение по умолчанию: false.
1000001 AZURE_STORAGE_SETTINGSСтрока подключения для доступа к Azure Storage.
1000002 AZURE_BUCKETИмя корзины Azure Storage, в которой хранятся файлы.

Для просмотра текущей конфигурации системы выполните команду:

$ docker-compose run --rm pyrus-setup --setup -ls

Для просмотра значения конкретного параметра выполните команду:

$ docker-compose run --rm pyrus-setup --setup -ls -id [ID_SETUP_PARAM]

Пример настройки параметров SMTP-сервера

Допустим, у вас есть почтовый ящик yourfavoritemail@yandex.ru и пароль yoursupersecurepwd, и вы хотите использовать его для отправки уведомлений. Тогда настройка SMTP-сервера будет выглядеть следующим образом.

$ docker-compose run --rm pyrus-setup --setup -id 101302 -v 465
$ docker-compose run --rm pyrus-setup --setup -id 101401 -v true
$ docker-compose run --rm pyrus-setup --setup -id 101301 -v smtp.yandex.ru
$ docker-compose run --rm pyrus-setup --setup -id 101501 -v true
$ docker-compose run --rm pyrus-setup --setup -id 101502 -v yourfavoritemail@yandex.ru
$ docker-compose run --rm pyrus-setup --setup -id 101503 -v yoursupersecurepwd
$ docker-compose run --rm pyrus-setup --setup -id 101554 -v yourfavoritemail@yandex.ru
$ docker-compose run --rm pyrus-setup --setup -id 101555 -v yourfavoritemail@yandex.ru

Использование S3 в качестве хранилища файлов

Для использования S3 хранилища необходимо настроить следующие параметры, описанные выше:

USE_S3_FILE_STORAGE
S3_BLOB_STORAGE_ENDPOINT
S3_ACCESS_KEY
S3_ACCESS_SECRET
S3_BUCKET

Была ли эта статья полезной?