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.
[!WARNING] The scripts that are being executed via cron have critical errors. Please do not use them!
Current Features
Support Forum Management
- Support Post Tracking: Monitors and manages support forum threads
- Automatic Tag Management: Dynamically changes tags from unanswered to unsolved when someone responds
- Intelligent Post Closure: Detects when users express gratitude and suggests marking posts as solved
- Helper Recognition System: Allows post authors to commend users who helped them
- Review Flagging: Mark posts for review by developers with
/mark-for-review - Anti-Archive Protection: Prevents posts from being automatically archived if needed
Automation
- Auto-Threading: Creates threads automatically for messages in designated channels
- Auto-Publishing: Publishes messages in announcement channels with customizable rules
- Flag Emoji Removal: Automatically removes country flag reactions in specified channels
- Customizable Permissions: Configure whitelist/blacklist for users and roles
Feature Request System
- Categorized Requests: Organizes feature requests by category (Subscriptions, Settings, Translations, etc.)
- Status Workflow: Track requests from submission through implementation
- Sticky Message Management: Maintains interactive feature request forms
- Thread-Based Discussions: Each request creates its own discussion thread
Incident & Status Management
- Incident Tracking: Create and manage service incidents
- Status Updates: Update incident status (Investigating, Identified, Monitoring, Resolved)
- Notification System: Optional role pinging for status changes
- Betterstack Integration: Integrates with Betterstack for incident management (optional)
- Note, that this feature might not fully work, as this couldn’t be really tested yet. Open an issue if you have issues with it.
Administration & Metrics
- Bug Tracker: Track user-reported bugs with
/bugs addand/bugs removecommands - User Statistics: Comprehensive stats tracking for support contributions
- Command-Based Management: Administration commands for various server functions
Setup Instructions
To set up the Bot, follow these steps:
- Clone the Repository: Start by cloning the repository to your local machine using
git clone https://github.com/The-LukeZ/not-supportmail.git. - Install Dependencies: Navigate to the project directory and install the necessary dependencies using
npm installoryarn install. - Configure Environment Variables: Duplicate
.env.exampleto.env.productionand fill in the required environment variables with your specific values. - Edit Configuration Files: Duplicate the
example.config.jsontoconfig.jsonand fill it with your own configuration values.. - Run the Bot: Start the bot using
npm run startoryarn run start. You might need to install all dependencies first.
[!TIP] To run the bot in develoment mode, make a
.env.devand use the commandnpm devoryarn dev.
By following these steps, you will have the Supportmail Helper bot set up and running on your server. Make sure to review the configuration files and adjust them to fit your specific needs.
License (Summary - not binding)
GPL3 LICENSE
- Anyone can copy, modify and distribute this code.
- You have to include the license and copyright notice with each and every distribution.
- You can use this software privately.
- You can use this software for commercial purposes.
- If you dare build your business solely from this code, you risk open-sourcing the whole code base.
- If you modify it, you have to indicate changes made to the code.
- Any modifications of this code base MUST be distributed with the same license, GPLv3.
- This software is provided without warranty.
- 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