Sentinel Tickets Discord Bot

Introduction

This is a ticket bot that aims to provide a free and open source solution for managing tickets on Discord. The bot is designed to be lightweight, without any watermarks or unnecessary bloat. It allows users to create, track, and manage tickets seamlessly.

Requirements

• Tested on latest Node.js v22

Sponsor & Commissions

This is a free project that I enjoy working on in my free time. Our current sponsors are the primary reason for the latest feature additions. As more people sponsor the project, I will be able to justify dedicating more time to implementing features and fixing bugs. If you find value in this project or need specific enhancements, consider the following:

• Sponsorship: Help support the project's growth by becoming a sponsor. Reach out via Discord to discuss sponsorship opportunities.
• Custom Commissions: If you want a custom feature tailored to your needs or require priority work, you can reach out via Discord for a commission.
• Support with a Star: Even if you can't contribute financially, leaving a star is greatly appreciated! ❤️

Current Sponsors

Table of Contents

• 🛠️ Installation
• 🔄 Updating
• 🐳 Docker Setup (Alternative)
• 🐛 Bug Reporting
• ✨ Features
• 📚 Documentation
• 📃 License

Installation

1. Install Node.js if not already installed (v22 recommended): Node.js Installation Guide
2. Clone the repository: git clone https://github.com/ralphkb/sentinel-tickets.git or download the latest release: https://github.com/ralphkb/sentinel-tickets/releases
3. Change to the project directory, for example: cd sentinel-tickets or the directory where you uploaded the release files.
4. Run npm install to install the dependencies
5. Rename .env.example to .env and config.yml.example to config.yml
6. Open .env file and fill it with your bot's token, guild ID and client ID
7. Open config.yml to configure the settings and messages to your liking, make sure to properly configure the ticket categories
8. Start the bot: npm start

Updating

1. Make a backup of your current bot directory in case of issues so you have the option to revert back.
2. Make sure not to delete your data directory otherwise you might run into issues with tickets that you did not delete yet.
3. Download the new release/files and replace the current files with the ones you downloaded.
4. If you already followed the installation process, use the latest config.yml.example and locale.yml.example you downloaded to manually add any new config or localization options to your config.yml and locale.yml.
5. If any dependencies got updated, you will have to delete your node_modules directory and run npm install again after you've already uploaded the new files.
6. Start the updated bot using npm start

Docker Setup (Alternative)

Using Docker allows you to run and update the bot without having to install Node.js or C++ build tools (required for compiles) directly on your host machine.

You can run the bot in two ways:

• Option A: Pre-built Docker Image (Recommended & Easiest): Runs the bot using a pre-packaged image hosted on GitHub Container Registry. Updating requires running a simple command.
• Option B: Building from Source: Builds the image locally using the repository files and the provided Dockerfile.

---

Option A: Using the Pre-built Docker Image (Recommended)

Installation

1. Ensure you have Docker and Docker Compose installed on your system.
2. Create a new folder on your server (e.g., sentinel-tickets) and download docker-compose.yml, .env.example, config.yml.example, and locale.yml.example into it.
3. Set up your configuration files:
   • Copy .env.example to .env and fill in your Discord token, guild ID, and client ID.
   • Copy config.yml.example to config.yml and configure your bot settings.
   • Copy locale.yml.example to locale.yml and configure your locale file.
   • Create an empty file named logs.txt (e.g. touch logs.txt on Linux/macOS or create a new text file named logs.txt on Windows). This is necessary to mount and persist the bot's logs.
4. Start the bot: docker compose up -d

Updating

To update the bot when a new version is released:

1. Pull the newest image version: docker compose pull
2. If new options were added to config.yml.example or locale.yml.example in the release, manually copy those new keys/values into your existing config.yml or locale.yml.
3. Restart the container: docker compose up -d
   (Note: Your tickets and user databases inside the data/ folder, as well as your logs, will be safely preserved since they are mounted outside the container)

---

Option B: Building the Docker Image from Source

Installation

1. Ensure you have Docker and Docker Compose installed on your system.
2. Clone this repository or download the latest release files to a folder on your server.
3. Open the docker-compose.yml file and replace the image: line with: build: .
4. Set up your configuration files:
   • Copy .env.example to .env and fill in your Discord token, guild ID, and client ID.
   • Copy config.yml.example to config.yml and configure your bot settings.
   • Copy locale.yml.example to locale.yml and configure your locale file.
   • Create an empty file named logs.txt (e.g. touch logs.txt on Linux/macOS or create a new text file named logs.txt on Windows). This is necessary to mount and persist the bot's logs.
