Sick Invite is a Discord bot which can secure your private server with controlled, accountable invite links. Normally, a server owner may allow users to create their own invite links, or simply have a single public invite. A problem arises for servers where privacy is important, which is that you have no control over these links once they're shared. Worse, when new users join, you have no idea which invites were used or who shared them.
The traditional solution is to only allow admins to create links, and tell users to ping or DM these admins for an invite. This increases the workload for server staff, and could hamper the growth of your server by creating a barrier for users to invite people.
What Sick Invite does is make it super easy for your users to get an invite link, by simply reacting to the bot's message. You can place this message in any channel, allowing you to control who is allowed to get invites, by restricting access to that channel via roles.
These invite links are shared privately with the user via DM. They're limited to one use, and expire after 48 hours. Users can only get one invite at a time, and are rate-limited to receiving one every 10 minutes.
The bot also sends a welcome message which tags both the new user, and the user who invited them. This way, there is transparency regarding how invites are shared.
The invite link settings, rate-limiting period, channel for welcome messages, and channel mentioned by welcome messages, are currently not configurable. The option to change these settings may be added later.
The bot has not been fully tested and may include bugs. Issues and pull requests are welcome.
- Invite the bot to your server
- Ping
@Sick Invitein your channel of choice - React to its message to create invites
You'll need Node.js and npm before installing the bot.
- Clone this repo and enter its directory
- Run
npm install - Run
sudo npm install -g pm2(optional, only if you want to run it in production) - Set the environment variable
SICK_INVITE_TOKENto your bot's token
If you're testing locally, run npm start.
If you're in a production environment, use npm run prod to start the bot in background. This assumes that PM2 is globally installed. You can then use commands such as pm2 ls to manage the bot (see PM2's docs for more info).
MIT License
Copyright (c) 2021 Luke Fisk-Lennon
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.