search string side menu

BRIX On-Premises > BRIX On-Premises Standard / Install BRIX Standard

Install BRIX Standard

BRIX Standard edition can be installed on Kubernetes-in-Docker (KinD). This installation option is straightforward and allows you to run a local Kubernetes cluster using a Docker container node.

The installation consists of three steps:

  1. Prepare infrastrucure.
  2. Install Docker for your operating system.
  3. Download the installation script and fill in the configuration file.
  4. Run BRIX Standard installation script.

First read the BRIX On-Premises Standard system requirements.

 

Step 1: Prepare infrastructure

The infrastructure refers to the necessary components required for the operation of the BRIX On-Premises application:

  • Docker
  • PostgreSQL
  • MongoDB
  • RabbitMQ
  • Redis
  • S3 (MinIO)

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

It is assumed that the dependent components must be deployed by the customer independently. All tasks related to organizing a fail-safe local architecture and setting up the resilience of dependent components also remain the responsibility of the customer.

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

Built-in data storage components are suitable for demonstration purposes and in special cases for organizing testing and development platforms. If no connection parameters to external databases and S3 storage are specified in the additional installation settings, the built-in data storage components (PostgreSQL, MongoDB, RabbitMQ, Redis, MinIO) will be used automatically.

In the context of this article, the PostgreSQL database and S3 object storage will be external. For more details on how to deploy the database and object storage, read the articles: PostgreSQL and MinIO (S3).

Standard connection strings and passwords are used to connect to PostgreSQL and MinIO (S3).

Step 2: Install Docker

Install Docker for your operating system.

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

Please be aware that KinD does not support creating a Kubernetes cluster with Cgroups v2. Refer to the documentation for possible errors.

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

Step 3: Download the installation script and fill in the configuration file

Upon the first run, the installation script will create a configuration file named config-elma365.txt in the directory from which it was executed.

  1. Download and run the BRIX installation script to create a configuration file by executing the following command:

sudo curl -fsSL -o elma365-docker.sh https://dl.elma365.com/onPremise/latest/elma365-docker-latest && \
sudo chmod +x elma365-docker.sh && \
sudo ./elma365-docker.sh

Download links for other BRIX versions are provided in Links for downloading BRIX distribution packages.

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

To create a new default configuration file, rename the existing configuration file config-elma365.txt  and run the installation script with the --new-config flag.

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

  1. Make changes to the configuration file config-elma365.txt prepared with the installation script.
  1. For a quick start with BRIX Standard, uncomment and fill in the necessary variables.

Filling in the main parameters in the configuration file config-elma365.txt may look like the following:

offline_install_parameters

Where:

  • ELMA365_HOST=192.168.1.103 is the IP address of the host machine through which the BRIX Standard application will be accessible. For details on creating a FQDN, refer to Modify BRIX Standard parameters.
  • ELMA365_EMAIL=admin@mail.com is the administrator's email address.
  • ELMA365_PASSWORD=test is the  administrator's password.
  • ELMA365_LANGUAGE=en-US is the language of the installed system.

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

If Docker is installed via Snap, you need to uncomment and change the paths to folders/directories for the parameters: ELMA365_INSTALL_DIR, ELMA365_BACKUP_DIR, for example:

  • ELMA365_INSTALL_DIR=/mnt/elma365/docker.
  • ELMA365_BACKUP_DIR=/mnt/elma365/backup.

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

  1. Set up connection to external databases and S3 object storage.

Important: Built-in data storage components are suitable for demonstration purposes and, in special cases, for organizing testing and development platforms. If no connection parameters to external databases and S3 storage are specified in the additional installation settings, the built-in data storage components (PostgreSQL, MongoDB, RabbitMQ, Redis, MinIO) will be used automatically.

To connect to the external PostgreSQL database, uncomment and fill in the ELMA365_DB_PSQL, parameter by specifying the connection string obtained during the installation of PostgreSQL in step 6.

Uncomment and set the following parameters for connecting to S3:

  • 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. Connection parameter values will be obtained during the installation of MinIO (S3) in step 10;
  • Set the ELMA365_DB_S3_GATEWAY arameter to true to enable proxying connections to S3 through BRIX.

 

Filling in connection variables to the proxy server

To use your proxy server for the installation and operation of BRIX Standard, uncomment and fill in the variables in the section Setting up the operation mode of the BRIX server through the proxy server of the configuration file config-elma365.txt.
 

Example for ELMA365_HOST=192.168.1.103:
 

# -------------------------------------------------------------
# Setting up the operation mode of the BRIX server through the proxy server
# -------------------------------------------------------------
HTTPS_PROXY=http://proxy_user:proxy_pass@host:port/
HTTP_PROXY=http://proxy_user:proxy_pass@host:port/
NO_PROXY=localhost,192.168.1.103,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=http://proxy_user:proxy_pass@host:port/
http_proxy=http://proxy_user:proxy_pass@host:port/
no_proxy=localhost,192.168.1.103,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

 
Example for ELMA365_HOST=example.com:
 

# -------------------------------------------------------------
# Setting up the operation mode of the BRIX server through the proxy server
# -------------------------------------------------------------
HTTPS_PROXY=http://proxy_user:proxy_pass@host:port/
HTTP_PROXY=http://proxy_user:proxy_pass@host:port/
NO_PROXY=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=http://proxy_user:proxy_pass@host:port/
http_proxy=http://proxy_user:proxy_pass@host:port/
no_proxy=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/

 

Where:

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

Make sure that the no_proxy and NO_PROXY variables contain network address ranges and domains to be excluded from using the proxy.

For more information on config-elma365.txt configuration file parameters, refer to Modify BRIX Standard parameters.

Step 4: Run BRIX Standard installation script

The volume of downloaded files during BRIX Standard installation is approximately 4-5 GB, and the installation time is around 10-15 minute.

  1. Run the downloaded installation script:

sudo ./elma365-docker.sh

Once installation is complete, a message about the successful installation of the BRIX Standard application will be displayed in the script.

kubernetes-in-docker-3

  1. Launch the browser and open the BRIX Standard application login page at http://ELMA365_HOST. The ELMA365_HOST parameter was specified in the config-elma365.txt file on the Download the installation script and fill in the configuration file step.

In the provided example, the following application login page address is used: http://192.168.1.103.
standard_offline_login

  1. For login, use the administrator’s email address and the password that was used in the config-elma365.txtconfiguration file under the parameters ELMA365_EMAIL and ELMA365_PASSWORD.

In the provided example, they are::

  • Login: admin@mail.com.
  • Password: test.
  1. Click the Sign In button.

The BRIX system activation window will open.

  1. Activate the system. For more details, see Activate On-Premises.

The installation of BRIX Standard has been successfully completed.

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

Save the config-elma365.txt file for future updates.

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

elma365-standard-trial-version.html install-kind-offline.html