Recaptcha field - Revision history

Drn@ecs.soton.ac.uk at 08:32, 21 July 2024

2024-07-21T08:32:57Z

Drn@ecs.soton.ac.uk: Improved description

2024-07-21T08:31:36Z

Improved description

Drn@ecs.soton.ac.uk at 08:23, 21 July 2024

2024-07-21T08:23:12Z

Drn@ecs.soton.ac.uk: Updated description

2024-07-21T08:21:19Z

Updated description

Drn@ecs.soton.ac.uk: Added database section

2023-04-11T08:55:30Z

Added database section

Drn@ecs.soton.ac.uk: /* Required Phrases */

2023-04-09T22:56:39Z

‎Required Phrases

Drn@ecs.soton.ac.uk: /* Properties */

2023-04-09T22:54:03Z

‎Properties

Drn@ecs.soton.ac.uk: Added ToC. Added API and Examples sections. Reorganised other sections.

2023-04-08T21:50:56Z

Added ToC. Added API and Examples sections. Reorganised other sections.

Drn@ecs.soton.ac.uk at 00:37, 6 March 2022

2022-03-06T00:37:41Z

Drn@ecs.soton.ac.uk: Added Recaptcha field page

2022-02-15T00:59:30Z

Added Recaptcha field page

New page

{{fieldtypes}}
__NOTOC__
== Inheritance ==

* [[:Category:EPrints_Metadata_Fields|Metadata Field]]
** [[Id field]]
*** [[Recaptcha field]]

== Description ==

Please refer to the notes in EPRINTS_PATH/archives/ARCHIVE_NAME/cfg/cfg.d/recaptcha.pl.

If this files does not exist, copy EPRINTS_PATH/lib/defaultcfg/cfg.d/recaptcha.pl.example
to the path above and edit it.

This field uses the Google "reCAPTCHA" service (https://www.google.com/recaptcha/intro/) and
renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to).

Note:
This MetaField was updated in October 2017 to reCAPTCHA v2.
The previous version of reCAPTCHA will cease to work in March 2018.

== Properties ==
As for [[Id field]]s.

== Required Phrases ==
'''validate:recaptcha_mismatch''' - Phrase to display if reCAPTCHA submission errored in some way.

@@ Line 9: / Line 9: @@
   $c->{recaptcha}->{public_key} = "CHANGEME";
