README

Provides a Google Recaptcha Spam Guard for use with SilverStripe v4 forms.

Requirements
Installation
Configuration
Issues
Contribution
Attribution
Maintainers
License

Requirements

Installation

Installation is via Composer:

$ composer require silverware/recaptcha

Configuration

In order to use Recaptcha as the default spam guard for all forms, you will need to set it as the DefaultSpamGuard in your YAML configuration:

SilverStripe\Core\Injector\Injector:
  DefaultSpamGuard:
    class: SilverWare\Recaptcha\Guards\RecaptchaGuard

Additionally, you will need to create public and private API keys via the Google Recaptcha admin. Google refers to these as a "site key" and a "secret", respectively. Once you have created your keys, add them to your YAML configuration:

SilverWare\Recaptcha\Fields\RecaptchaField:
  public_api_key: '<your-site-key>'
  private_api_key: '<your-secret>'

Each RecaptchaField has a config array which defines the data attributes for the Recaptcha element. You can define the default config by adding the following to your YAML configuration:

SilverWare\Recaptcha\Fields\RecaptchaField:
  default_config:
    theme: dark
    size: compact

This would configure each instance of Recaptcha to use the dark theme and compact size.

Issues

Please use the issue tracker for bug reports and feature requests.

Contribution

Your contributions are gladly welcomed to help make this project better. Please see contributing for more information.

Attribution

Makes use of Guzzle by Michael Dowling and others.

silverware / recaptcha

Maintainers

Details