Discourse/discourse
Discourse/discourse
0
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2026-08-04 10:39:43 +08:00
Code Packages Activity Actions
discourse/plugins/discourse-captcha/README.md
Juan David Martínez Cubillos 04b5530f34
 DEV: Plugin rename discourse captcha (#39350) 
####  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>
2026-07-21 17:21:39 -05:00

1.6 KiB
Vendored
Raw Permalink Blame History

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 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 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.