-As this field uses the Google's reCAPTCHAv2 service and renders a Captcha, (a test that humans can easily pass, but robots shouldn't be able to), you will need to use a Google account to generate a private key and public key (also known by Google as a '''secret key''' and '''site key''' respectively) for the above configuration.  This can be done via Google's '''[https://www.google.com/recaptcha/admin/create Site Registration Tool]'''.  By sure to use version 2 (reCAPTCHAv2) when registering.
+As this field uses the Google's reCAPTCHAv2 service and renders a Captcha, (a test that humans can easily pass, but robots shouldn't be able to), you will need to use a Google account to generate a private key and public key (also known by Google as a '''secret key''' and '''site key''' respectively) for the above configuration.  This can be done via Google's '''[https://www.google.com/recaptcha/admin/create Site Registration Tool]'''.  By sure to use '''Challenge (v2)''' option when registering.
 If you are setting up a Recaptcha field for protecting request copy forms, you will need to add the following configuration to a file in your archive's <code>cfg/cfg.d/</code> directory.

@@ Line 3: / Line 3: @@
 == Description ==
-Allows a Captcha using [https://developers.google.com/recaptcha/docs/display Google's reCAPTCHAv2 API] to be added to a form to protect it from being spammed by bots.
+Allows a Captcha using [https://developers.google.com/recaptcha/docs/display Google's reCAPTCHAv2 service] to be added to a form to protect it from being spammed by bots.
 Add the following configuration to a file called <code>cfg/cfg.d/recaptcha.pl</code> in your archive, if it does not already exist.
@@ Line 9: / Line 9: @@
   $c->{recaptcha}->{public_key} = "CHANGEME";
-As this field uses the Google "reCAPTCHAv2" service and renders a Captcha, (a test that humans can easily pass, but robots shouldn't be able to), you will need to use a Google account to generate a private and public key (also known by Google as a secret key and site key respectively) for the above configuration.  This can be done via Google's '''[https://www.google.com/recaptcha/admin/create Site Registration Tool]'''.  By sure to use version 2 (ReCAPTCHAv2) when registering.
+As this field uses the Google's reCAPTCHAv2 service and renders a Captcha, (a test that humans can easily pass, but robots shouldn't be able to), you will need to use a Google account to generate a private key and public key (also known by Google as a '''secret key''' and '''site key''' respectively) for the above configuration.  This can be done via Google's '''[https://www.google.com/recaptcha/admin/create Site Registration Tool]'''.  By sure to use version 2 (reCAPTCHAv2) when registering.
 If you are setting up a Recaptcha field for protecting request copy forms, you will need to add the following configuration to a file in your archive's <code>cfg/cfg.d/</code> directory.

@@ Line 3: / Line 3: @@
 == Description ==
-Allows a Captcha using [https://developers.google.com/recaptcha/docs/display Google's ReCAPTCHAv2 API] to be added to a form to protect it from being spammed by bots.
+Allows a Captcha using [https://developers.google.com/recaptcha/docs/display Google's reCAPTCHAv2 API] to be added to a form to protect it from being spammed by bots.
 Add the following configuration to a file called <code>cfg/cfg.d/recaptcha.pl</code> in your archive, if it does not already exist.
@@ Line 9: / Line 9: @@
   $c->{recaptcha}->{public_key} = "CHANGEME";
-This field uses the Google "reCAPTCHAv2" service and renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to).  You will need to use a Google account to generate a private and public key (also known by Google as a secret key and site key respectively) for the above configuration, this can be done via the '''[https://www.google.com/recaptcha/admin/create Site Registration Tool]'''.  By sure to use version 2 (ReCAPTCHAv2) when registering.
+As this field uses the Google "reCAPTCHAv2" service and renders a Captcha, (a test that humans can easily pass, but robots shouldn't be able to), you will need to use a Google account to generate a private and public key (also known by Google as a secret key and site key respectively) for the above configuration.  This can be done via Google's '''[https://www.google.com/recaptcha/admin/create Site Registration Tool]'''.  By sure to use version 2 (ReCAPTCHAv2) when registering.
 If you are setting up a Recaptcha field for protecting request copy forms, you will need to add the following configuration to a file in your archive's <code>cfg/cfg.d/</code> directory.

@@ Line 3: / Line 3: @@
 == Description ==
-Please refer to the notes in <tt>EPRINTS_PATH/archives/ARCHIVEID/cfg/cfg.d/recaptcha.pl</tt>.
+Allows a Captcha using [https://developers.google.com/recaptcha/docs/display Google's ReCAPTCHAv2 API] to be added to a form to protect it from being spammed by bots.
-If this files does not exist, copy <tt>EPRINTS_PATH/lib/defaultcfg/cfg.d/recaptcha.pl.example</tt>
+Add the following configuration to a file called <code>cfg/cfg.d/recaptcha.pl</code> in your archive, if it does not already exist.
-to the path above and edit it.
+ $c->{recaptcha}->{private_key} = "CHANGEME";
-This field uses the Google "reCAPTCHA" service (https://www.google.com/recaptcha/intro/) and
+This field uses the Google "reCAPTCHAv2" service and renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to).  You will need to use a Google account to generate a private and public key (also known by Google as a secret key and site key respectively) for the above configuration, this can be done via the '''[https://www.google.com/recaptcha/admin/create Site Registration Tool]'''.  By sure to use version 2 (ReCAPTCHAv2) when registering.
 renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to).
 == Inheritance ==

@@ Line 21: / Line 21: @@
 == Required Phrases ==
 <tt>validate:recaptcha_mismatch</tt> - Phrase to display if reCAPTCHA submission errored in some way.
 == API ==

@@ Line 16: / Line 16: @@
 *** [[Recaptcha field]]
-== Properties ==
+== Additional Properties ==
-As for [[Id field]]s.
+As for [[Id field#Additional_Phrases|Id fields]].
 == Required Phrases ==

@@ Line 1: / Line 1: @@
 {{fieldtypes}}
 == Description ==
-Please refer to the notes in EPRINTS_PATH/archives/ARCHIVEID/cfg/cfg.d/recaptcha.pl.
+If this files does not exist, copy <tt>EPRINTS_PATH/lib/defaultcfg/cfg.d/recaptcha.pl.example</tt>
 to the path above and edit it.
@@ Line 18: / Line 11: @@
 renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to).
-Note:
+== Inheritance ==
-This MetaField was updated in October 2017 to reCAPTCHA v2.
+* [[:Category:EPrints_Metadata_Fields|Metadata Field]]
-The previous version of reCAPTCHA will cease to work in March 2018.
+** [[Id field]]
 == Properties ==
@@ Line 27: / Line 21: @@
 == Required Phrases ==
 '''validate:recaptcha_mismatch''' - Phrase to display if reCAPTCHA submission errored in some way.

@@ Line 10: / Line 10: @@
 == Description ==
-Please refer to the notes in EPRINTS_PATH/archives/ARCHIVE_NAME/cfg/cfg.d/recaptcha.pl.
+Please refer to the notes in EPRINTS_PATH/archives/ARCHIVEID/cfg/cfg.d/recaptcha.pl.
 If this files does not exist, copy EPRINTS_PATH/lib/defaultcfg/cfg.d/recaptcha.pl.example