Apollo

Apollo is a fully-configurable Discord Bot that helps with managing Discord Servers for OSS projects.

Table of Contents

• Tech Stack
• Getting Started / Prerequisites
  • Environment Variables
    • Discord
    • Turso
    • GitHub
  • Starting the Bot
    • Docker
• Commands
• Contributing
• License

Tech Stack

• 🤖 Discord.js
• 🌧️ Drizzle ORM
• 🪶 libSQL

Getting Started / Prerequisites

Clone this repo and install all relevant dependencies. We recommend pnpm for doing so.

Environment Variables

The following environment variables need to be set in order for the bot to function:

Discord

You can get these two from the Discord Developer Portal by creating a new app and configuring it to be a bot. Both of these are required.

DISCORD_APP_TOKEN=...
DISCORD_CLIENT_ID=...

Turso

Apollo uses a Turso database to store all relevant data, using Drizzle as it's ORM. Because we're using drizzle-orm/libsql/node, you can theoretically run your database with any of the allowed protocols.

For more information, check the Drizzle ORM Documentation about drivers.

TURSO_URL=libsql://... # Required!
TURSO_AUTH_TOKEN=... # Optional, only if you have an auth token! Not needed for local DBs.

GitHub

The /ptal command is powered by the GitHub API, for which you need to create a GitHub App and install it in your organization, for yourself or for a specific repository.

You'll get the App ID and Client ID as soon as you create the app. The webhook secret you'll get when creating a webhook for your app installation, and the private key you need to add manually. You also need to generate it yourself. The easiest way of doing so is by running the following command in your terminal (requires OpenSSL to be installed):

openssl genpkey -algorithm RSA -out private_key.pem -pkeyopt rsa_keygen_bits:2048

The installation ID is a bit more tricky to get. We recommend you follow GitHub's Documentation for this.

GITHUB_APP_ID=...
GITHUB_CLIENT_ID=...
GITHUB_WEBHOOK_SECRET=...
GITHUB_INSTALLATION_ID=...
GITHUB_PRIVATE_KEY="
-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----
" # Multiline on purpose! Yes, this works.

Starting the Bot

Once you've set all variables, start the bot by running:

pnpm start

Docker

This project has its own Dockerfile which you can use to deploy the Bot in a container. Build the image by running the following command in the root of the project after cloning it:

docker build --tag "apollo" .

You can then start a container with this image by running:

docker run "apollo"

If you want to run the image in the background, you can use the --detach flag:

docker run --detach "apollo"

Commands

Command	Description	Minimum Permissions
/ptal	Creates a PTAL announcement in the current channel and pings the notifications role (if configured).	Moderate Members
/settings	Command which carries the sub-commands for configuring the bot.	Administrator
/settings set-forum	Allows you to configure the Forum to be used for support requests.	Administrator
/settings set-ptal-role	Sets the role that gets pinged when a new PTAL announcement is sent.	Administrator
/settings set-join-role	Sets the role that a user receives when they join the server.	Administrator
/settings print	Prints an overview of all settings.	Administrator
/solved	Sends an embed with buttons so the OP of a support request can close it.	Moderate Members
/support	Creates a new post in the support forum based on the message you supply.	Moderate Members

Contributing

See our Contribution Guide.

License

© StudioCMS 2024. MIT Licensed.