From 931f3f8ca49c0067110d17480232183defcc8ca4 Mon Sep 17 00:00:00 2001 From: hirzidevs Date: Mon, 16 Sep 2024 21:44:46 +0700 Subject: [PATCH] docs: split guides into separate markdown files from README --- README.md | 167 ++-------------------------- guide/blacklist-specific-nodes.md | 22 ++++ guide/changing-env-configuration.md | 11 ++ guide/docker.md | 26 +++++ guide/getting-channel-id.md | 8 ++ guide/getting-panel-api-key.md | 22 ++++ guide/notifier.md | 33 ++++++ guide/using-custom-emoji.md | 16 +++ 8 files changed, 147 insertions(+), 158 deletions(-) create mode 100644 guide/blacklist-specific-nodes.md create mode 100644 guide/changing-env-configuration.md create mode 100644 guide/docker.md create mode 100644 guide/getting-channel-id.md create mode 100644 guide/getting-panel-api-key.md create mode 100644 guide/notifier.md create mode 100644 guide/using-custom-emoji.md diff --git a/README.md b/README.md index 03c89fe..7956f63 100644 --- a/README.md +++ b/README.md @@ -18,16 +18,13 @@ PteroStats is a Discord App/Bot designed to check Pterodactyl or Pelican Panel s ## Guide - [Starting the App/Bot](#starting-the-appbot) -- [Changing Env Configuration](#changing-env-configuration) -- [Getting an Panel API key](#getting-panel-api-key) -- [Getting a Channel ID](#getting-channel-id) -- [Using Custom Emoji](#using-custom-emoji) -- [Blacklist Nodes](#blacklist-nodes) -- [Notifier](#notifier) -- - [Docker](#docker) - - [Installation](#installation-1) - - [Docker Compose](#docker-compose) - - [Docker Run](#docker-run) +- [Changing Env Configuration](https://github.com/HirziDevs/PteroStats/blob/main/docs/changing-env-configuration.md) +- [Getting an Panel API key](https://github.com/HirziDevs/PteroStats/blob/main/docs/getting-panel-api-key.md) +- [Getting a Channel ID](https://github.com/HirziDevs/PteroStats/blob/main/docs/getting-channel-id.md) +- [Using Custom Emoji](https://github.com/HirziDevs/PteroStats/blob/main/docs/using-custom-emoji.md) +- [Blacklist Nodes](https://github.com/HirziDevs/PteroStats/blob/main/docs/blacklist-specific-nodes.md) +- [Notifier](https://github.com/HirziDevs/PteroStats/blob/main/docs/notifier.md) +- [Docker](https://github.com/HirziDevs/PteroStats/blob/main/docs/docker.md) ### Starting the App/Bot 1. [Create your Discord App/Bot](https://discordjs.guide/preparations/adding-your-bot-to-servers.html). @@ -40,159 +37,13 @@ PteroStats is a Discord App/Bot designed to check Pterodactyl or Pelican Panel s Setup - - [Getting Panel API Key](#getting-panel-api-key) - - [Getting a Channel ID](#getting-channel-id) + - [Getting an Panel API key](https://github.com/HirziDevs/PteroStats/blob/main/docs/getting-panel-api-key.md) + - [Getting a Channel ID](https://github.com/HirziDevs/PteroStats/blob/main/docs/getting-channel-id.md) 6. Run `node index` if you want to start the app/bot again, and you're done! Console Logging -### Changing Env Configuration -> [!TIP] -> You can change other configuration at the `config.yml` file. - -1. Run `node setup` in the root directory of the app/bot files. -2. Enter `2` to change configuration. - - Change Configuration - -3. Answer the provided question to set up the app/bot. -4. Run `node index` if you want to start the app/bot again, and you're done! - -### Getting Panel API Key -> [!WARNING] -> The use of Application API keys is **deprecated**; you should use **Client API keys**. - -> [!TIP] -> Make sure the owner of the Client API key has access to the administrator panel. - -1. Go to your `Pterodactyl` or `Pelican` Panel and navigate to the `Account Page`. - - Home - -2. Click on the `API Credentials` button. - - Account Page - -3. Fill in the `Description` and click the `Create` button. - - Create Client API Key - -4. Copy the API key. - - API Key - -### Getting Channel ID -1. Enable Developer Mode in your Discord settings. - - Discord User Settings - -2. Right-click the text channel and select `Copy ID`. - - Right Click Channel - -### Using Custom Emoji -1. Type `\` in the server that has the custom emoji you want. - - Type \ on the chat - -2. Select the custom emoji you want. - - Select Custom Emoji - -3. Copy the text! - - Copy Emoji ID - -4. Paste the emoji ID into the config. - - Status Config - -### Blacklist Nodes -1. Select a node from the node list on the admin page. - - Pterodactyl Nodes List - - Pelican Nodes List - -2. Check the URL and copy the node ID. - - Pterodactyl Node ID - - Pelican Node ID - -3. Paste the ID into the blacklist in the config. - - Blacklist Config - -> [!TIP] -> You can add more than one node to the blacklist. - -Blacklist Config - -## Links -======= -### Notifier -Get a notification on Discord when your panel or specific nodes are currently down. - -Notifier Preview - - -#### Enabling Notifier -Open `config.yml` and set `enable` at the notifier configuration to `true` - -Notifier Config - -#### Getting Discord Webhook URL -1. Go to the channel settings of the channel you want to set for the notifier. - - Notifier Config - -2. Go to integrations and select `View Webhooks` or `Create Webhook`. - - Notifier Config - -3. Create a new webhook and copy the Webhook URL - - Notifier Config - -4. Paste the Webhook URL on the webhook notifier configuration. - - Notifier Config - - -> [!TIP] -> You can change the webhook icon and username on the webhook settings. - -Notifier Config - -## Docker - -This is a guide to run the bot using docker (alternative way to run the bot) - -### Installation - -```bash -curl -fsSL https://get.docker.com | sh -``` - -### Docker Compose - -Copy the `docker-compose.yml` file to your server and run `docker compose pull` -Copy the `config.yml` file at the same directory as the `docker-compose.yml` file and configure it (refer to the [installation](#installation) section) - -```bash -docker compose up -d -docker compose logs -f pterostats -``` - -### Docker Run - -```bash -docker run -d --name pterostats -v $(pwd)/config.yml:/app/config.yml ghcr.io/hirzidevs/pterostats:latest -docker logs -f pterostats -``` - ## Reporting a Bug Enable `log_error` in the `config.yml` file and check the console for the error message. After that, report it to our Discord server at [Support Server](https://discord.znproject.my.id). diff --git a/guide/blacklist-specific-nodes.md b/guide/blacklist-specific-nodes.md new file mode 100644 index 0000000..ddc534a --- /dev/null +++ b/guide/blacklist-specific-nodes.md @@ -0,0 +1,22 @@ +## Blacklist Specific Nodes + +1. Select a node from the node list on the admin page. + + Pterodactyl Nodes List + + Pelican Nodes List + +2. Check the URL and copy the node ID. + + Pterodactyl Node ID + + Pelican Node ID + +3. Paste the ID into the blacklist in the config. + + Blacklist Config + +> [!TIP] +> You can add more than one node to the blacklist. + +Blacklist Config \ No newline at end of file diff --git a/guide/changing-env-configuration.md b/guide/changing-env-configuration.md new file mode 100644 index 0000000..345d794 --- /dev/null +++ b/guide/changing-env-configuration.md @@ -0,0 +1,11 @@ +## Changing Env Configuration +> [!TIP] +> You can change other configuration at the `config.yml` file. + +1. Run `node setup` in the root directory of the app/bot files. +2. Enter `2` to change configuration. + + Change Configuration + +3. Answer the provided question to set up the app/bot. +4. Run `node index` if you want to start the app/bot again, and you're done! \ No newline at end of file diff --git a/guide/docker.md b/guide/docker.md new file mode 100644 index 0000000..15a65cd --- /dev/null +++ b/guide/docker.md @@ -0,0 +1,26 @@ +## Docker + +This is a guide to run the bot using docker (alternative way to run the bot). + +### Installation + +```bash +curl -fsSL https://get.docker.com | sh +``` + +### Docker Compose + +- Copy the `docker-compose.yml` file to your server and run `docker compose pull` +- Copy the `config.yml` file at the same directory as the `docker-compose.yml` file and configure it (refer to the [Starting the App/Bot](https://github.com/HirziDevs/PteroStats#starting-the-appbot) section) + + ```bash + docker compose up -d + docker compose logs -f pterostats + ``` + +### Docker Run + +```bash +docker run -d --name pterostats -v $(pwd)/config.yml:/app/config.yml ghcr.io/hirzidevs/pterostats:latest +docker logs -f pterostats +``` \ No newline at end of file diff --git a/guide/getting-channel-id.md b/guide/getting-channel-id.md new file mode 100644 index 0000000..58055f2 --- /dev/null +++ b/guide/getting-channel-id.md @@ -0,0 +1,8 @@ +## Getting Channel ID +1. Enable Developer Mode in your Discord settings. + + Discord User Settings + +2. Right-click the text channel and select `Copy ID`. + + Right Click Channel \ No newline at end of file diff --git a/guide/getting-panel-api-key.md b/guide/getting-panel-api-key.md new file mode 100644 index 0000000..5e9903c --- /dev/null +++ b/guide/getting-panel-api-key.md @@ -0,0 +1,22 @@ +## Getting Panel API Key +> [!WARNING] +> The use of Application API keys is **deprecated**; you should use **Client API keys**. + +> [!TIP] +> Make sure the owner of the Client API key has access to the administrator panel. + +1. Go to your `Pterodactyl` or `Pelican` Panel and navigate to the `Account Page`. + + Home + +2. Click on the `API Credentials` button. + + Account Page + +3. Fill in the `Description` and click the `Create` button. + + Create Client API Key + +4. Copy the API key. + + API Key \ No newline at end of file diff --git a/guide/notifier.md b/guide/notifier.md new file mode 100644 index 0000000..fec6db9 --- /dev/null +++ b/guide/notifier.md @@ -0,0 +1,33 @@ +## Notifier +Get a notification on Discord when your panel or specific nodes are currently down. + +Notifier Preview + + +### Enabling Notifier +Open `config.yml` and set `enable` at the notifier configuration to `true` + +Notifier Config + +### Getting Discord Webhook URL +1. Go to the channel settings of the channel you want to set for the notifier. + + Notifier Config + +2. Go to integrations and select `View Webhooks` or `Create Webhook`. + + Notifier Config + +3. Create a new webhook and copy the Webhook URL + + Notifier Config + +4. Paste the Webhook URL on the webhook notifier configuration. + + Notifier Config + + +> [!TIP] +> You can change the webhook icon and username on the webhook settings. + +Notifier Config \ No newline at end of file diff --git a/guide/using-custom-emoji.md b/guide/using-custom-emoji.md new file mode 100644 index 0000000..6ec5d1f --- /dev/null +++ b/guide/using-custom-emoji.md @@ -0,0 +1,16 @@ +## Using Custom Emoji +1. Type `\` in the server that has the custom emoji you want. + + Type \ on the chat + +2. Select the custom emoji you want. + + Select Custom Emoji + +3. Copy the text! + + Copy Emoji ID + +4. Paste the emoji ID into the config. + + Status Config \ No newline at end of file