When installing BRIX AI using Docker Compose, all components are deployed as containers on a single server. This deployment option is suitable only for test environments, as it does not support microservice scaling. An internet connection is required for installation.
Before you begin, make sure that:
- Docker and Docker Compose are installed.
- You have downloaded the installation files.
- You have configured environment variables.
Please note:
- MongoDB replication requires an internal authentication key for database nodes. It is created automatically during installation.
- If you use self-signed certificates, export the root certificate after installation to add it to your list of trusted certificates.
Install BRIX AI
To install BRIX AI using Docker Compose:
- Run the installation script:
chmod +x install.sh
./install.sh
If you use multiple instances of BRIX AI and need to specify a project name, use the following parameter:
./install.sh --project-name my-cortex
- After running the install.sh script, some services may take a few minutes to start up completely. To check if the services are ready, run the following command:
docker ps
- Wait until the message “Application startup complete” appears in the logs.
Create a key for MongoDB
During the installation of BRIX AI, the install.sh script automatically generates an authentication key used for replication of the built-in MongoDB service. File access permissions are assigned automatically.
If you need to generate a new key manually, run the following commands:
openssl rand -base64 756 > mongo.keyfile
sudo chown 999:999 mongo.keyfile
sudo chmod 400 mongo.keyfile
Export the Caddy root certificate
If you selected Internal as the TLS certificate management mode, export the Caddy root certificate to add it to your trusted certificates:
docker exec $(docker ps -q -f name=caddy) cat /data/caddy/pki/authorities/local/root.crt > caddy_root.crt
BRIX AI installation is complete. Now you can set up its integration with BRIX.
If errors occur, run diagnostics.
Update BRIX AI
When a new version of BRIX AI is released, save your current configuration and perform the update. To learn more, see Update BRIX AI using Docker Compose.
Uninstall BRIX AI
Installing BRIX AI is described in Delete BRIX AI when using Docker Compose.