> For the complete documentation index, see [llms.txt](https://docs.aquilax.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.aquilax.ai/user-manual/install-aquilax.md).

# Install AquilaX

The **AquilaX** solution consists of 4 key components, each responsible for specific tasks. These components work together 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 back to the AquilaX Server.
3. **AquilaX AI** : Specialized AI-powered models 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.
4. **On-Prem AI Models**: These are not developed by AquilaX itself, but are open source models that are light and small to be used in CPU and GPU with limited resources, however are tuned by AquilaX to perform better within the AppSec use cases.

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.

<img src="/files/MtvLmQADutytWIH5NDg4" alt="" class="gitbook-drawing">

## Prerequisite

1. To prepare for the installation of various AquilaX components, you can structure the deployment using a dedicated Virtual Machines. However depending of the demand of usage, the solution can be scaled to more machines to offload the compute needs
2. Install on all of them `Docker` and `Docker Compose`: [Install Docker and docker compose](/user-manual/install-aquilax/install-docker-and-docker-compose.md)
3. To have the application up and running you will need 3 secret keys from AquilaX Team
   1. **Deployment Key** to access the container images
   2. **Running Key** for the Application to run in your environment
   3. **License Key** to able to have the full functionalities (ultimate or premium version)

The required dedicated VMs must have at least the below capacities to be able to work correctly

<table><thead><tr><th width="140.359375">VM</th><th>CPU/GPU (min)</th><th width="123.40234375">RAM (min)</th><th>Storage</th><th>Network</th></tr></thead><tbody><tr><td>AquilaX Server</td><td>32 vCPU</td><td>48 GB</td><td>240 GB SSD</td><td>SSH / HTTPs</td></tr></tbody></table>

## Setup AquilaX Server

Sign in to the Server VM and run the command below. It sets up the environment with the initial folders, files, and so on. You can review the code that gets downloaded and executed here: <https://gitlab.com/aquila-x/install-on-prem>

The command will prompt you for a **RUNNING KEY**, **SMTP settings**, and other configuration. AquilaX will provide the Running Key. SMTP is required for sign-in (magic link)

```bash
curl -fsSL https://gitlab.com/aquila-x/install-on-prem/-/raw/main/setup.sh | bash
```

### Start the service

When you have the setup done done, request a **deployment key** from AquilaX and execute the below commands

```bash
docker login registry.gitlab.com
docker compose pull
docker compose up -d
```

### Go

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

<figure><img src="/files/ubjpiOqUAUvHz4G9iLvJ" alt=""><figcaption><p>Landing Page AquilaX On-Prem</p></figcaption></figure>

### License Application

Once you are inside the application, create a personal access token, you will need this for the worker. In addition go into the settings of your new organization and apply a license key, the license key will be provided to you by the the AquilaX team.

<figure><img src="/files/bPUGmFTIFpWfigBR5LBj" alt="" width="375"><figcaption></figcaption></figure>

{% hint style="warning" %}
AI Models within pure CPU environment maybe slow!
{% endhint %}

{% hint style="info" %}
Contact a member of AquilaX if you need help for the installation or configuration. Is strongly suggested to do the installation of the environment together with AquilaX Engineering team. Please contact us at. <https://aquilax.ai/contact>
{% endhint %}