Конфигурационные параметры
В этом разделе представлены обязательные и опциональные параметры, которые используются для настройки 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-совместимых хранилищах.
Обязательные параметры
| 100000 LICENSE | Лицензия приложения. |
| 100001 HOSTNAME | Домен основного приложения, пример: pyrus.yourdomain.org. |
| 101301 SMTP_SERVER | Имя SMTP-сервера, пример: mx‑out.youdomain.org. |
| 101302 SMTP_PORT | SMTP-порт. Значение по умолчанию: 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 | Для версий до 1.12 включительно. Использование локальной БД для хранения файлов (bool). Если вы планируете хранить файлов только в БД, дополнительная настройка не требуется. Значение по умолчанию: true. Если установлен в false, то в опциональных параметрах должен быть указан один из альтернативных сервисов для хранения файлов. |
Опциональные параметры
| 101502 SMTP_USERNAME | Логин для подключения к к SMTP-серверу. Используется, если параметр SMTP_CREDENTIALS установлен в true. |
| 101503 SMTP_PASSWORD | Пароль для подключения к к SMTP-серверу. Используется, если параметр SMTP_CREDENTIALS установлен в true. |
| 9910004 USE_S3_FILE_STORAGE | Для версий до 1.12 включительно. Использование S3 для хранения файлов (bool). Значение по умолчанию: false. |
| 9910002 S3_BLOB_STORAGE_ENDPOINT | Для версий до 1.12 включительно. Адрес S3 для хранения файлов. Для AWS S3 можно указать имя региона, например, eu-west-2. Для остальных хранилищ необходимо указать адрес сервера, например, https://s3mts.ru:443 для MTS S3, https://hb.bizmrg.com для Mail S3 и т.д. |
| 9900151 S3_ACCESS_KEY | Для версий до 1.12 включительно. Ключ для доступа к хранилищу файлов S3. |
| 9900152 S3_ACCESS_SECRET | Для версий до 1.12 включительно. Секретный ключ для доступа к хранилищу файлов S3. |
| 9900153 S3_BUCKET | Для версий до 1.12 включительно. Имя корзины S3, в которой хранятся файлы. |
| 9910006 S3_FORCE_PATHSTYLE | Для версий до 1.12 включительно. Использование path style для формирования запросов к S3. Подробнее узнать о path style можно в официальной документации S3 Необходимо выставить при использовании таких хранилищ как VK Cloud S3, MinIO. Значение по умолчанию: false. |
9911001 FILE_STORAGE_MIN_UPLOADS 9911571 FILE_STORAGE_1 9911572 FILE_STORAGE_2 9911573 FILE_STORAGE_3 9911574 FILE_STORAGE_4 9911575 FILE_STORAGE_5 9911576 FILE_STORAGE_6 9911577 FILE_STORAGE_7 9911578 FILE_STORAGE_8 | Для версий до 1.12.1 выше. Используются для хранения настроек хранилища файлов. Настройка S3-хранилища в установках Pyrus Datacenter версии 1.12.1 и выше производится так, как описано здесь. |
Для просмотра текущей конфигурации системы выполните команду:
$ 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-хранилища в установках Pyrus Datacenter версий до 1.12 включительно настройте следующие параметры, как описано в предыдущем разделе:
USE_S3_FILE_STORAGE S3_BLOB_STORAGE_ENDPOINT S3_ACCESS_KEY S3_ACCESS_SECRET S3_BUCKET
Настройка S3-хранилища в установках Pyrus Datacenter версии 1.12.1 и позднее производится, как описано здесь.
Автоматическая загрузка в форму данных компаний
Чтобы в форму автоматически добавлялись реквизиты, адреса и другие данные организаций и банков из базы ЕГРЮЛ, выполните команду:
docker-compose run --rm pyrus-setup --setup -id 9900301 -v 'Token xxxxxxxxx'
Обратите внимание: xxxxxxxxx в примере – это токен интеграции с сервисом DaData.