susanne/hcaptcha

TYPO3 Extension to Add hCaptcha to EXT:form - The privacy friendly captcha alternative.

Installs: 1 060

Dependents: 0

Suggesters: 0

Security: 0

Type:typo3-cms-extension

1.0.0 2020-10-25 14:14 UTC

This package is not auto-updated.

Last update: 2021-02-19 17:46:03 UTC


README

codecov pipeline license phpstan

Provides hCaptcha integration for TYPO3 EXT:form.

hCaptcha is a free to use alternative to Google reCaptcha with a bigger focus on privacy. It supports initiatives like PrivacyPass.

For more information, see the hCaptcha website.

Additionally, hCaptcha provides earnings for solved captchas - that can be donated to the Wikimedia foundation automatically (which is the case for the default settings of this extension).

Quick Setup

hCaptcha is configured with a default key to make the setup as easy as possible. It is recommended to create a custom account for your site with hCaptcha and add your own keys.

  • Install the extension and activate it
  • Include the static template in TypoScript
  • Add a hCaptcha element to a form

TypoScript Constants

Set the following constants if you are using your own account:

plugin.tx_hcaptcha {
  settings {
    publicKey = <your-public-key>
    privateKey = <your-private-key>
  }
}

Environment variables

As an alternative to the TypoScript configuration, you can also use environment variables:

  • HCAPTCHA_PUBLIC_KEY
  • HCAPTCHA_PRIVATE_KEY

Content Security Policy

If you are using CSP, make sure to adjust them accordingly:

  • script-src should include https://hcaptcha.com, https://*.hcaptcha.com
  • frame-src should include https://hcaptcha.com, https://*.hcaptcha.com
  • style-src should include https://hcaptcha.com, https://*

Privacy

Make sure to inform your users of your usage of hCaptcha and what that means - especially if you are using the invisible Enterprise version.

For more info see: https://docs.hcaptcha.com/faq

Help & Support

Follow me on Twitter or read my blog entry about hCaptcha at susi.dev.