mirror of
https://github.com/discourse/discourse.git
synced 2026-08-04 10:39:43 +08:00
04b5530f34#### Description:
This PR renames the `discourse-hcaptcha` plugin to `discourse-captcha`
to better reflect its support for multiple captcha providers (hCaptcha
and reCAPTCHA)
#### Changes
- Renamed plugin directory from plugins/discourse-hcaptcha to
plugins/discourse-captcha
- Updated Ruby module namespace from DiscourseHcaptcha to
DiscourseCaptcha
- Updated references in:
- .gitignore
- pnpm-workspace.yaml
- tsconfig.json
- config/official_plugins.json
- translator.yml
- migrations/core/config/intermediate_db.yml
- `hosted-site` plugin
- Migration file preserved to handle existing discourse_hcaptcha_enabled
setting migration
---------
Co-authored-by: Gabriel Grubba <gabriel@discourse.org>
40 lines
1.6 KiB
Markdown
Vendored
40 lines
1.6 KiB
Markdown
Vendored
# Discourse Captcha Plugin
|
|
|
|
## Overview
|
|
|
|
This plugin integrates captcha verification into the sign-up form of Discourse forums to enhance security and bot protection. The plugin supports two captcha providers:
|
|
|
|
- **hCaptcha**: Privacy-centric captcha service
|
|
- **reCaptcha**: Google's captcha service
|
|
|
|
You can enable either provider based on your preference and requirements.
|
|
|
|
## Installation
|
|
|
|
### For hCaptcha
|
|
|
|
1. **Create an hCaptcha Account**:
|
|
- Visit [hCaptcha](https://www.hcaptcha.com/) to create an account. After registering, you'll receive a site key and a secret key.
|
|
|
|
2. **Configure Plugin Settings**:
|
|
- Log into your Discourse admin panel.
|
|
- Navigate to `Admin` > `Settings` > `Plugins` > `Captcha Plugin`.
|
|
- Enable the master toggle: `discourse_captcha_enabled`
|
|
- Select `hcaptcha` in the `discourse_captcha_provider` setting.
|
|
- Add the site key and secret key you obtained from hCaptcha.
|
|
|
|
### For reCaptcha
|
|
|
|
1. **Create a reCaptcha Account**:
|
|
- Visit [Google reCaptcha](https://www.google.com/recaptcha) to register your site. After registering, you'll receive a site key and a secret key.
|
|
|
|
2. **Configure Plugin Settings**:
|
|
- Log into your Discourse admin panel.
|
|
- Navigate to `Admin` > `Settings` > `Plugins` > `Captcha Plugin`.
|
|
- Enable the master toggle: `discourse_captcha_enabled`
|
|
- Select `recaptcha` in the `discourse_captcha_provider` setting.
|
|
- Add the site key and secret key you obtained from reCaptcha.
|
|
|
|
## Migration Notes
|
|
|
|
If you were using this plugin when it was named "discourse-hcaptcha", your existing settings have been automatically migrated.
|