5. Run the following command to build the image and start the bot: docker compose up -d

Updating

When you want to update the bot:

1. Stop and remove the current container: docker compose down
2. Pull the latest code updates (or download the latest release files, replacing the files except config.yml, locale.yml, .env, logs.txt, and the data/ folder).
3. If new options were added to config.yml.example or locale.yml.example in the update, manually copy those new keys/values into your existing config.yml or locale.yml.
4. Rebuild and restart the container: docker compose up --build -d
   (Note: Your tickets and user databases inside the data/ folder, as well as your logs, will be safely preserved since they are mounted outside the container)

Bug Reporting

• For bug reports, open an issue here.
  Join my Discord Server for community support.

Features

• Up to 25 Categories: Organize support requests in different categories.
• Intuitive Ticket Panel: Create and manage tickets with ease using buttons or a select menu.
• Option to create many ticket panels and send them to any channel.
• Modal Questions: Gather necessary information before opening a ticket.
• Option to disable modal questions per ticket category.
• Configuration to customize many of the messages and embed options.
• Option to configure support roles per ticket category.
• Option to require one or more roles to create a ticket per ticket category.
• Option to ping support roles on ticket creation per ticket category.
• The ability to have configure fallback categories if one becomes full.
• Edit permissions of the ticket creator, support roles, added roles and added users per ticket category.
• Per Day Working Hours feature with an option to specify the timezone and block ticket creation outside the working hours.
• Option to configure the amount of max opened tickets at one time.
• Ticket claiming feature that can be turned on/off.
• Automatic saving of transcripts upon ticket deletion and force deletion.
• Option to manually save a transcript with images downloaded, use with caution as it increases the transcript size.
• Options to DM users upon ticket close, ticket reopen or the usage of the alert command.
• Option to DM users on ticket deletion with their transcript and an embed with useful information.
• Configurable rating/feedback system with logs of the responses.
• Option to save the transcripts as HTML or TXT, with the possibility to save images in HTML transcripts. Also includes the option to change the transcript file name.
• Ticket logs for multiple ticket events, such as ticket create, close, delete, force delete, reopen, claim, unclaim etc.
• Option to select a channel for each log event to be sent to.
• Precise and organized logs of errors and all ticket events in a logs.txt file.
• Option to edit the activity of the bot.
• Blacklist system with the ability to add users or roles with an optional reason and view them in a list.
• Option to automatically close tickets after X amount of time from the last message sent in that ticket, with an option to ignore bots.
• Option to automatically close or delete a ticket after the ticket creator left the discord server.
• Option to automatically close or delete a ticket after an alert was sent and the ticket creator did not reply in time.
• Option to automatically delete closed tickets after X amount of time from the ticket's closure time.
• Automated responses system that will check the input of user questions and reply with pre-configured answers after the ticket is created.
• DM preference system, allowing users to toggle their preference regarding receiving DMs from the bot such as alert, close, reopen & delete.
• The ability to create stats channels that will be automatically updated after a configurable amount of time.
• The ability to adjust some of the stats in case of migrating from a different bot or due to any inconsistency or issues.
• Multiple Commands: Efficiently manage tickets with various commands.
  • Send the ticket panels in any channel using the panel id
  • Add Users or Roles to a ticket
  • Remove Users or Roles from a ticket
  • Rename Ticket Channel
  • Alert Ticket Creator
  • Close Ticket to archive them until deleting them
  • Delete Tickets
  • Re-Open Tickets
  • Save Transcripts
  • Claim/Unclaim Tickets
  • Move tickets to another category
  • Pin tickets in a category
  • Add a custom slowmode to a ticket
  • Transfer ticket ownership to another user
  • Add a priority to a ticket
  • Change the topic of a ticket, with placeholders support
  • Close Request so users can request that staff close their ticket
  • List current open and closed tickets of a user
• Context Menu Commands: Right click commands that are easy to use.
  • Get User Info
  • Blacklist Add
  • Blacklist Remove
  • Ticket Alert
  • Ticket Pin
  • Ticket Transcript
  • Tickets List
  • Ticket Close Request
  • Ticket Claim
  • Ticket Unclaim
• Useful statistics such as:
  • Total Tickets
  • Total Open Tickets
  • Total Claimed Tickets
  • Total Messages
  • Total Ticket Creators
  • Average Tickets Created Per User
  • Total Reviews
  • Average Rating

Documentation

For more information about creating a bot, installation, updating, configuration, permissions, common questions and common errors, check out the documentation website of the bot here: https://sentineltickets.com

License

This project is licensed under the MIT License.