search string side menu

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

Install BRIX Standard trial version

BRIX On-Premises Standard edition can be installed in Kubernetes-in-Docker (KinD). This installation option is the simplest and allows running a local Kubernetes cluster using a Docker container node.

The installation consists of three steps:

  1. Install Docker on your operating system.
  2. Download the installation script and fill in the configuration file.
  3. Run the installation script.

Please read System requirements for BRIX On-Premises Standard before beginning the installation process.

Step 1: Install Docker

Install Docker for your operating system.

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

Please note, that KinD does not support creating a Kubernetes cluster with Cgroups v2. Read more about possible errors in the documentation.

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

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

At the first run, the installation script will create a configuration file named config-elma365.txt in the directory from where it was started.

  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

The download links for other BRIX versions are provided in the article Links for downloading BRIX distribution packages.

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

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

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

  1. Make changes in the config-elma365.txt configuration file prepared by the installation script.
  1. To quickly start the BRIX Standard application, uncomment and fill in the required variables.

The filling of basic parameters in the config-elma365.txt configuration file can look as follows:

offline_install_parameters

Where:

  • ELMA365_HOST=192.168.1.103 is the IP address of the host system where the BRIX Standard app will be available. For more details on how to create a domain (FQDN), read Modify BRIX Standard parameters.
  • ELMA365_EMAIL=admin@mail.com is the email address of the administrator.
  • ELMA365_PASSWORD=test is the password of the administrator.
  • ELMA365_LANGUAGE=ru-RU is the language of the installed system.

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

If Docker is installed via Snap, in the configuration file you need to uncomment and change the paths to the folders/directories for the parameters: ELMA365_INSTALL_DIR, ELMA365_BACKUP_DIR, e.g. to:

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

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

Filling proxy server connection variables

To use your proxy server for installing and running BRIX Standard, uncomment and fill in the variables of the Configuring ELMA365 server mode via proxy section in the config-elma365.txt configuration file.
 

Example for ELMA365_HOST=192.168.1.103:
 

# -------------------------------------------------------------
# Configuring BRIX server mode via 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:
 

# -------------------------------------------------------------
# Configuring BRIX server mode via 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 user name for authorization on the proxy server;
  • proxy_pass is the password for authorization 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 NNO_PROXY variables contain the network address ranges and domains that you want to exclude from proxy use.

For more information about the parameters of the config-elma365.txt configuration file, read Modify BRIX Standard parameters.

Step 3: Run the BRIX Standard installation script

The size of downloaded files during BRIX Standard installation is 4–5 GB and the installation time takes 10–15 minutes.

  1. Run the previously downloaded installation script using the command:

sudo ./elma365-docker.sh

When the installation is complete, the script will display a message stating that the BRIX Standard app was successfully installed.

kubernetes-in-docker-3

  1. Launch the browser and open the sign-in page of the BRIX Standard app at http://ELMA365_HOST. The ELMA365_HOST parameter was specified in the config-elma365.txt configuration file at the step of installing the script and filling in the configuration file.

In the example shown, the following address of the BRIX Standard app sign-in page is used: http://192.168.1.103

standard_offline_login

  1. As login and password, specify the administrator email address and password used in the configuration file config-elma365.txt in the parameters ELMA365_EMAIL and ELMA365_PASSWORD.

In the example above, the following are used:

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

The BRIX system activation window will open.

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

The installation of the BRIX Standard edition is successfully completed.

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

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

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

elma365-on-premises-standard.html install-kubernetes-in-docker.html