search string side menu

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

Install BRIX Standard offline

BRIX Standard can be installed in a closed-loop network without internet access. The Kubernetes-in-Docker (KinD) installation is a simple option and allows you to run a local Kubernetes cluster using the Docker container node in a closed loop without internet access.

The installation consists of five stages:

  1. Prepare infrastructure.
  2. Download files for the offline version.
  3. Install Docker on the computer in the closed loop.
  4. Fill out the configuration file.
  5. Run the installation script.

install-kind-offline-1

 

Step 1: Prepare infrastructure

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

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

It is assumed that the customer deploys the dependent components using their own resources. 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.

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

Components required for operation of the BRIX On-Premises:

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

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: Download files for the offline version

  1. On a computer with internet access, download the required files for the offline version (file size ~4-5 GB) by executing the following command:

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

All the download links for BRIX distribution packages of other versions are provided in Links for downloading BRIX distribution packages.

The boot script will create a directory named elma365-X.Y.Z in the directory from which it was launched and will download the necessary files into it.

When the files for the offline version are downloaded, the boot script will display information about which directory the files were downloaded to, and suggest copying them to a computer in the closed loop.

Example of executing the boot script:
offline_install1

  1. After downloading all files, transfer the obtained elma365-X.Y.Z directory to the server where the installation will be performed.

Step 3: Install Docker on a computer in a closed loop network

Install Docker suitable for your operating system on a local computer in a closed-loop network.

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

Note that KinD does not support creating a Kubernetes cluster with Cgroups v2. More about possible errors can be found in official documentation.

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

Step 4: Fill out the configuration file

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

  1. On the closed-loop computer where offline version files have been copied, navigate to the elma365-X.Y.Z directory and run the BRIX installation script to create a configuration file, executing the following command:

sudo ./elma365-docker.sh --offline

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

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

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

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

Filling out the main parameters in the config-elma365.txt configuration file may look as follows:

offline_install_parameters

Where:

  • ELMA365_HOST=192.168.1.103 is the IP address of the host machine, through which BRIX Standard will be accessible. Read more about creating a domain (FQDN) in Modifying BRIX Standard Parameters.
  • ELMA365_EMAIL=admin@mail.com is the administrator email address.
  • ELMA365_PASSWORD=test is the administrator password.
  • ELMA365_LANGUAGE=en-US is the language of the installed system.
  1. Configure connection to external databases and object S3 storage.

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

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

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

To connect to an external PostgreSQL database, uncomment and fill in the ELMA365_DB_PSQL parameter (specify the connection string obtained in step 6 of the PostgreSQL article). For example:

install-kind-offline-3

Uncomment and fill in the following variables to connect to S3 storage:

  • ELMA365_DB_S3_ADDRESS, ELMA365_DB_S3_BUCKET, ELMA365_DB_S3_USER, ELMA365_DB_S3_PASSWORD, ELMA365_DB_S3_REGION, ELMA365_DB_S3_METHOD, and ELMA365_DB_S3_SSL parameters (specify the connection parameters obtained at step 10 of the MinIO S3 article).
  • To enable connection proxying to S3 via BRIX, set the value to true in the ELMA365_DB_S3_GATEWAY parameter.

Example:

install-kind-offline-4

  1. Since the BRIX Standard is installed in a closed loop (without internet access) with the --offline key, the ELMA365_PRIVATE_REGISTRY_URL parameter will automatically be filled out during configuration file generation.

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

The ELMA365_PRIVATE_REGISTRY_URL parameter is automatically filled with the IP address from the interface to which the default route points.

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

Specify the address of the private Docker image repository in the ELMA365_PRIVATE_REGISTRY_URL parameter:

offline_install_docker

Where:

  • ELMA365_PRIVATE_REGISTRY_URL=192.168.0.103:5000 is the URL for the private repository with the ip:port format:
    • 192.168.0.103 is the IP address to which the created local Docker image repository will be bound.
    • 5000 is the port to which the created local Docker image repository will be bound.

If you don't have your own private repository, you can use a local private repository. To do this, uncomment the ELMA365_LOCAL_PRIVATE_REGISTRY_ENABLE parameter and set its value to true.

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

If Docker is installed via Snap, uncomment and modify the paths to folders/directories for parameters: ELMA365_INSTALL_DIR, ELMA365_BACKUP_DIR, ELMA365_PRIVATE_REGISTRY_DIR, for instance, to:

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

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

 

Read more about the config-elma365.txt configuration file parameters in Modifying BRIX Standard Parameters.

Step 5: Run the BRIX Standard installation script

After starting, the installation script will place the necessary images in the Docker image repository. Then, the BRIX Standard application will be installed, taking 10-15 minutes.

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

A default route must be set in the system.

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

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

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

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 at the configuration file filling out 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.txt configuration 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 offline installation of BRIX Standard has been successfully completed.

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

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

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

install-kubernetes-in-docker.html change-elma365standard-parameters.html