Introduction

PteroStats is a bot designed to check Pterodactyl Panel and Nodes status and post it to your discord server

Example

• Test Panel

  

Installation

• Introduction
• Example
• Installation
  • Getting API key from pterodactyl
  • Creating Discord Bot
  • Inviting Discord Bot
  • Getting Channel ID
  • Starting bot
  • Using Custom Emoji
  • Blacklist Nodes
• The node is online but the embed is read as offline
• Docker
  • Installation
  • Docker Compose
  • Docker Run
• Links

Getting API key from pterodactyl

Warning

The use of Application API keys are deprecated, you should use Client API keys in the config file

1. Go to your Pterodactyl Panel and go to Account Page.

   

2. Click on the API Credentials button

   

3. Fill the Description and click on the Create button

   

4. Copy the API key.

   

5. Paste the panel API key and panel url at the config

   

Creating Discord Bot

Please refer to this website

Paste the bot token at the config

Inviting Discord Bot

Please refer to this website

Getting Channel ID

1. Enable Developer Feature at your discord settings

   

2. Right Click text channel and select Copy ID

   

3. Paste the channel id at the config

   

Starting bot

1. Make sure you have done the things above
2. Run npm install in the root directory of the bot files.
3. Run node index and you are done.

if you need help contact me on discord @hirzidevs or join our discord support server

Using Custom Emoji

1. type \ in server that has custom emoji you want

   

2. Select custom emoji you want

   

3. Copy the text!

   

4. Paste the emoji id at the config

   

Blacklist Nodes

1. Select node from node list on admin page

   

2. Check the url and copy the node id

   

3. Paste the id to the blacklist on config

   

You can add more than one node in the blacklist

The node is online but the embed is read as offline

If you having this issue, you can enable log_error on the config file and report it to our discord server at Support Server

Docker

This is a guide to run the bot using docker (alternative way to run the bot)

Installation

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 section)

docker compose up -d
docker compose logs -f pterostats

Docker Run

docker run -d --name pterostats -v $(pwd)/config.yml:/app/config.yml ghcr.io/hirzidevs/pterostats:latest
docker logs -f pterostats

Links

• PteroStats DiscordJS v13
• PteroStats DiscordJS v12
• Pterodactyl Panel
• Pterodactyl API Documentation
• Pterodactyl Discord Server
• PteroBot Support Server