https://github.com/jdockerty/modmail
https://github.com/jdockerty/modmail
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jdockerty/modmail
- Owner: jdockerty
- Created: 2021-01-19T08:13:43.000Z (over 5 years ago)
- Default Branch: staging
- Last Pushed: 2023-07-17T21:18:50.000Z (almost 3 years ago)
- Last Synced: 2025-01-23T13:29:32.587Z (over 1 year ago)
- Size: 79.1 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ModMail
## Discord bot used to send anonymous messages to the moderators
### Setup
1. Create a discord bot
- see https://discordpy.readthedocs.io/en/latest/discord.html for instructions
2. Install bot server software
- clone the repository `git clone https://gitlab.com/awol-linux/ansible-doc-bot.git`
- Install requirments `pip install -r requirments.txt`
- create a .env file and put `DISCORD_TOKEN={your-bot-token}` inside it
- start the bot `python3 ./bot.py`
3. Alternatively you can use Docker. The bot is not yet in Dockerhub so it still would need to be built.
```
[awol@gaming-amd ~]$ git clone https://github.com/NetworkChuckDiscord/Modmail.git && cd Modmail
[awol@gaming-amd ~]$ echo {your-discord-token} >> .env
[awol@gaming-amd ~]$ docker build . -t modmail
[awol@gaming-amd ~]$ docker compose up -d
```
## Usage
Once the bot is added to your server, you can interact by sending it a DM. When you do that the bot will create a channel in the catagory named tickets and anonymously forward the messages from that user into that channel. Any responses written in that channel will then be DMed to the user.
There are currently no commands for this bot hopefully there will be soon.
| permision | Command | Description |
|-----------|---------|-------------|
| Admin | &search [ticket-number] | Type is the search you want to use can be 1) -ltdate -etdate -author and term is the search term |
| Admin | &user_search [uid] | prints all tickets submitted by that user |
| Admin | &mod_search [uid] | prints all tickets that the moderator has been involved |
| Admin | &close | Archives the complaint putting a full log in admin log |
| User | &print | spits out all of the tickets sent by the user |
## Configuration
There is currently no config file that is still in the works:
| Setting | default Value | Description |
|---------|---------------|-------------|
| nods | false | Prevents Admins from running direct search due to security risk |
| prefex | $ | sets the default command prefex
| ticket_catagory | Null | catagory where the complaint channels are placed |
| complaint_log | Null |log where archived messages go |