# Getting Started

## Prerequisites

Before using Axilon AI Desktop, ensure the following are in place:

| Requirement              | Details                                                                                                                                                                                                                                                  |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Docker**               | Docker Desktop (or Docker Engine) must be installed and running on your machine. The application uses Docker to run Ignition gateway containers.                                                                                                         |
| **Ignition Gateway**     | A running Ignition gateway that is accessible from the current machine on the network. The gateway is used as the backend for the Designer session.                                                                                                      |
| **Administrator Access** | The application must be run as an administrator (elevated privileges) to manage Docker containers and network resources.                                                                                                                                 |
| **Gateway Backup**       | A `.gwbk` (Ignition Gateway backup) file is required to start a new container. This file initializes the gateway with your project configuration.                                                                                                        |
| **Network Ports**        | The default ports (8090/8091 for the gateway, 6080/6081 for the display) must be available. You can configure custom ports if these are in use.                                                                                                          |
| **Global Settings**      | On first launch, you will be prompted to configure global settings (AI provider, workspace directory). Complete this setup before starting a container. See [Configuring Global Settings](https://docs.axilon.com/settings#configuring-global-settings). |

## The Docker Start Page

When you first open Axilon AI Desktop (or when no Docker container is connected), the center panel displays the **Docker Start Page**. This page has two tabs:

* **Continue Existing** -- Reconnect to a running Ignition container.
* **Start New** -- Launch a fresh Ignition container.

***

## Starting a New Container

### Steps

1. On the Docker Start Page, select the **Start New** tab.
2. Choose an **Ignition Version**:

   | Version   | Description              |
   | --------- | ------------------------ |
   | **8.1**   | Long Term Support        |
   | **8.3.3** | Latest Supported Release |
3. Select a **Gateway Backup** (`.gwbk` file) by clicking the folder icon. This file is required to initialize the gateway.
4. Optionally configure **Container Settings**:
   * **Instance Name** -- A label for the container (default: `axilon`). The full container name follows the pattern `{instanceName}-ignition-{version}`.
   * **Gateway Port** -- The host port mapped to the Ignition gateway.
   * **Display Port** -- The host port mapped to the noVNC display.
   * **Port Forwarding** -- Comma-separated list of additional host ports forwarded to the container (e.g., `4840, 5432, 1883`).
5. Review any warnings:
   * A **container name conflict** warning appears if a container with the same name is already running. Starting will replace it.
   * A **port conflict** warning appears if the chosen ports are in use by another container.
6. Click **"Start Gateway"** (or **"Replace & Start Gateway"** if there is a name conflict).
7. A loading screen appears while the container initializes. Once complete, the Ignition Designer loads in the center panel.

### If Starting Fails

An error banner is displayed with the failure message. Review the error, correct any issues (e.g., Docker not running, port conflicts), and try again.

***

## Reconnecting to an Existing Container

### Before You Begin

At least one Ignition container must be running.

### Steps

1. On the Docker Start Page, the **Continue Existing** tab is selected by default.
2. If running containers are found, select one from the **Container** dropdown.
3. Review the container details: version, gateway port, and display port.
4. Click **"Connect"**.
5. Once connected, the Ignition Designer loads in the center panel.

If no running containers are found, a message prompts you to start a new one or click **"Refresh"** to re-scan.