Difference between revisions of "API:EPrints/MetaField/Recaptcha3"

From EPrints Documentation
Jump to: navigation, search
(Created page with "<!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment'...")
 
 
Line 17: Line 17:
 
<!-- Pod2Wiki=head_description -->
 
<!-- Pod2Wiki=head_description -->
 
==DESCRIPTION==
 
==DESCRIPTION==
Please refer to the notes in [EPRINTS_ROOT]/archives/[ARCHIVEID]/cfg/cfg.d/recaptcha3.pl.
+
This metadata field renders a Captcha (a test that humans can easily  pass, but robots shouldn't be able to).
  
If this files does not exist, copy [EPRINTS_ROOT]/lib/defaultcfg/cfg.d/recaptcha3.pl.example to the path above and edit it.
+
Please refer to the wiki page https://wiki.eprints.org/w/Recaptcha3_field for advice on how to configure settings required for this field to work.
  
 +
The following configuration settings will be required, where the <tt>CHANGME</tt> settings will need to be updated with the secret and site keys provided by Google:
 +
 +
$c-&gt;{recaptcha3}-&gt;{private_key} = "CHANGEME";
 +
$c-&gt;{recaptcha3}-&gt;{public_key} = "CHANGEME";
 +
$c-&gt;{recaptcha3}-&gt;{min_score} = 0.5;
 +
 
 
This field uses version 3 of Google "reCAPTCHA" service:
 
This field uses version 3 of Google "reCAPTCHA" service:
  
 
https://developers.google.com/recaptcha/docs/v3
 
https://developers.google.com/recaptcha/docs/v3
  
and renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to).
+
Please use the URL above for guidance on how to generate appropriate keys needed to configure this type of field.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
  
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_methods -->
 +
==METHODS==
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<span style='display:none'>User Comments</span>

Latest revision as of 11:02, 2 August 2024

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::MetaField::Recaptcha3 - a Captcha using Google ReCAPTCHA v3.

User Comments


DESCRIPTION

This metadata field renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to).

Please refer to the wiki page https://wiki.eprints.org/w/Recaptcha3_field for advice on how to configure settings required for this field to work.

The following configuration settings will be required, where the CHANGME settings will need to be updated with the secret and site keys provided by Google:

$c->{recaptcha3}->{private_key} = "CHANGEME";
$c->{recaptcha3}->{public_key} = "CHANGEME";
$c->{recaptcha3}->{min_score} = 0.5;
 

This field uses version 3 of Google "reCAPTCHA" service:

https://developers.google.com/recaptcha/docs/v3

Please use the URL above for guidance on how to generate appropriate keys needed to configure this type of field.

User Comments


METHODS

User Comments


COPYRIGHT

© Copyright 2000-2024 University of Southampton.

EPrints 3.4 is supplied by EPrints Services.

http://www.eprints.org/eprints-3.4/

LICENSE

This file is part of EPrints 3.4 http://www.eprints.org/.

EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.

EPrints 3.4 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.

User Comments