ELMA365 On-Premises > ELMA365 Standard / Modify ELMA365 Standard parameters

Modify ELMA365 Standard parameters

During the operation of ELMA365 Standard (KinD), you may need to reconfigure the app components, for example, to edit the settings of services — modify the mail server settings, change the application connection parameters, configure additional options, etc.

The process of changing the application's parameters consists of two stages:

 

  1. Making changes to the config-elma365.txt configuration file.
  2. Running the installation script with the --upgrade key to apply the new parameters.

change-parameters-1

The parameters in the config-elma365.txt configuration file are divided into two groups:

 

  • Basic. Parameters that are minimally required for the quick deployment of the ELMA365 Standard app in Kubernetes-in-Docker (KinD).
  • Additional. Parameters describing the interaction of ELMA365 Standard (KinD) with external data storage systems, modes, and protocols of the application's operation.

Careless modification of additional parameters in the config-elma365.txt configuration file can lead to the ELMA365 Standard app (KinD) becoming inoperative. Before making changes to this file, it is recommended to create a backup copy.

Name

Description

Main installation parameters

ELMA365_HOST

IP or URL address through which the system will be accessible.

When setting up the system with a specified domain name, it is necessary to add the corresponding AAA record in the DNS server: "myelma365.com" <-> "IP address of the machine with ELMA365".

Important: if it is impossible to configure domain name resolution, it is necessary to enable the additional installation parameter ELMA365_HOSTALIASES_IP.

Login credentials for supervisor:

ELMA365_EMAIL

The email address is specified, which will serve as the login for the main administrator.

Important: it is used when creating a company during the installation of ELMA365. Modifying ELMA365_EMAIL makes it impossible to apply new parameters or update ELMA365.

Default value: admin@mail.com.

ELMA365_PASSWORD

Password for main administrator.

Important: it is used when the company is created at the moment ELMA365 is installed.
This parameter can be changed via the web interface if the system administator's email is specified.

System interface language:

ELMA365_LANGUAGE

Interface language.

Available options: "ru-RU", "en-US", "sk-SK".

System edition:

 

ELMA365_EDITION

Available options: "standard", "enterprise".

In this package, the "enterprise" edition choice is intended for licensing and does not include add-ons that expand the functional and infrastructural capabilities of the ELMA365.

Setting connection with SMTP:

ELMA365_SMTP_HOST

IP or URL for connecting to SMTP server.

ELMA365_SMTP_PORT

Port for connecting to SMTP server.

ELMA365_SMTP_FROM

Email address (name of the email) on behalf of which the messages will be sent.

ELMA365_SMTP_USER

User login for connecting to SMTP server.

ELMA365_SMTP_PASSWORD

User password for connecting to SMTP server.

ELMA365_SMTP_TLS

Using TLS encryption by SMTP server.

Available option: true, false.

Setting TLS encryption:

ELMA365_TLS_CRT

Path to the SSL certificate (to enable HTTPS support). The SSL certificate must be fullchain.

Important: If the ELMA365_HOST parameter specifies an IP address, the ELMA365_TLS_CRT parameter is ignored

ELMA365_TLS_KEY

Path to the private key (to enable HTTPS support).

Important: If the ELMA365_HOST parameter specifies an IP address, the ELMA365_TLS_KEY parameter is ignored.

ELMA365_TLS_CA

Path to the root CA certificate when using a self-signed certificate.

Important: If the ELMA365_HOST parameter specifies an IP address, the ELMA365_TLS_CA parameter is ignored.

Additional installation parameters

Setting connection to external databases:

ELMA365_DB_PSQL

PostgreSQL connection string for both read and write operations.

Format: postgresql://user:password@hostname:port/databaseName. Where:

  • user - the username of the PostgreSQL user with access rights to the database;
  • password - the password for the PostgreSQL user;
  • hostname - IP or domain name of the PostgreSQL server;
  • port - port to connect to PostgreSQL, default port: 5432;
  • databaseName - name of the database;

For the required PostgreSQL configuration, refer to the Prepare external databases section.

ELMA365_DB_PSQL_RO

PostgreSQL connection string for writing operations.

Format: postgresql://user:password@hostname:port/databaseName. Where:

  • user - the username of the PostgreSQL user with access rights to the database;
  • password - the password for the PostgreSQL user;
  • hostname - IP or domain name of the PostgreSQL server;
  • port - port to connect to PostgreSQL, default port: 5432;
  • databaseName - name of the database;

For the required PostgreSQL configuration, refer to the Prepare external databases section.

ELMA365_DB_MONGO

MongoDB connection string .

Format: mongodb://user:password@hostname:port/databaseName. Where:

  • user - the username of the MongoDB user with access rights to the database;
  • password - the password for the MongoDB user;
  • hostname - IP or domain name of the MongoDB server;
  • port - port to connect to MongoDB, default port: 27017;
  • databaseName - name of the database;

For the required MongoDB configuration, refer to the Prepare external databases section.

