====== hCaptcha plugin ======

---- plugin ----

description: 
author     : duncanc  
type       : 
lastupdate : 2021/01/23 10:42
compatible : 
depends    : 
conflicts  : 
similar    : 
tags       : 
sourcerepo : https://github.com/bramley/phplist-plugin-hcaptcha/

----

===== Purpose =====

This plugin provides an hCaptcha field on subscribe forms.

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

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

If you specify a language for a subscribe page then the hCaptcha widget will be displayed in that language. Otherwise the widget will be displayed in the default language (probably the language indicated by the browser). 

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

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

===== Translations =====

The text displayed by the plugin can be translated into other languages. See the file plugins/HCaptchaPlugin/lan/translations_en.php for the English version that can be used as the basis for another language. Each line in the file contains the English text then the equivalent text in the target language.

To create a new language file, copy translations_en.php to translations_xx.php, where xx is the language code, then change the texts for your target language. You then need to login and then logout of phplist for the changes to be added to the database.

You can share your new language file by submitting it for inclusion in the plugin. Please create a topic in the user forum or an issue on GitHub.

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

===== Register to use hCaptcha =====

To use hCaptcha you will need to have an hCaptcha account, see https://www.hcaptcha.com/




===== Settings page =====
On the Settings page you must specify the site key and secret key from your hCaptcha account
{{:plugin:hcaptcha2.png?nolink&400|}}

===== Subscribe pages =====

When you create or edit a subscribe page you can select to include hCaptcha when that page is displayed. The default is to not include hCaptcha. You can also select the theme to be used for the hCaptcha widget and the size of the widget.

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


====== Support ======
Please raise any questions or problems in the user forum https://discuss.phplist.org/