Help Center

Configuration parameters

Cloudless Pyrus

This section presents mandatory and optional parameters that are used to configure Pyrus Datacenter.

To add or change a parameter, execute the command:

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

Example:

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

To start the services, configure the following parameters:

  • App license, obtained from your account manager or partner.
  • Application domain, through which your users will access the system, for example: pyrus.yourdomain.org.
  • Access parameters to your SMTP server. Pyrus uses email to deliver one-time access codes and notifications. This can be configured during initial system launch.
  • File storage configuration. File storage in S3-compatible storage is supported.

Pyrus Tip: updating parameters may require containers to be restarted.

Mandatory parameters

100000 LICENSEApplication license.
100001 HOSTNAMEMain application domain, such as: pyrus.yourdomain.org.
101301 SMTP_SERVERSMTP server name, such as: mx-out.yourdomain.org.
101302 SMTP_PORTSMTP-порт. SMTP port. Default value: 25.
101401 SMTP_USE_SSLUse SSL for connecting to the SMTP server. Default value: false.
101501 SMTP_CREDENTIALSUse Credentials (bool) for connecting to the SMTP server. Default value: false. If set to true, SMTP_USERNAME and SMTP_PASSWORD parameters must be specified.
101554 SMTP_NOTIFIER_ADDRESSEmail address from which notifications should be sent, such as: notifier@youdomain.org.
101555 SMTP_LOST_PASSWORD_ADDRESSEmail address from which password creation/recovery requests should be sent, such as: recover.password@youdomain.org.
9910001 USE_DATABASE_FILE_STORAGEFor versions up to 1.12 inclusive. Use a local database to store files (bool). If you plan to store files only in the database, no additional configuration is required. Default value: true. If set to false, an alternative file storage service must be specified in the optional parameters.

Optional parameters

101502 SMTP_USERNAMELogin to connect to the SMTP server. Used if the SMTP_CREDENTIALS parameter is set to true.
101503 SMTP_PASSWORDPassword to connect to the SMTP server. Used if the SMTP_CREDENTIALS parameter is set to true.

110007 PREVIEW_GENERATOR_TYPE

For versions from 1.15 inclusive. Mode of document and print form preview generator. Possible values: 0 - LibreOffice; 1 - Chrome (Puppeteer). If not filled in, the default value is used.

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

For versions from 1.12.1 and above. Used for storing file storage settings. Setting up S3 storage in Pyrus Datacenter installations version 1.12.1 and above is done as described here.

Example of setting SMTP server parameters

Suppose you have an email address yourfavoritemail@gmail.com and password yoursupersecurepwd, and you want to use these to send notifications. In that case, the SMTP server setting will look like this:

$ 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.gmail.com
$ docker-compose run --rm pyrus-setup --setup -id 101501 -v true
$ docker-compose run --rm pyrus-setup --setup -id 101502 -v yourfavoritemail@gmail.com
$ docker-compose run --rm pyrus-setup --setup -id 101503 -v yoursupersecurepwd
$ docker-compose run --rm pyrus-setup --setup -id 101554 -v yourfavoritemail@gmail.com
$ docker-compose run --rm pyrus-setup --setup -id 101555 -v yourfavoritemail@gmail.com

Zoom integration

Note: an integration connects all the users in your organization to a single Zoom account.

Here’s how to connect the Zoom integration to Pyrus Datacenter 1.17 and later versions.

Build an app in Zoom

  1. Log in to your Zoom account and open Zoom App Marketplace.

  2. In the upper-right section of the screen, click the Develop tab. Select Build App, then Server to Server.

  3. In the Information section, specify your company’s information and the contact info of your assignee.

  1. In the Scopes section, add the following:

    • meeting:write:meeting;

    • user:read:user.

  2. In the Activation section, activate your app.

Configure the integration in Pyrus

  1. To configure the integration, run the commands:

    docker-compose run --rm pyrus-setup --setup -id 9900900 -v 'Client ID'
docker-compose run --rm pyrus-setup --setup -id 9900901 -v 'Client Secret'
docker-compose run --rm pyrus-setup --setup -id 9900902 -v 'Verification Token'

    Pyrus Tip: ClientId and ClientSecret can be copied in the App Credentials section in Zoom.

    Verification Tokens are found in the Feature section.

  2. Configure S2S-login.

    docker-compose run --rm pyrus-setup set-config -n ZoomS2S:AccountId -v (Account id)

    Pyrus Tip: Account id is available in the App Credentials section in Zoom.

Test the integration

  1. Click the camera icon in the bottom panel under the comment field.

  2. Place a check mark in the Zoom box and click Create.

    The details of the video conference and a link to connect will be displayed in the task comments.

Was this article helpful?