ELMA365_DB_REDIS

Redis connection string.

Format: redis://user:password@hostname:port/databaseName. Where:

  • user - the username of the Redis user with access rights to the database;
  • password - the password for the Redis user;
  • hostname - IP or domain name of the Redis server;
  • port - port to connect to Redis, default port: 6379;
  • databaseName - name of the database;

For the required Redis configuration, refer to the Prepare external databases section.

ELMA365_DB_AMQP

RabbitMQ connection string.

Format: amqp://user:password@hostname:port/vhost. Where:

  • user - the username of the RabbitMQ user with access rights to vhost;
  • password - the password for the RabbitMQ user;
  • hostname - IP or domain name of the RabbitMQ server;
  • port - port to connect to RabbitMQ, default port: 5672;
  • databaseName - name of the database;

 

For the required RabbitMQ configuration, refer to the Prepare external databases section.

Setting connection to S3 file storage:

ELMA365_DB_S3_ADDRESS

S3 connection string.

Format: hostname:port. Where:

  • hostname - IP or domain name of the S3 server;
  • port - port to connect to S3, default port:: 9000;

For the required S3 configuration, refer to the Prepare external databases section.

ELMA365_DB_S3_BUCKET

Bucket name in S3.

Important: If the proxy connection parameter to the external S3, ELMA365_DB_S3_GATEWAY, is enabled, the bucket name should be set as s3elma365.

ELMA365_DB_S3_USER

User login for connecting to the S3 server.

LMA365_DB_S3_PASSWORD

User password for connecting to the S3 server.

ELMA365_DB_S3_REGION

S3 server location region.

ELMA365_DB_S3_METHOD

Method for uploading files to S3.

Available options: PUT.

ELMA365_DB_S3_SSL

Use of TLS encryption by the S3 server.

Available options: true, false.

ELMA365_DB_S3_GATEWAY

Enabling proxy connection to an external S3 (if the S3 server is isolated in a local network).

Available options: true, false.

Important: to proxy a connection to an external S3, the connection parameters to the S3 server must be filled in:

  • ELMA365_DB_S3_ADDRESS;
  • ELMA365_DB_S3_BUCKET;
  • ELMA365_DB_S3_USER;
  • ELMA365_DB_S3_PASSWORD;
  • ELMA365_DB_S3_REGION;
  • ELMA365_DB_S3_METHOD;
  • ELMA365_DB_S3_SSL.

Setting up directories for system installation and creating backups.:

ELMA365_INSTALL_DIR

Path to the directory where the ELMA365 Standard (KinD) system will be installed.

Default value: "/opt/elma365/docker".

Important: If installing the Docker App via Snap, the installation directory path should be changed to /mnt or /media.

Example: ELMA365_INSTALL_DIR="/mnt/elma365/docker".

ELMA365_BACKUP_DIR

Path to the directory where backup copies of the ELMA365 Standard (KinD) system will be saved

Default value: "/backup".

Important: If installing the Docker App via Snap, the installation directory path should be changed to /mnt or /media.

Example: ELMA365_BACKUP_DIR="/mnt/elma365/backup".

Settings for a private Docker image repository:

ELMA365_PRIVATE_REGISTRY_URL

Address of the created private Docker image repository.

Format: hostname:port.

Important: In the ELMA365_PRIVATE_REGISTRY_URL parameter, the IP address is automatically filled in from the interface to which the default route points.

ELMA365_PRIVATE_REGISTRY_DIR

Directory location of the local Docker image repository.

Default value: "/opt/elma365/registry".

Important: If the Docker app is installed via Snap, the path to the directory of the local Docker image repository should be changed to /mnt or /media..

Example: ELMA365_PRIVATE_REGISTRY_DIR="/mnt/elma365/registry".

ELMA365_PRIVATE_REGISTRY_PORT

Port for connecting to the local Docker image repository.

Default value: "5000".

Mapping ports to database in docker:

ELMA365_PORT_FORWARD_PSQL

Mapping a local port to the Postgres DB pod port, the local port number is specified.

ELMA365_PORT_FORWARD_MONGO

Mapping a local port to the MongoDB DB pod port, the local port number is specified.

ELMA365_PORT_FORWARD_AMQP

Mapping a local port to the Web port in the RabbitMQ DB pod, the local port number is specified.

ELMA365_PORT_FORWARD_REDIS

Mapping a local port to the Redis DB pod port, the local port number is specified..

ELMA365_PORT_FORWARD_S3

Mapping a local port to the Web port in the MinIO S3 data storage pod, the local port number is specified.

Setting connection of ELMA365 to a proxy server:

HTTPS_PROXY

Connection URL to the proxy server for the https protocol.

Format: http://proxy_user:proxy_pass@host:port/.

where:

  • proxy_user — username for authentication on the proxy server;
  • proxy_pass — password for authentication on the proxy server;
  • host — host of the used proxy server;
  • port — port of the used proxy server.

HTTP_PROXY

Connection URL to the proxy server for the http protocol.

