|
| 1 | +# What is the Controller? |
| 2 | + |
| 3 | +The **Controller** is a vital component of Atomic Cloud. It acts as the central management server by: |
| 4 | + |
| 5 | +- **Overseeing Nodes:** |
| 6 | + It monitors and manages the nodes. |
| 7 | + |
| 8 | +- **Managing Servers:** |
| 9 | + It is responsible for initiating and supervising the servers launched by the cloud. |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +# Docker Installation (Recommended) |
| 14 | + |
| 15 | +The most straightforward method to install the controller is by utilizing a Docker image. Follow the steps below to set it up using Docker Compose: |
| 16 | + |
| 17 | +## Step 1: Create the `docker-compose.yml` File |
| 18 | +First, use a text editor to create the `docker-compose.yml` file: |
| 19 | +```bash |
| 20 | +nano docker-compose.yml |
| 21 | +``` |
| 22 | +Next, add the following content to the file: |
| 23 | +```yaml |
| 24 | +services: |
| 25 | + controller: |
| 26 | + image: ghcr.io/httprafa/atomic-cloud:latest |
| 27 | + ports: |
| 28 | + - "8080:8080" |
| 29 | + environment: |
| 30 | + - PTERODACTYL=true # Enable Pterodactyl plugin installation |
| 31 | + - LOCAL=true # Enable Local plugin installation |
| 32 | + volumes: |
| 33 | + - ./certs:/app/certs |
| 34 | + - ./configs:/app/configs |
| 35 | + - ./groups:/app/groups |
| 36 | + - ./logs:/app/logs |
| 37 | + - ./nodes:/app/nodes |
| 38 | + - ./plugins:/app/plugins |
| 39 | + - ./users:/app/users |
| 40 | + - ./data:/app/data |
| 41 | +``` |
| 42 | +
|
| 43 | +## Step 2: Start the Container |
| 44 | +To start the container, execute the following command: |
| 45 | +```bash |
| 46 | +docker compose up |
| 47 | +``` |
| 48 | + |
| 49 | +--- |
| 50 | + |
| 51 | +# Manual Installation |
| 52 | + |
| 53 | +Follow the steps below to manually install Atomic Cloud. |
| 54 | + |
| 55 | +## Step 1: Download the CLI and Controller |
| 56 | + |
| 57 | + Download the latest release from our [GitHub releases page](https://github.com/HttpRafa/atomic-cloud/releases). |
| 58 | + |
| 59 | + **Controller:** Choose the version that corresponds to the operating system where the Controller will run. |
| 60 | + |
| 61 | + **CLI:** Choose the version that matches the operating system on your local machine, from which you will manage the cloud. |
| 62 | + |
| 63 | +## Step 2: Start the Controller |
| 64 | + |
| 65 | +1. Open a terminal and navigate to the directory where the Controller is located. |
| 66 | +2. Start the Controller. |
| 67 | +3. **Important:** After startup, note the authentication token that is displayed. You will need this token later. |
| 68 | + If you lose the token, you can retrieve it from our [token retrieval guide](../usage/controller/retrieve_token.md). |
| 69 | + |
| 70 | +## Step 3: Download and Install the Plugin |
| 71 | + |
| 72 | +1. Download the latest plugin version from our [GitHub releases page](https://github.com/HttpRafa/atomic-cloud/releases). |
| 73 | +2. Place the plugin file into the `plugins` folder. |
| 74 | +3. Restart the Controller to load the new plugin. |
| 75 | + |
| 76 | +## Step 4: Start the CLI |
| 77 | + |
| 78 | +1. Open a terminal on your local device where you want to control the cloud. |
| 79 | +2. Start the CLI application. |
| 80 | +3. When prompted, select **"Add new controller"** and follow the on-screen instructions to complete the setup. |
0 commit comments