Introduction

plone.formwidget.hcaptcha is a z3c.form HCaptcha widget for use with Plone.

It is a re-work of the 'plone.formwidget.recaptcha'_ package original written by Timo Stollenwerk.

Buildout Installation

Add the following code to your buildout.cfg to install plone.formwidget.hcaptcha:

[buildout]
...

[instance]
...
eggs =
    ...
    plone.formwidget.hcaptcha
    ...

HCaptcha setup

There is a control panel at http://path/to/site/@@hcaptcha-settings to configure the Addon. HCaptcha provides test keys, that can be used to try out the hcaptcha form and documentation at https://docs.hcaptcha.com/.

Site key: 10000000-ffff-ffff-ffff-000000000001

Secret key: 0x0000000000000000000000000000000000000000

To actually use the service, you must obtain a site key and secret key from https://www.hcaptcha.com/signup-interstitial

Verification endpoint

According to the official hCaptcha documentation (https://docs.hcaptcha.com/#server), the token verification endpoint is:

https://api.hcaptcha.com/siteverify

This package now uses api.hcaptcha.com by default instead of hcaptcha.com. If you need to change the host (e.g. staging or internal testing), set the environment variable before starting your Plone instance:

HCAPTCHA_VERIFY_SERVER=api.hcaptcha.com

If the variable is not defined, the safe default (api.hcaptcha.com) will be used.

Usage

See the demo folder inside the distribution for an example usage.

Supermodel

You can add a captcha field in an XML model by adding something like this:

<field name="captcha" type="plone.formwidget.hcaptcha.HCaptchaWidget">
  <title>Solve Captcha</title>
  <description></description>
</field>

Source Code

Contributors please read the document Process for Plone core's development

Sources are at the Plone code repository hosted at Github.