Install AquilaX

How to prepare and install AquilaX On-Prem / Cloud or your VM

The AquilaX solution consists of several key components, each responsible for specific tasks. These components work together seamlessly to deliver comprehensive security scanning and intelligence.

1. AquilaX Server: Manages the API and User Interface (UI) of the service, acting as the central control point for all operations.

2. AquilaX Worker: Responsible for executing the actual security scans, performing the analysis and reporting vulnerabilities.

3. AquilaX GenAI Services: Specialized AI-powered modules designed to assist with decision-making and emulate human logic in engineering tasks. These models enhance the solution’s ability to reason, automate processes, and build intelligent responses.

Below is a diagram illustrating the relationship between these components. Following the diagram, you’ll find instructions on how to set up the solution in a dedicated environment.

Prerequisite

1. Install Docker and Docker Compose: https://docs.docker.com/engine/install/

2. Execute and follow the instruction of the command docker login registry.gitlab.com

Configuration

Create a new file named docker-compose.yml and paste the following:

docker-compose.yml

services:
  aquilax-server:
    image: registry.gitlab.com/aquila-x/aquilax-server
    restart: always
    deploy:
      mode: replicated
      replicas: 1
      endpoint_mode: dnsrr
    depends_on:
      - mongo
    ports:
      - 8000:8000
    env_file:
      - .env
    entrypoint: ["python3","app.py"]

  aquilax-jobs:
    image: registry.gitlab.com/aquila-x/aquilax-server
    restart: always
    depends_on:
      - mongo
    env_file:
      - .env
    entrypoint: ["python3","jobs.py"]

  aquilax-worker:
    image: registry.gitlab.com/aquila-x/aquilax-worker
    restart: always
    deploy:
      mode: replicated
      replicas: 1
    depends_on:
      - aquilax-server
    env_file:
      - .env
    entrypoint: ["python3","app.py"]

  mongo:
    image: mongo:8.0.0
    volumes:
      - ./data:/data/db

Create a new file in the same directory named .env where we going to store some configuration needed for the application to start properly, paste the below content

.env

MONGODB_URI=mongodb://mongo:27017/
KL_SERVER=https://auth.aquilax.ai/
KL_CLIENT_ID=aquilax
KL_REALM=aquilax
KC_CLIENT_SECRET=
CALLBACK_URI=https://<your-own-ip>/callback

X_AQUILAX_WORKER=X_AQUILAX_WORKER

MAIL_USERNAME=
MAIL_PASSWORD=
MAIL_FROM=
MAIL_PORT=
MAIL_SERVER=
MAIL_FROM_NAME='AquilaX Security'

JWT_SIGING_TOKEN=

GENAI_ENDPOINT=http://aquilax-genai:9000
GENAI_ENDPOINT_QUERY=http://aquilax-genai-query:9001
GENAI_ENDPOINT_CLASSIFICATION=http://aquilax-genai-class:9002
GENAI_ENDPOINT_QNA=http://aquilax-genai-qna:9003


POSTGRES_USER=
POSTGRES_PASSWORD=
POSTGRES_HOST=
POSTGRES_PORT=
POSTGRES_DB=aquilax

SCHEDULER_ENDPOINT=http://aquilax-jobs:8001

GENAI_AX_KEY=

X_AX_KEY=<your own key>
AQUILAX_SERVER=http://aquilax-server:8000/api/v1
HEARBEAT_CODE=
X_AQUILAX_WORKER=X_AQUILAX_WORKER

Start the service

Finally when you have these 2 files in the intended folder, just start everything up by executing:

docker compose pull
docker compose up -d

Go

Now you can signing into the service just by navigating at http://<your own ip>:8000

Contact a member of AquilaX if you need help for the installation or configuration