Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chamburr/modmail
A feature-rich Discord bot for easy communication between server staff and users.
https://github.com/chamburr/modmail
Last synced: about 1 month ago
JSON representation
A feature-rich Discord bot for easy communication between server staff and users.
- Host: GitHub
- URL: https://github.com/chamburr/modmail
- Owner: chamburr
- License: agpl-3.0
- Created: 2019-05-16T11:47:51.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-06-10T06:56:02.000Z (6 months ago)
- Last Synced: 2024-07-31T08:14:20.798Z (4 months ago)
- Language: Python
- Homepage: https://modmail.xyz
- Size: 2.48 MB
- Stars: 330
- Watchers: 16
- Forks: 238
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - chamburr/modmail - A feature-rich Discord bot for easy communication between server staff and users. (Python)
- awesome-discord - ModMail - A feature-rich Discord bot for easy communication between server staff and users. (Bots / Open Source Public Bots)
README
# ModMail
[][discord]
[](LICENSE)
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](https://modmail.xyz) or visit our [Discord server][discord].
## Contributing
There are many ways you can contribute to this project:
- [Submitting bugs and suggestions](https://github.com/chamburr/modmail/issues)
- [Reviewing pull requests](https://github.com/chamburr/modmail/pulls)
- [Contribute directly to the code base](https://github.com/chamburr/modmail/pulls)
For more information, please see our [contributing guidelines](CONTRIBUTING.md).
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][discord].
## 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](https://discord.com/developers). 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](LICENSE).
[discord]: https://discord.gg/wjWJwJB