Installation Guide
This article contains instructions on how to install the AIR console using Docker and it also covers the models of deployment.
Supported Distributions (x64 only)
Debian Bookworm 12 (stable)
Debian Bullseye 11 (oldstable)
Ubuntu Lunar 23.04
Ubuntu Kinetic 22.10
Ubuntu Jammy 22.04 (LTS)
Ubuntu Focal 20.04 (LTS)
Red Hat Enterprise Linux 7 on s390x (IBM Z)
Red Hat Enterprise Linux 8 on s390x (IBM Z)
Red Hat Enterprise Linux 9 on s390x (IBM Z)
CentOS 7
CentOS 8 (stream)
CentOS 9 (stream)
Fedora 37
Fedora 38
For more details about Docker installation requirements, please visit: https://docs.docker.com/engine/install/
Deployment Models
You can deploy AIR in one of two models:
Single Tier Deployment All platform components, such as App, Web, NATS, DB, and Redis, are installed and run on the same machine.
2-Tier Deployment All components except the Database Layer are installed and run on a single instance, while the Database has its own dedicated instance.
Installation
Before you start
Make sure you have updated package repositories of the Operating System you are using. Please find below the commands for CentOS and Ubuntu:
For CentOS:
yum update
For Ubuntu:
apt-get update
Start and enable Docker service by executing the following command:
systemctl start docker && systemctl enable docker
Single-Tier Deployment
This deployment model installs all components into a single machine.
Method 1: Quick Deployment (preferred method)
Run the one-liner below and wait for it to complete.
curl -fsSL https://cdn.binalyze.com/air-deploy/console.sh | sudo -E bash
Proceed with the Finalizing Setup section.
Method 2: Manual Deployment (use only when required)
Create a folder for the AIR under /opt directory and cd into it
mkdir /opt/binalyze-air && cd /opt/binalyze-air
Download the docker-compose.yml file and save it.
curl -fsSL "https://cdn.binalyze.com/air-deploy/docker-compose.yml" -o docker-compose.yml
Create the directory for the database volume with defined access:
install -d -o 1001 -g 1001 ./volumes/data-master/binalyze-air/{data,log} install -d -o 1001 -g 1001 ./volumes/tornado/{data,config}
Create environment variables:
AIR_POSTGRESQL_PASSWORD=$(head /dev/urandom | tr -dc 'a-zA-Z0-9' | head -c 32) echo "AIR_POSTGRESQL_PASSWORD=$AIR_POSTGRESQL_PASSWORD" >> .env echo "AIR_POSTGRESQL_URI=postgresql://air-data:[email protected]:5432/airdb" >> .env echo "AIR_NATS_PASSWORD=$(head /dev/urandom | tr -dc 'a-zA-Z0-9' | head -c 32)" >> .env
Run the following command to start the AIR installation in Docker:
docker compose -p binalyze-air up -d
Wait for the installation to complete. It may take several minutes.
Proceed with the Finalizing Setup section.
2-Tier Deployment
This deployment model requires you to first deploy the Database Component (Step 1). Once the database is successfully installed and running, you can proceed with the deployment of the Console Server (Step 2). During this step, you will need to provide the IP address of the previously installed Database Server. This sequence is critical, as the Console Server relies on an active and accessible database instance to function correctly.
Method 1: Quick Deployment (preferred method)
Step 1 - On the Database Server: Run the one-liner command below and wait for it to complete (this script will deploy the database component).
curl -fsSL https://cdn.binalyze.com/air-deploy/db.sh | sudo -E bash
Step 2 - On the Console Server: Once the database is deployed, the above script will output the commands that need to be executed on the Console Server machine.
SSH into the Console Server machine.
Run the commands provided by the above script and wait for it to complete.
Proceed with the Finalizing Setup section.
Method 2: Manual Deployment (use only when required)
You should execute the commands below on the Database Server!
SSH into the Database Server.
Create a folder for the AIR DB under /opt directory and cd into it
mkdir /opt/binalyze-air-db && cd /opt/binalyze-air-db
Download the docker compose.yml file and save it.
curl -fsSL "https://cdn.binalyze.com/air-deploy/docker-compose-db.yml" -o docker-compose.yml
Create the directory for the database volume with defined access:
install -d -o 1001 -g 1001 ./volumes/data-master/binalyze-air/{data,log}
Create environment variables.
AIR_POSTGRESQL_PASSWORD=$(head /dev/urandom | tr -dc 'a-zA-Z0-9' | head -c 32) echo "AIR_POSTGRESQL_PASSWORD=$AIR_POSTGRESQL_PASSWORD" >> .env
Run the following command to start the AIR Database component in Docker:
docker compose -p binalyze-air-db up -d
Wait for the installation to complete. It may take several minutes.
Proceed to the installation of the Console Server
You should execute the commands below on the Console Server!
SSH into the Console Server
Create a folder for the AIR under /opt directory and cd into it
mkdir /opt/binalyze-air && cd /opt/binalyze-air
Download the docker-compose.yml file and save it
curl -fsSL "https://cdn.binalyze.com/air-deploy/docker-compose-without-db.yml" -o docker-compose.yml
Create the directory for the volume of the services with defined access:
install -d -o 1001 -g 1001 ./volumes/tornado/{data,config}
Set the database URI for connecting the Console Server to the DB IMPORTANT: &#xNAN;You must fill in the values of the following three variables. We need the passwords created on the DB server and the DB server IP address. &#xNAN;You can find the passwords in the
/opt/binalyze-air-db/.env
file on the DB Server.AIR_POSTGRESQL_PASSWORD= DB_SERVER_IP= echo "AIR_POSTGRESQL_URI=postgresql://air-data:$AIR_POSTGRESQL_PASSWORD@$DB_SERVER_IP:5432/airdb" >> .env echo "AIR_NATS_PASSWORD=$(head /dev/urandom | tr -dc 'a-zA-Z0-9' | head -c 32)" >> .env
Run the following command to start the AIR installation in Docker
docker compose -p binalyze-air up -d
Wait for the installation to complete. It may take several minutes
Proceed with the Finalizing Setup section
Finalizing Setup
Regardless of the deployment model you choose, you will be asked to provide several configurations at the end of the deployment, such as an organization name and the credentials of the first user account.
Once you have completed the above steps successfully, you should:
Visit http://IP-ADDRESS for accessing the Console (IP address here is the public IP address of the machine you have deployed AIR)
Accept the EULA and provide the configuration you are asked for in each step
Complete the setup and log in using the credentials you have provided
Enjoy AIR!
Last updated
Was this helpful?