Format: http://proxy_user:proxy_pass@host:port/.

where:

  • proxy_user — username for authentication on the proxy server;
  • proxy_pass — password for authentication on the proxy server;
  • host — host of the used proxy server;
  • port — port of the used proxy server.

NO_PROXY

Network addresses, ranges of network addresses, and domains that should be excluded from using the proxy are specified.

Default value: localhost,example.com,127.0.0.0/8,10.0.0.0/8,169.254.0.0/16, 192.168.0.0/16,100.64.0.0/10,172.16.0.0/12,cluster.local,linkerd.svc.

https_proxy

Connection URL to the proxy server for the https protocol.

Format: http://proxy_user:proxy_pass@host:port/.

where:

  • proxy_user — username for authentication on the proxy server;
  • proxy_pass — password for authentication on the proxy server;
  • host — host of the used proxy server;
  • port — port of the used proxy server.

http_proxy

Connection URL to the proxy server for the http protocol.

Format: http://proxy_user:proxy_pass@host:port/.

where:

  • proxy_user — username for authentication on the proxy server;
  • proxy_pass — password for authentication on the proxy server;
  • host — host of the used proxy server;
  • port — port of the used proxy server.

no_proxy

Network addresses, ranges of network addresses, and domains that should be excluded from using the proxy are specified.

Default value: localhost,example.com,127.0.0.0/8,10.0.0.0/8,169.254.0.0/16, 192.168.0.0/16,100.64.0.0/10,172.16.0.0/12,cluster.local,linkerd.svc.

Parameters with no group:

ELMA365_HOSTALIASES_IP

Sets the HOSTALIASES for the domain name specified in the ELMA365_HOST parameter, linking it to the specified IP address (IP address of the machine with ELMA365).

Important: this setting should be used when installing the system with a specified domain name if it's not possible to create a corresponding AAA record in the DNS server ("myelma365.com" <-> "IP address of the machine with ELMA365") for the domain name specified in ELMA365_HOST.

The system checks the possibility of connection by the domain name specified in ELMA365_HOST from the Kubernetes environment for the correct operation of the diskjockey service. The absence of domain name resolution, as mentioned in ELMA365_HOST, will lead to the installation failure of ELMA365 Standard (KinD).

ELMA365_PROXY_WITH_SSL

Mode of operation for the ELMA365 server behind an HTTPS proxy.

Available options: true, false.

ELMA365_DEBUG

Debugging mode for the ELMA365 platform.

Available options: true, false

ELMA365_EXTRA_ARGS

Enabling additional parameters. They should be specified in the format: "exampleArgs1:'111' exampleArgs2:'true' exampleArgs3:22m","exampleArgs2":"222".

The need to enable and the list of additional parameters should be clarified with ELMA365 reps.

ELMA365_ENABLED_FEATUREFLAGS

Enabling additional feature flags. They should be specified in the format: "exampleFlags1","exampleFlags2".

The need to enable feature flags and their list should be clarified with ELMA365 reps.

maxFileSizeMB

Sets the maximum allowable size for files uploaded to the system. The default is set to 100 MB. The new value is defined in parameter ELMA365_EXTRA_ARGS and is specified after a colon, for example, ELMA365_EXTRA_ARGS="maxFileSizeMB":"400".

Uncomment and make necessary changes to the parameters in the config-elma365.txt configuration file, and save the changes.

Applying new parameters for ELMA365 Standard

  1. To make changes to the parameters of the ELMA365 Standard (KinD) application, update the application using the installation script (elma365-installer-docker.sh), run with the --upgrade key.

начало внимание

The ELMA365_EMAIL and ELMA365_PASSWORD parameters are only used when installing the system for the first time. Later their changes are ignored by the script.

конец внимание

  1. Make the changes to the ELMA365 Standard parameters:

sudo ./elma365-installer-docker.sh --upgrade

sudo ./elma365-installer-docker.sh --offline --upgrade

  1. Upon launch, the installation script will determine the version of the installed ELMA365 Standard (KinD) and suggest transitioning to the new version.

начало внимание

For a simple application of new parameters, the versions of ELMA365 Standard (KinD) should match.

конец внимание

Agree to transition to the new version by typing [Y]. Entering any other symbol will abort the application update.

change-parameters-2

  1. The next step in the installation script, you will see a notification about the need to make a backup before updating ELMA365 Standard (KinD).
  2. To continue updating the application, enter one of the options:
  • [B] — creating a backup (Backup);
  • [C] — skip backup (Continue);
  • [E] — abort update (Exit).
  1. Create a backup and continue updating ELMA365 Standard (KinD) by selecting [B] or pressing the ENTER key.
  2. The installation script will carry out the backup and begin the application update.

change-parameters-3

  1. Wait for the application update to complete. You will see a message “Upgrade ELMA365 application successful”. The update of the ELMA365 Standard (KinD) parameters is complete.

Found a typo? Highlight the text, press ctrl + enter and notify us