diff --git a/docs/api/options/jvm.md b/docs/api/options/jvm.md index e4a549a3..10d223cc 100644 --- a/docs/api/options/jvm.md +++ b/docs/api/options/jvm.md @@ -11,4 +11,13 @@ To include the API in your Maven project, add the following dependency to your ` api 0.1.0-SNAPSHOT +``` + +## Gradle +To include the API in your Gradle project, add the following dependency to your `build.gradle` file: + +```kotlin +dependencies { + implementation("io.atomic.cloud:api:0.1.0-SNAPSHOT") +} ``` \ No newline at end of file diff --git a/docs/cli/index.md b/docs/cli/index.md index 863c0866..5d55250b 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -1,5 +1,18 @@ -# CLI 🚧 +# CLI -This page is currently a work in progress. +This page provides instructions on how to download and use the CLI for controlling the controller. -We’re actively working to provide accurate and useful content here. Please check back soon for updates +## Download the CLI + +You can download the latest CLI binary from the [GitHub releases page](https://github.com/HttpRafa/atomic-cloud/releases/). + +## Installation + +1. Download the appropriate binary for your operating system. +2. Place the binary in a directory that is included in your system's PATH. + +## Usage + +Run the CLI from your terminal and follow the instructions provided by the CLI to control the controller. + +We’re actively working to provide more detailed and useful content here. Please check back soon for updates. \ No newline at end of file diff --git a/docs/controller/drivers/wasm/local/index.md b/docs/controller/drivers/wasm/local/index.md new file mode 100644 index 00000000..685f488d --- /dev/null +++ b/docs/controller/drivers/wasm/local/index.md @@ -0,0 +1,5 @@ +# Installation + +1. Download the `local-driver.wasm` file from the [GitHub releases page](https://github.com/HttpRafa/atomic-cloud/releases/). +2. Place the downloaded file into the `drivers` directory. +3. Start the controller. \ No newline at end of file diff --git a/docs/controller/drivers/wasm/pterodactyl/index.md b/docs/controller/drivers/wasm/pterodactyl/index.md new file mode 100644 index 00000000..80381cb4 --- /dev/null +++ b/docs/controller/drivers/wasm/pterodactyl/index.md @@ -0,0 +1,5 @@ +# Installation + +1. Download the `pterodactyl-driver.wasm` file from the [GitHub releases page](https://github.com/HttpRafa/atomic-cloud/releases/). +2. Place the downloaded file into the `drivers` directory. +3. Start the controller. \ No newline at end of file diff --git a/docs/controller/installation/docker.md b/docs/controller/installation/docker.md index f890618d..d83f7961 100644 --- a/docs/controller/installation/docker.md +++ b/docs/controller/installation/docker.md @@ -30,10 +30,3 @@ To start the container, execute the following command: ```bash docker compose up ``` - -## Step 3: Retrieve the Admin Token -Upon the initial run of the controller, an admin token will be displayed. This token is required to connect using the CLI. For further details, refer to [How to use the CLI](/cli/). -![First Startup](docker/first_startup.png) - -## Step 4: Retrieve the Admin Token Later (If Needed) -In case you lose the token, it can be retrieved from the default admin user's file located in the `auth/users` directory. diff --git a/docs/controller/installation/normal.md b/docs/controller/installation/normal.md index 62203536..8d2fb58b 100644 --- a/docs/controller/installation/normal.md +++ b/docs/controller/installation/normal.md @@ -1,5 +1,7 @@ # Normal 🚧 -This page is currently a work in progress. +This page is currently a work in progress. -We’re actively working to provide accurate and useful content here. Please check back soon for updates +For the latest releases and updates, please visit our [GitHub release page](https://github.com/HttpRafa/atomic-cloud/releases/). + +We’re actively working to provide accurate and useful content here. Please check back soon for updates. \ No newline at end of file diff --git a/docs/controller/installation/docker/first_startup.png b/docs/controller/usage/images/first_startup.png similarity index 100% rename from docs/controller/installation/docker/first_startup.png rename to docs/controller/usage/images/first_startup.png diff --git a/docs/controller/usage/retrieve_token.md b/docs/controller/usage/retrieve_token.md new file mode 100644 index 00000000..c46041d5 --- /dev/null +++ b/docs/controller/usage/retrieve_token.md @@ -0,0 +1,7 @@ +## Retrieve the Admin Token on First Launch +When you run the controller for the first time, an admin token will be displayed. You will need this token to connect via the CLI. For more information, see [How to use the CLI](/cli/). + +![First Startup](images/first_startup.png) + +## Retrieve the Admin Token After the First Launch +If you lose the token, you can retrieve it from the default admin user's file, located in the `auth/users` directory.