A Discord verification bot that is designed for post-secondary institutions. Fully modular and configurable.
VerificationBot started as a small project for the UVic Engineering and Computer Science Discord server due to a growing server population. We wanted to make an automated system to prevent non-UVic students from accessing the remainder of the Discord server. With this goal in mind, and with the help of MiningMark48, the initial draft of the bot was created.
Since its initial creation, the bot has been an excellent method for keeping non-UVic students from accessing our Discord server. With our goal accomplished, other servers began to take notice. Thanks to the Fall 2020 semester being fully online due to the pandemic, many more Discord servers were being created, some with thousands of members. With these numerous servers, a lack of a verification system was becoming a concern.
From this point, the bot was rewritten; going from a single-file bot to a multiple-file, fully modularized machine. What once wasn't possible, the bot was now able to be controlled better than before, thanks to the use of a config.
When users join a Discord server, they are given access to limited channels, one of which allows them to send in their university or institutional email with the help of a bot command.
!email example@example.com
Once they run the command and if the email is valid (matches the set domain), they will receive an email containing a 4-digit code. The user then takes this code back to the Discord server and runs a command with this code.
!verify 1234
If the code is valid, they will be given a role, allowing access to the rest of the server (or however configured).
Recommended Method
-
To start, verify Docker is installed. If it is not or you don't know, go here to download Docker. Docker-compose is now included with Docker.
-
Download the source code, extract to a desired directory and browse to the
docker_compose.yml. Open it with notepad or your text editor of choice and add your environmental variables (token, key, domain, etc.). -
A bot token needs to be created to run this bot. You can find the Discord Developers Portal here. If you need help making a bot account, Google is your friend.
When adding your bot to your server, make sure the bot has the necessary permissions or things will almost certainly break!
Permissions required:
- Manage Server
- Manage Roles
- View Channels
- Send Messages
- Manage Messages
- Read Message History
- Add Reactions
-
Open a command prompt or terminal, move to the directory containing the downloaded
docker-compose.ymlfile, and run the following commands:docker compose build docker compose up -d
-
Congratulations! Assuming your variables in the
docker-compose.ymlfile are correct and everything is installed correctly you should have a running Discord bot!
-
To start, download this repo. Also, ensure you have Python 3.7+ installed.
-
Create a virtual environment with the following command:
python -m venv venv
-
Activate the virtual environment with one of the following commands:
.\venv\Scripts\activate
or
activate venv
-
Install dependencies found in
requirements.txt:pip install -r requirements.txt
-
Create a
.envfile in the same directory as the downloaded repo. In this file, set your environmental variables as specified indocker-compose.yml. -
Finally, run
bot.py:python bot.py
-
Congratulations! Assuming all went well and everything is installed correctly you should have a running Discord bot!
Here is a full list of the commands the bot offers:
| Command | Description | Permissions Required | Usage* |
|---|---|---|---|
| vhelp | Displays an informative message about how to use the email and verify commands. | None | vhelp |
| Sends a verification email to a provided email account. | None | email <email: str> | |
| verify | Uses the token sent to the email account to verify the user. | None | verify <token: int> |
| support | Replies with links to financially support the authors and contributors of this bot, and a link to this repo | None | support |
| uptime | Tells you how long this instance of the bot has been running for. | None | uptime |
| activetokens | Notifies the 'notification channel' of which users have incomplete verifications in progress. | None | activetokens |
| prune | Prunes the most recent n amount of messages in a channel. | Manage Server | prune <amount: int> |
| modverify | Allows you to manually verify a user, bypassing the main verification system. | Manage Server | modverify <email: str> <userid: int> |
| reactoradd | Adds a reactor to a message | Manage Server | reactoradd <message_id: str> <role_id: str> <emote: emote> |
| reactordelete | Removes all reactors from a message. | Manage Server | reactordelete <message_id: str> |
| reactorget | Get all reactors in the server | Manage Server | reactorget |
| reactorclearall | Removes all reactors in the server. | Manage Server | reactorclearall |
* <> = required, [] = optional
There are a variety of extra handlers to help aid people that can't quite follow the instructions properly. The email command will accept the following variations:
- (!) email [email@email.com] - extra space before 'email'
- (!)[email@email.com] - no 'email'
- (!)email[email@email.com] - missing space between 'email' and their email
- [email@email.com] - missing alias and 'email'
- email [email@email.com] - missing alias
These are primarily there to assist people new to Discord or who can't follow instructions. The vhelp command encourages use of the proper form, <alias>email [email@email.com].
Notable contributors are listed below:
| Contributor | Contribution |
|---|---|
| MiningMark48 | Wrote the initial draft of the bot, reactor module, and data handlers to integrate to sqlalchemy, rewrote the bot to use Discord.py Cogs, and implemented miscellaneous commands and features. |
| aabuelazm | Wrote the Dockerfile and implemented environmental variables to bot.py for easy Docker container deployment. |
| MNThomson | Fixed vulnerabilities |
If you use this bot on your server, feel free to credit me by linking to this repository.
If you want to support me financially, buy me a cup of coffee!
You can also support me through PayPal directly.
The code for this repo is licensed under the GPL3. More information can be found in the LICENSE file in this repo.
This project is not affiliated with Discord or discord.py.
Future Updates
Although this repo is being given support and updates, it is limited. If Discord or discord.py make any sudden changes to their API, do not expect an immediate update.
Major security patches and API changes may result in an update, or may result in support being dropped. If support is dropped indefinitely, this file will be updated to note that the bot is now deprecated and the repo will be archived and set to read-only. At the moment, this is unlikely and not in the forseeable future.