mirror of
https://github.com/HirziDevs/PteroStats
synced 2026-01-03 11:45:41 +00:00
docs: split guides into separate markdown files from README
This commit is contained in:
22
guide/blacklist-specific-nodes.md
Normal file
22
guide/blacklist-specific-nodes.md
Normal file
@@ -0,0 +1,22 @@
|
||||
## Blacklist Specific Nodes
|
||||
|
||||
1. Select a node from the node list on the admin page.
|
||||
|
||||
<img alt="Pterodactyl Nodes List" src="https://usercontent.catto.pictures/hirzi/5699fdbd-7c3c-4fa5-ae2c-d0ccb39cb69e.png" width="400"/>
|
||||
|
||||
<img alt="Pelican Nodes List" src="https://usercontent.catto.pictures/hirzi/5994fbf0-03ac-4196-9bb5-e945401f204e.png" width="400"/>
|
||||
|
||||
2. Check the URL and copy the node ID.
|
||||
|
||||
<img alt="Pterodactyl Node ID" src="https://usercontent.catto.pictures/hirzi/45f855fc-6d96-4b23-a96e-892071189d01.png" width="400"/>
|
||||
|
||||
<img alt="Pelican Node ID" src="https://usercontent.catto.pictures/hirzi/0ff8d9fc-6125-4fbb-8e19-ff8743cd365c.png" width="400"/>
|
||||
|
||||
3. Paste the ID into the blacklist in the config.
|
||||
|
||||
<img alt="Blacklist Config" src="https://usercontent.catto.pictures/hirzi/bfae6a04-8dad-4db1-b3d8-05e6db691516.png" width="400"/>
|
||||
|
||||
> [!TIP]
|
||||
> You can add more than one node to the blacklist.
|
||||
|
||||
<img alt="Blacklist Config" src="https://usercontent.catto.pictures/hirzi/7b5d6c7f-54d9-40ea-b5a6-9192325ba2a0.png" width="400"/>
|
||||
11
guide/changing-env-configuration.md
Normal file
11
guide/changing-env-configuration.md
Normal file
@@ -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.
|
||||
|
||||
<img alt="Change Configuration" src="https://usercontent.catto.pictures/hirzi/f61ebf43-3df8-4b86-93ac-166e2de1edcd.png" width="300"/>
|
||||
|
||||
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!
|
||||
26
guide/docker.md
Normal file
26
guide/docker.md
Normal file
@@ -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
|
||||
```
|
||||
8
guide/getting-channel-id.md
Normal file
8
guide/getting-channel-id.md
Normal file
@@ -0,0 +1,8 @@
|
||||
## Getting Channel ID
|
||||
1. Enable Developer Mode in your Discord settings.
|
||||
|
||||
<img alt="Discord User Settings" src="https://usercontent.catto.pictures/hirzi/36894499-b141-488f-98ed-40245c8f6862.png" width="400"/>
|
||||
|
||||
2. Right-click the text channel and select `Copy ID`.
|
||||
|
||||
<img alt="Right Click Channel" src="https://usercontent.catto.pictures/hirzi/9f8352da-df5b-4587-9594-ced9b11a5507.png" width="250"/>
|
||||
22
guide/getting-panel-api-key.md
Normal file
22
guide/getting-panel-api-key.md
Normal file
@@ -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`.
|
||||
|
||||
<img alt="Home" src="https://usercontent.catto.pictures/hirzi/6d3e4c63-c5e8-4d94-9d78-07bb937b1dbd.png" width="400"/>
|
||||
|
||||
2. Click on the `API Credentials` button.
|
||||
|
||||
<img alt="Account Page" src="https://usercontent.catto.pictures/hirzi/0a2327ee-243a-4dd1-86f4-549f1ab8a91c.png" width="400"/>
|
||||
|
||||
3. Fill in the `Description` and click the `Create` button.
|
||||
|
||||
<img alt="Create Client API Key" src="https://usercontent.catto.pictures/hirzi/7fcf5b7e-0087-4cf2-9e57-fed01292fd10.png" width="400"/>
|
||||
|
||||
4. Copy the API key.
|
||||
|
||||
<img alt="API Key" src="https://usercontent.catto.pictures/hirzi/267cf48a-7229-4bb6-8c77-7d0c0884f6ba.png" width="400"/>
|
||||
33
guide/notifier.md
Normal file
33
guide/notifier.md
Normal file
@@ -0,0 +1,33 @@
|
||||
## Notifier
|
||||
Get a notification on Discord when your panel or specific nodes are currently down.
|
||||
|
||||
<img alt="Notifier Preview" src="https://usercontent.catto.pictures/hirzi/a2b8e36f-7448-4849-a14a-b1eb4ec8fb26.png" width="250"/>
|
||||
|
||||
|
||||
### Enabling Notifier
|
||||
Open `config.yml` and set `enable` at the notifier configuration to `true`
|
||||
|
||||
<img alt="Notifier Config" src="https://usercontent.catto.pictures/hirzi/b4c3f1d0-e053-402c-8401-4de44926fce6.png" width="300"/>
|
||||
|
||||
### Getting Discord Webhook URL
|
||||
1. Go to the channel settings of the channel you want to set for the notifier.
|
||||
|
||||
<img alt="Notifier Config" src="https://usercontent.catto.pictures/hirzi/7d7712b9-d9ac-4650-83ac-21dc3f20c3fe.png" width="300"/>
|
||||
|
||||
2. Go to integrations and select `View Webhooks` or `Create Webhook`.
|
||||
|
||||
<img alt="Notifier Config" src="https://usercontent.catto.pictures/hirzi/e251f1e9-6b46-4051-be64-1945a6eaee33.png" width="300"/>
|
||||
|
||||
3. Create a new webhook and copy the Webhook URL
|
||||
|
||||
<img alt="Notifier Config" src="https://usercontent.catto.pictures/hirzi/e0af8410-527a-42e2-b284-48d7eb81456f.png" width="300"/>
|
||||
|
||||
4. Paste the Webhook URL on the webhook notifier configuration.
|
||||
|
||||
<img alt="Notifier Config" src="https://usercontent.catto.pictures/hirzi/b4ec26ad-e426-434e-b8c8-27ddc2916f5f.png" width="300"/>
|
||||
|
||||
|
||||
> [!TIP]
|
||||
> You can change the webhook icon and username on the webhook settings.
|
||||
|
||||
<img alt="Notifier Config" src="https://usercontent.catto.pictures/hirzi/2a4f7aba-9377-4722-bf19-3b7f0cc32772.png" width="300"/>
|
||||
16
guide/using-custom-emoji.md
Normal file
16
guide/using-custom-emoji.md
Normal file
@@ -0,0 +1,16 @@
|
||||
## Using Custom Emoji
|
||||
1. Type `\` in the server that has the custom emoji you want.
|
||||
|
||||
<img alt="Type \ on the chat" src="https://usercontent.catto.pictures/hirzi/2e3c821f-92f9-4b5c-863a-e020b2fbc426.png" width="350"/>
|
||||
|
||||
2. Select the custom emoji you want.
|
||||
|
||||
<img alt="Select Custom Emoji" src="https://usercontent.catto.pictures/hirzi/7c071727-2adb-4c8c-91d3-21664948a334.png" width="300"/>
|
||||
|
||||
3. Copy the text!
|
||||
|
||||
<img alt="Copy Emoji ID" src="https://usercontent.catto.pictures/hirzi/bd0084ac-f11b-413d-8b66-580efc011908.png" width="400"/>
|
||||
|
||||
4. Paste the emoji ID into the config.
|
||||
|
||||
<img alt="Status Config" src="https://usercontent.catto.pictures/hirzi/369cf7af-ae32-4193-9b09-195ba6f71f62.png" width="400"/>
|
||||
Reference in New Issue
Block a user