not-supportmail

Supportmail Helper

The source code of the helper bot for the SupportMail support server.

If you want to use this code, you can do so by forking this repository and modifying the code to fit your needs.

Installation and Usage

Prerequisites

• Node.js (version 20 or higher)
• bun package manager
• MongoDB database

• pm2 for process management (for production use) - install globally with bun!

  bun add -g pm2
  

• Discord Bot Token from the Discord Developer Portal
• Sentry account (required)

Setup

1. Fork the repository

Fork this repository to your own GitHub account to create a personal copy of the code.

2. Clone the repository

git clone https://github.com/<your-username>/<repositoryname>.git
cd <repositoryname>

2. Install dependencies

bun install

3. Environment Configuration

Create environment files in the root directory, based on the .env.example file:

• .env.dev: For development environment variables
• .env.production: For production environment variables

4. Configure the bot

• Invite your bot to your Discord server with the necessary permissions
• Set up the required channels and roles according to your server structure
• Customize configuration values in the source code as needed

Running the Bot

Development mode:

bun dev

Production mode (with PM2):

# Start the bot
./start.sh

# Stop the bot
pm2 stop sm-helper

# Restart the bot
pm2 restart sm-helper

# View logs
pm2 logs sm-helper

# Monitor the bot
pm2 monit

[!NOTE] Production mode uses PM2 for process management. The bot will automatically restart on crashes and can be managed with PM2 commands.

Building only:

bun build

This doesn’t have any output though as Bun handles builds internally.

Bot Permissions

The bot requires the following Discord permissions:

• Send Messages
• Use Slash Commands
• Manage Messages
• Manage Threads
• Add Reactions
• Read Message History
• Embed Links
• Attach Files
• Mention Everyone
• Use External Emojis

Database Setup

The bot uses MongoDB to store data. Make sure your MongoDB instance is running and accessible via the MONGODB_URI in your environment file. The bot will automatically create the necessary collections and indexes on startup.

Current Features

Please refer to the FEATURES.md file for a detailed list of current features, components, event-driven automations, cron jobs, database models, caches, utilities, and configuration options.

---

License (Summary - not binding)

GPL3 LICENSE

1. Anyone can copy, modify and distribute this code.
2. You have to include the license and copyright notice with each and every distribution.
3. You can use this software privately.
4. You can use this software for commercial purposes.
5. If you dare build your business solely from this code, you risk open-sourcing the whole code base.
6. If you modify it, you have to indicate changes made to the code.
7. Any modifications of this code base MUST be distributed with the same license, GPLv3.
8. This software is provided without warranty.
9. The software author or license can not be held liable for any damages inflicted by the software.

More information on about the LICENSE can be found here

---

TODOs?

• Add a way to input ends_at on /incident create field for maintenance

This site is open source. Improve this page.