From d78bf1e5045d4c858fa460213ab1c126839ba4b1 Mon Sep 17 00:00:00 2001 From: Rafael <60099368+HttpRafa@users.noreply.github.com> Date: Fri, 10 Jan 2025 10:28:36 +0100 Subject: [PATCH 1/8] Update docker.md --- docs/controller/installation/docker.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/controller/installation/docker.md b/docs/controller/installation/docker.md index f890618d..018cd902 100644 --- a/docs/controller/installation/docker.md +++ b/docs/controller/installation/docker.md @@ -33,6 +33,7 @@ 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) From 551080a8d66699dab124c7a7c26958a564f85420 Mon Sep 17 00:00:00 2001 From: Rafael <60099368+HttpRafa@users.noreply.github.com> Date: Fri, 10 Jan 2025 10:32:17 +0100 Subject: [PATCH 2/8] Update docker.md --- docs/controller/installation/docker.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/docs/controller/installation/docker.md b/docs/controller/installation/docker.md index 018cd902..302c143c 100644 --- a/docs/controller/installation/docker.md +++ b/docs/controller/installation/docker.md @@ -29,12 +29,4 @@ services: 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. +`` From 5ae019ae6de97b234cdbb151e9116a846f2e9172 Mon Sep 17 00:00:00 2001 From: Rafael <60099368+HttpRafa@users.noreply.github.com> Date: Fri, 10 Jan 2025 10:34:24 +0100 Subject: [PATCH 3/8] Update docker.md --- docs/controller/installation/docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/controller/installation/docker.md b/docs/controller/installation/docker.md index 302c143c..d83f7961 100644 --- a/docs/controller/installation/docker.md +++ b/docs/controller/installation/docker.md @@ -29,4 +29,4 @@ services: To start the container, execute the following command: ```bash docker compose up -`` +``` From 3bc7b0a4a4be8f4564233ae695430de40ae6489f Mon Sep 17 00:00:00 2001 From: Rafael <60099368+HttpRafa@users.noreply.github.com> Date: Fri, 10 Jan 2025 10:38:57 +0100 Subject: [PATCH 4/8] Create retrieve-token --- docs/controller/usage/retrieve-token | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 docs/controller/usage/retrieve-token diff --git a/docs/controller/usage/retrieve-token b/docs/controller/usage/retrieve-token new file mode 100644 index 00000000..c46041d5 --- /dev/null +++ b/docs/controller/usage/retrieve-token @@ -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. From 142e91ebca7d821bb110270ffdba822eb0b27247 Mon Sep 17 00:00:00 2001 From: Rafael <60099368+HttpRafa@users.noreply.github.com> Date: Fri, 10 Jan 2025 10:39:22 +0100 Subject: [PATCH 5/8] Rename retrieve-token to retrieve-token.md --- docs/controller/usage/{retrieve-token => retrieve-token.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/controller/usage/{retrieve-token => retrieve-token.md} (100%) diff --git a/docs/controller/usage/retrieve-token b/docs/controller/usage/retrieve-token.md similarity index 100% rename from docs/controller/usage/retrieve-token rename to docs/controller/usage/retrieve-token.md From 25788bec7be01ef3b08373166b2a280abb9fd950 Mon Sep 17 00:00:00 2001 From: Rafael <60099368+HttpRafa@users.noreply.github.com> Date: Fri, 10 Jan 2025 10:41:06 +0100 Subject: [PATCH 6/8] Rename first_startup.png to first_startup.png --- .../docker => usage/images}/first_startup.png | Bin 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/controller/{installation/docker => usage/images}/first_startup.png (100%) 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 From 43591decdb250eebe5e403b44a93808e0e4bf796 Mon Sep 17 00:00:00 2001 From: Rafael <60099368+HttpRafa@users.noreply.github.com> Date: Fri, 10 Jan 2025 10:41:34 +0100 Subject: [PATCH 7/8] Rename retrieve-token.md to retrieve_token.md --- docs/controller/usage/{retrieve-token.md => retrieve_token.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/controller/usage/{retrieve-token.md => retrieve_token.md} (100%) diff --git a/docs/controller/usage/retrieve-token.md b/docs/controller/usage/retrieve_token.md similarity index 100% rename from docs/controller/usage/retrieve-token.md rename to docs/controller/usage/retrieve_token.md From e178e9960e91a7f31fa9c36fead2761465509d14 Mon Sep 17 00:00:00 2001 From: HttpRafa <60099368+HttpRafa@users.noreply.github.com> Date: Sat, 25 Jan 2025 20:24:44 +0100 Subject: [PATCH 8/8] feat: Improve docs --- docs/api/options/jvm.md | 9 +++++++++ docs/cli/index.md | 19 ++++++++++++++++--- docs/controller/drivers/wasm/local/index.md | 5 +++++ .../drivers/wasm/pterodactyl/index.md | 5 +++++ docs/controller/installation/normal.md | 6 ++++-- 5 files changed, 39 insertions(+), 5 deletions(-) create mode 100644 docs/controller/drivers/wasm/local/index.md create mode 100644 docs/controller/drivers/wasm/pterodactyl/index.md 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/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