Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
parker02311 committed Dec 2, 2024
1 parent 99b1624 commit 44ec92b
Show file tree
Hide file tree
Showing 7 changed files with 87 additions and 1 deletion.
Binary file added docs/assets/create_pterodactyl_database.mp4
Binary file not shown.
Binary file added docs/assets/invite_bot.mp4
Binary file not shown.
24 changes: 24 additions & 0 deletions docs/setup/bot/local/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,30 @@ authors:

This guide is the next part after [configuration](configuration.md). If you have not configured the bot yet please do so before continuing.

## Inviting the Bot
Before we can run the bot we need to invite it to our guild. To do this we will do the following:
<video width="1920" height="1080" controls>
<source src="/assets/invite_bot.mp4" type="video/mp4">
</video>

Scopes Required:

- `applications.commands`: This is required for the bot to create slash commands.
- `bot`: This is required for the bot to join the guild.

Permissions Required:

- `Administrator`: This is the easiest way to ensure the bot has all the permissions it needs.

!!! warning "Ensure Proper Permissions and Scopes"

If you do not give the bot proper permissions or scopes, commands may not work correctly or not even appear.

??? warning "Warning about Administrator Permissions"

Giving the bot administrator permissions is not recommended. If you do, please ensure to not leak the token.


## Running the Bot
The easiest part of this entire guide, running the bot. To run the bot we will use the following command.

Expand Down
15 changes: 15 additions & 0 deletions docs/setup/bot/pterodactyl/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ The bot uses a mix of both a `config.json` and a `.env` file for configuration.
<source src="/assets/create_pterodactyl_config.mp4" type="video/mp4">
</video>

!!! danger "Common Configuration Mistake"

Please ensure that you change `Data.Database` to `mysql`.

If you do not, the bot will not work correctly.

## Configuration Explained
Now that we have our `config.json` file we can start configuring it. Below is a list of all the options and what they do.
```json
Expand Down Expand Up @@ -65,6 +71,15 @@ Now that we have our `config.json` file we can start configuring it. Below is a
- Key: The key the API will use for authentication. (This key must be kept secret)


!!! danger "Common Configuration Mistake"

Please ensure `API.Port` is set to the port of your server. You can find it on the console page.

It is the number after the `:` in the URL.

For example, `node5.redon.tech:12345` would have a port of `12345`.


## Finishing the .env file

Now that we have our `config.json` file we can finish our `.env` file. To do this we will add the following to the `.env` file. Replace the values with your own.
Expand Down
16 changes: 15 additions & 1 deletion docs/setup/bot/pterodactyl/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,24 @@ authors:

This guide is the next part after [installing the system](setup.md). If you have not installed the system yet please do so before continuing.

!!! warning
!!! warning "Database Required"

The Pterodactyl egg is designed for MySQL (MariaDB) only. If you are using a different database the hosting provider will need to modify your egg.

### Creating Database
If your hosting provider allows you to create a database. If not, you will need to either contact your hosting provider or find a database hosting provider.

Redon Tech hosting provides you with a database. You can create a database by following the steps below.
<video width="1920" height="1080" controls>
<source src="/assets/create_pterodactyl_database.mp4" type="video/mp4">
</video>

!!! danger "Common Database String Issues"

If you use the connection string provided by the panel, **you will need to remove the `jdbc:` from the beginning** of the string.

The connection string should look like this `mysql://USER:PASSWORD@HOST:PORT/DATABASE`.

### Connection String
After you have choosen the database type you are going to use, make the connector string and save it for later. You will need it in the next step. [Get help with connection strings](https://www.prisma.io/docs/reference/database-reference/connection-urls)

Expand Down
23 changes: 23 additions & 0 deletions docs/setup/bot/pterodactyl/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,29 @@ authors:

This guide is the next part after [configuration](configuration.md). If you have not configured the bot yet please do so before continuing.

## Inviting the Bot
Before we can run the bot we need to invite it to our guild. To do this we will do the following:
<video width="1920" height="1080" controls>
<source src="/assets/invite_bot.mp4" type="video/mp4">
</video>

Scopes Required:

- `applications.commands`: This is required for the bot to create slash commands.
- `bot`: This is required for the bot to join the guild.

Permissions Required:

- `Administrator`: This is the easiest way to ensure the bot has all the permissions it needs.

!!! warning "Ensure Proper Permissions and Scopes"

If you do not give the bot proper permissions or scopes, commands may not work correctly or not even appear.

??? warning "Warning about Administrator Permissions"

Giving the bot administrator permissions is not recommended. If you do, please ensure to not leak the token.

## Running the Bot
The easiest part of this entire guide, running the bot. To run the bot we will do the following:

Expand Down
10 changes: 10 additions & 0 deletions docs/setup/bot/pterodactyl/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,14 @@ Before we get to setting up our database and configuring the bot we must first i
2. Once you have purchased a Redon Hub server you need to login and familiarize yourself with the panel.
3. Next you will need to setup a database, this is also dependent on your provider, consult their documentation.


!!! danger "Follow The Guide"

## **Follow the guide word-word**

If you encounter problems, it is most likely that you have missed a step.

If you are still having issues after following the guide, please contact your hosting provider.


[Next: Database Setup](database.md){ .md-button .md-button--primary }

0 comments on commit 44ec92b

Please sign in to comment.