mirror of
https://github.com/HirziDevs/PteroStats
synced 2026-01-08 15:21:50 +00:00
docs: improve readme and guide
This commit is contained in:
@@ -1,15 +1,13 @@
|
||||
## Changing Env Configuration
|
||||
|
||||
> [!TIP]
|
||||
> You can change other configuration at the `config.yml` file.
|
||||
|
||||
1. Delete `.setup-complete` file in the root directory of the app/bot files.
|
||||
2. Run `node index.js` and answer the prompted questions to set up the app/bot.
|
||||
|
||||
2. Restart the server and answer the prompted questions to set up the app/bot.
|
||||
|
||||
<img alt="Setup" src="https://usercontent.catto.pictures/hirzi/b8645828-591d-4d52-b6d8-51f8df60440c.png" width="300"/>
|
||||
|
||||
- [How to get Panel API key](https://github.com/HirziDevs/PteroStats/blob/main/guide/panel-api-key.md)
|
||||
- [How to get Channel ID](https://github.com/HirziDevs/PteroStats/blob/main/guide/channel-id.md)
|
||||
|
||||
3. Run `node index.js` if you want to start the app/bot again, and you're done!
|
||||
|
||||
<img alt="Console Logging" src="https://usercontent.catto.pictures/hirzi/8ce3aac6-5c46-4626-bd14-af994b602f8e.png" width="300"/>
|
||||
- [How to get Channel ID](https://github.com/HirziDevs/PteroStats/blob/main/guide/channel-id.md)
|
||||
@@ -1,4 +1,5 @@
|
||||
## 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"/>
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
## 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"/>
|
||||
|
||||
44
guide/installation/egg.md
Normal file
44
guide/installation/egg.md
Normal file
@@ -0,0 +1,44 @@
|
||||
## Using PteroStats Egg
|
||||
|
||||
1. Download and import [`pterostats-egg.json`](https://raw.githubusercontent.com/hirzidevs/pterostats/main/pterostats-egg.json) egg to your panel.
|
||||
|
||||
- Pterodactyl Panel
|
||||
|
||||
<img alt="Add pterostats egg to pterodactyl panel" src="https://usercontent.catto.pictures/hirzi/78c212c1-cb2d-4dcb-b987-5a817e33fc05.png" width="300"/>
|
||||
|
||||
- Pelican Panel (From File)
|
||||
|
||||
<img alt="Add pterostats egg to pelican panel (From File)" src="https://usercontent.catto.pictures/hirzi/7feb28b3-5111-4a5b-83aa-37da29c58d4d.png" width="300"/>
|
||||
|
||||
- Pelican Panel (From URL)
|
||||
|
||||
<img alt="Add pterostats egg to pelican panel (From URL)" src="https://usercontent.catto.pictures/hirzi/ffcb138f-b489-43b1-a81d-aca0b26394e5.png" width="300"/>
|
||||
|
||||
2. Create a server and use the egg.
|
||||
|
||||
- Pterodactyl Panel
|
||||
|
||||
<img alt="Create a server and use the pterostats egg in pterodactyl panel" src="https://usercontent.catto.pictures/hirzi/5d2f87ac-6e77-4362-8b7c-8a9955f94fa3.png" width="300"/>
|
||||
|
||||
- Pelican Panel
|
||||
|
||||
<img alt="Create a server and use the pterostats egg in pelican panel" src="https://usercontent.catto.pictures/hirzi/1ca15f64-53b7-4343-97a4-f1808f1fecae.png" width="300"/>
|
||||
|
||||
3. Finish the server creation process and wait until server installation is completed.
|
||||
|
||||
4. Start the server.
|
||||
|
||||
<img alt="Start the server" src="https://usercontent.catto.pictures/hirzi/0918ecf9-bae3-401e-9810-05839c401405.png" width="300"/>
|
||||
|
||||
5. Answer the prompted questions in the console to set up the app/bot.
|
||||
|
||||
<img alt="Setup" src="https://usercontent.catto.pictures/hirzi/b8645828-591d-4d52-b6d8-51f8df60440c.png" width="300"/>
|
||||
|
||||
- [How to get Panel API key](https://github.com/HirziDevs/PteroStats/blob/main/guide/panel-api-key.md)
|
||||
- [How to get Channel ID](https://github.com/HirziDevs/PteroStats/blob/main/guide/channel-id.md)
|
||||
|
||||
## Links
|
||||
|
||||
### Support Server
|
||||
|
||||
- [Discord](https://discord.znproject.my.id)
|
||||
34
guide/installation/manual.md
Normal file
34
guide/installation/manual.md
Normal file
@@ -0,0 +1,34 @@
|
||||
## Manual
|
||||
|
||||
1. Download this repository:
|
||||
|
||||
- Manually: [Download this repository](https://github.com/HirziDevs/PteroStats/archive/refs/heads/main.zip) and extract it.
|
||||
|
||||
- Using GIT: Run `git clone https://github.com/HirziDevs/PteroStats.git` in the command line.
|
||||
|
||||
2. Install required dependencies and start the app/bot.
|
||||
|
||||
- Using PM2 ([Why use PM2?](https://discordjs.guide/improving-dev-environment/pm2.html))
|
||||
|
||||
1. Run `npm install` in the root directory of the app/bot files.
|
||||
|
||||
2. Install PM2 using `npm install -g pm2` command.
|
||||
|
||||
2. Run `pm2 start index.js -n PteroStats` to start the app/bot.
|
||||
|
||||
- Using [nodejs-generic](https://github.com/pelican-eggs/generic/tree/main/nodejs) egg
|
||||
|
||||
1. Just start the server to start the app/bot.
|
||||
|
||||
3. Answer the prompted questions in the console to set up the app/bot.
|
||||
|
||||
<img alt="Setup" src="https://usercontent.catto.pictures/hirzi/b8645828-591d-4d52-b6d8-51f8df60440c.png" width="300"/>
|
||||
|
||||
- [How to get Panel API key](https://github.com/HirziDevs/PteroStats/blob/main/guide/panel-api-key.md)
|
||||
- [How to get Channel ID](https://github.com/HirziDevs/PteroStats/blob/main/guide/channel-id.md)
|
||||
|
||||
## Links
|
||||
|
||||
### Support Server
|
||||
|
||||
- [Discord](https://discord.znproject.my.id)
|
||||
@@ -1,15 +1,18 @@
|
||||
## Notifier
|
||||
## Notifier (Discord Webhook)
|
||||
|
||||
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"/>
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
## Panel API Key
|
||||
|
||||
> [!WARNING]
|
||||
> The use of Application API keys is **deprecated**; you should use **Client API keys**.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user