webbuilders-group / silverstripe-turnstile
A spam protector and form field using CloudFlare's Turnstile
Installs: 1 408
Dependents: 1
Suggesters: 0
Security: 0
Stars: 4
Watchers: 2
Forks: 1
Open Issues: 0
Type:silverstripe-vendormodule
Requires
- silverstripe/framework: >=4.0,<6.0
- silverstripe/spamprotection: >=3.0,<5.0
Requires (Dev)
This package is auto-updated.
Last update: 2024-10-10 13:22:48 UTC
README
Adds a "spam protection" field to Silverstripe userforms using Cloudflare's Turnstile service.
Maintainer Contact
- Ed Chipman (UndefinedOffset)
Requirements
- Silverstripe Framework ~4.0 or ~5.0
- silverstripe/spamprotection ~3.0 or ~4.0
Installation
composer require webbuilders-group/silverstripe-turnstile
Configuration
There are multiple configuration options for the field, you must set the site_key and the secret_key which you can get from Cloudflare/. These configuration options must be added to your site's yaml config typically this is app/\_config/config.yml
.
SilverStripe\SpamProtection\Extension\FormSpamProtectionExtension: default_spam_protector: WebbuildersGroup\Turnstile\Forms\TurnstileProtector #Set the default spam protector WebbuildersGroup\Turnstile\Forms\TurnstileField: site_key: '`TURNSTILE_SITE_KEY`' #Your site key (required) secret_key: '`TURNSTILE_SECRET_KEY`' #Your secret key (required) verify_ssl: true #Allows you to disable php-curl's SSL peer verification by setting this to false (optional, defaults to true) default_theme: "light" #Default theme color (optional, light, dark or auto, defaults to light) js_onload_callback: null #Onload callback to be called when the JS for Turnstile is loaded proxy_server: "`SS_OUTBOUND_PROXY_SERVER`" #Your proxy server address (optional) proxy_port: "`SS_OUTBOUND_PROXY_PORT`" #Your proxy server address port (optional) proxy_auth: "`SS_OUTBOUND_PROXY_AUTH`" #Your proxy server authentication information (optional)
Adding field labels
If you want to add a field label or help text to the Captcha field you can do so like this:
$form->enableSpamProtection() ->Fields() ->fieldByName('Captcha') ->setTitle('Spam protection') ->setDescription('Your description here');
Adding Custom Attributes
Turnstile has a few other options that this module does not out of the box provide hooks for setting, however you can set them your self using setAttribute
for example:
$form->enableSpamProtection() ->Fields() ->fieldByName('Captcha') ->setAttribute('data-action', 'action') ->setAttribute('data-cdata', 'payload') ->setAttribute('data-callback', 'yourChallengeJSCallback') ->setAttribute('data-expired-callback', 'yourExpiredJSCallback') ->setAttribute('data-error-callback', 'youErrorJSCallback') ->setAttribute('data-tabindex', 0);