====== reCAPTCHA V3======

---- plugin ----
description: This plugin provides a Google reCAPTCHA V3 field on subscribe forms.
author     : Duncan Cameron
type       : 
lastupdate : 2021-12-28
compatible : 3.x
depends    : 
conflicts  : 
similar    : 
tags       : spam

sourcerepo : https://github.com/bramley/phplist-plugin-recaptchav3

----

This plugin provides a Google reCAPTCHA V3 field for subscribe pages. See https://www.google.com/recaptcha/intro/index.html
for information on how reCAPTCHA works.


You can select whether to include reCAPTCHA for each individual subscribe page.

====== Installation ======

See the README file on the GitHub page https://github.com/bramley/phplist-plugin-recaptchav3 for how to install or upgrade the plugin.


====== Configuration ======

===== Register with Google to use reCAPTCHA =====

To use reCAPTCHA you will need to have a Google account (such as a gmail address).
See https://www.google.com/recaptcha/admin

The plugin supports the v3 type of reCAPTCHA which has no user interaction. reCAPTCHA calculates a score for each subscription attempt. If the score is lower than a configurable threshold then the subscription attempt is rejected.

See https://developers.google.com/recaptcha/docs/versions for an explanation of the different types of reCAPTCHA.

When registering a new site you need to enter the domain on which phplist is installed, e.g. ''mysite.com'', there is no need to include ''www'' or a sub-domain.

{{:plugin:recaptchav3_1.png?nolink&400|}}

===== Settings page =====
On the Settings page you must specify:

  * The reCAPTCHA site key and secret key obtained by registering for the reCAPTCHA service.
  * The threshold for treating a subscription attempt as spam.

{{:plugin:recaptchav3_2.png?nolink&500|}}
===== Subscribe pages =====

When you create or edit a subscribe page you can select to include reCAPTCHA when that page is displayed. The default is to not include reCAPTCHA.


{{:plugin:recaptchav3_3.png?nolink&400|}}
====== Support ======
Please raise any questions or problems in the user forum https://discuss.phplist.org/