generated from nhcarrigan/template
feat: migrate from github
This commit is contained in:
7
docs/projects/discord-verification-bot/index.md
Normal file
7
docs/projects/discord-verification-bot/index.md
Normal file
@ -0,0 +1,7 @@
|
||||
# Discord Verification Bot
|
||||
|
||||
This bot is designed as a basic verification gate for your Discord server.
|
||||
|
||||
|
||||
|
||||
[View the Code](https://github.com/nhcarrigan/discord-verification-bot) | [Invite the Bot](https://discord.com/api/oauth2/authorize?client_id=880171019409694742&permissions=268454914&scope=bot%20applications.commands)
|
39
docs/projects/discord-verification-bot/privacy.md
Normal file
39
docs/projects/discord-verification-bot/privacy.md
Normal file
@ -0,0 +1,39 @@
|
||||
# Privacy Policy
|
||||
|
||||
> [!DANGER]
|
||||
> In the spirit of open source, errors are logged publicly in our Discord community. These logs may include information relevant to the error in question.
|
||||
>
|
||||
> We encourage you to [join our Discord](https://chat.nhcarrigan.com) to see what is logged PRIOR to using our applications.
|
||||
|
||||
The use of this application is subject to this Privacy Policy. By using this application, you agree to the collection and use of your personal data in accordance with this Privacy Policy.
|
||||
|
||||
## Data Collected
|
||||
|
||||
In order to operate, the application collects and stores the following data:
|
||||
|
||||
- Discord server ID: The application stores the Discord server ID to associate database records with specific Discord servers.
|
||||
- Verification Details: The application stores the configured verification question, answers, and role to assign.
|
||||
|
||||
## Right to Request Data
|
||||
|
||||
A server owner may request to view the data via our [support server](https://chat.nhcarrigan.com).
|
||||
|
||||
## Right to Removal
|
||||
|
||||
A server owner may request removal of data by kicking the bot from the server, or reaching out to our support team in [our support server](https://chat.nhcarrigan.com).
|
||||
|
||||
## Right to OptOut
|
||||
|
||||
As no user information is collected, individual users do not have an opt out process. Servers may opt out of data collection by removing the bot.
|
||||
|
||||
## Data Retention
|
||||
|
||||
Data are stored for the minimum necessary time to ensure the application is able to function.
|
||||
|
||||
## Availability of Data
|
||||
|
||||
Data are available to members of the development team, for the express purpose of debugging, improving, and contributing to the application.
|
||||
|
||||
## Questions
|
||||
|
||||
Questions and concerns regarding this privacy policy may be directed to `privacy@nhcarrigan.com`.
|
10
docs/projects/discord-verification-bot/usage.md
Normal file
10
docs/projects/discord-verification-bot/usage.md
Normal file
@ -0,0 +1,10 @@
|
||||
# Usage
|
||||
|
||||
The bot is designed to work with the following flow:
|
||||
|
||||
- New members who join your server can only see a "verification" channel (one that is not visible to anyone else).
|
||||
- Within that channel, you should run the `/start` command to set up your verification question, answers, and the role to assign. The bot will create a post explaining the process to new members, with a button to click to verify themselves.
|
||||
- Upon clicking the button, the member will be asked to answer the question. If they answer incorrectly, they are kicked. If they answer correctly, they are given the verification role.
|
||||
- If they do not verify in 30 minutes, they are kicked.
|
||||
|
||||
Ideally, you should configure the verification role such that members **with** that role cannot see the verification channel.
|
Reference in New Issue
Block a user