chamburr / modmail

A feature-rich Discord bot for easy communication between server staff and users.

ModMail

A feature-rich Discord bot for easy communication between server staff and users.

A new channel is created whenever a user messages the bot, and the channel will serve as a shared inbox for seamless communication between staff and the user.

To learn more, check out our website or visit our Discord server.

Contributing

There are many ways you can contribute to this project:

• Submitting bugs and suggestions
• Reviewing pull requests
• Contribute directly to the code base

For more information, please see our contributing guidelines.

The issue tracker here is only for bug reports and suggestions. Please do not use it to ask a question. Instead, ask it on our Discord server.

Self-hosting

This guide requires you to have basic knowledge about command line, Docker and Discord bots. We will not provide any form of support for self-hosting.

First, create a Discord bot on the developer portal. You must enable the server member intent and the message content intent for the bot to function.

Then, install Git and Docker on your machine. Clone this repository, copy docker/.env.example to docker/.env and fill in all the empty configurations.

Finally, use the following commands to start ModMail.

cd docker
docker compose up -d

If you prefer to build your own images for local development, then use these commands.

cd docker
docker compose build
docker compose up -d

Your self-hosted bot should be up now. Congratulations!

License

This project is licensed under GNU Affero General Public License v3.0.