dennis.heinrich/Discord-Captcha-Verification
1
0
Fork 0
mirror of https://github.com/cloudmaker97/Discord-Captcha-Verification.git synced 2025-12-06 01:48:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
A simple bot for verifying users after joining a discord server via a Captcha from CloudFlare Turnstile and logging their IP-Information for legal reasons
2 commits 1 branch 0 tags 298 KiB
JavaScript 56%
CSS 38.9%
HTML 5.1%
Find a file
Dennis Heinrich 05a5052c83 Support for publishing with docker
2024-04-27 03:15:30 +02:00
modules First version for the captcha verification 2024-04-27 03:05:31 +02:00
.gitignore Support for publishing with docker 2024-04-27 03:15:30 +02:00
config.example.json First version for the captcha verification 2024-04-27 03:05:31 +02:00
docker-compose.yml Support for publishing with docker 2024-04-27 03:15:30 +02:00
index.js First version for the captcha verification 2024-04-27 03:05:31 +02:00
package.json First version for the captcha verification 2024-04-27 03:05:31 +02:00
pnpm-lock.yaml First version for the captcha verification 2024-04-27 03:05:31 +02:00
README.md Support for publishing with docker 2024-04-27 03:15:30 +02:00
tailwind.config.js First version for the captcha verification 2024-04-27 03:05:31 +02:00

README.md

Discord-Verification

This is a simple discord verification bot that uses a captcha (CloudFlare Turnstile). The bot creates an embed in a specified discord channel with a button. If the button is clicked, the user receives a personal link. After clicking the link, the user is redirected to the captcha page. If the captcha is solved, the user is verified and receives a role. The bot also logs the user's IP address and the time of verification.

Installation

You need to have Node.js and pnpm installed.

  1. Clone the repository
  2. Install the required packages with pnpm install
  3. Copy the config.example.json file and rename it to .config.json
  4. Fill in the required fields in the .config.json file (see Settings)
  5. Start the bot with pnpm start

Run with Docker

You can also run the bot with Docker. You need to have Docker installed.

  1. Clone the repository
  2. Copy the config.example.json file and rename it to .config.json
  3. Fill in the required fields in the .config.json file (see Settings)
  4. Run the following command to start the bot: docker compose up -d.
  5. To stop the bot, run the following command: docker compose down

You can set the published ports in the docker-compose.yml file.

Settings

These are the settings that need to be filled in the config.json file:

  • protocol: The protocol of the website (http or https)
  • host: The hostname of the hosted website
  • port: The available port of the website
  • channelId: The ID of the discord channel where the verification embed will be sent
  • channelLogsId: The ID of the discord channel where the logs will be sent
  • verifiedRoleId: The ID of the role that will be given to the verified users
  • discordToken: The token of the discord bot
  • turnstileSitekey: The sitekey of the CloudFlare Turnstile captcha
  • turnstileSecret: The secret of the CloudFlare Turnstile captcha

Development

If you want to contribute to the project, you can use the following commands:

  • pnpm tailwind: Start the tailwindcss compiler in watch mode

The project structure is as follows:

  • modules/discord: Client for Discord
  • modules/website: Webserver and static files
  • modules/events: EventEmitter for communication between discord client and website