Skip to content

Getting Started

Jump to bottom
Sean Samarov edited this page Jun 27, 2022 · 10 revisions

HOLD UP

Before you get started here, we ask that you report any issues you encounter and post requests for any features that come to mind. This bot is free in early access because we're looking for feedback and testing, and your input is very valuable to us.

You will need an API key from the panel. This API key will need console permissions for the servers you want to link at the very minimum. You may also grant additional permissions for other server commands such as start, stop and restart. The bot will associate the key with your Discord account and use it to talk to the Pterodactyl panel API on your behalf.

Invite the Bot

This is simple enough. Simply use the link below to invite the bot and get started.

Click here to invite the bot

Make sure your permissions are set up correctly. The bot needs to be able to

  • Read Messages
  • Send Messages
  • Manage Messages in the channel(s) you want to use.

Register your API Key

  1. Go to your game panel.
  2. Go to your Account Overview page by clicking the user icon in the top right. TODO IMAGE NEEDED
  3. Go to API Credentials. TODO IMAGE NEEDED
  4. Generate a new API key, giving it a descriptive name such as “Discord Bot Live Console”. Leave the “Allowed IPs” field blank, as it may cause issues with the bot. TODO IMAGE NEEDED
  5. Copy the API key and store it in a secure location.
  6. Open a Direct Message with the bot.
  7. Type ?user register apikey, replacing “apikey” with your panel API key. TODO IMAGE NEEDED
  8. Run ?user verify TODO IMAGE NEEDED

If no error is returned and the bot says it successfully verified your API token, congratulations! The bot is now working and you can move on to setting up your first mirror.

Security Considerations

When you run a command with the bot, it uses the API key that you enter yourself. This means that the bot does not rely on Discord permissions at all — if you remove a user’s API key from the game panel, they will no longer be able to run commands. Users with access to the channel will be able to read the console, which may include passwords or IP addresses, but without a registered API key, they will not be able to run commands on the server, even if they have permission to send messages in that Discord channel.

Next Up: Creating your first mirror

Created with <3 by Ineptitech. ©️ 2022 All rights reserved.

Clone this wiki locally