Skip to content

Commit

Permalink
Updated config docs for reCAPTCHA
Browse files Browse the repository at this point in the history
  • Loading branch information
@eSilverStrike
eSilverStrike committed May 25, 2018
1 parent 69a43e3 commit a733d2c
Showing 1 changed file with 46 additions and 34 deletions.
80 changes: 46 additions & 34 deletions public_html/admin/plugins/recaptcha/docs/english/config.html
View file
Expand Up @@ -8,6 +8,18 @@

<body>

<h1>reCAPTCHA Types</h1>

<p>Geeklog's reCAPTCHA plugin supports both reCAPTCHA v2 and Invisible reCAPTCHA. Both will require you to setup on the Google reCAPTCHA website (<a href="https://www.google.com/recaptcha/admin/create">https://www.google.com/recaptcha/admin/create</a>). You will need to create an account and add your site and create a site key and a secret key to be able to use the free service.</p>

<h2>reCAPTCHA v2</h2>
<p>reCAPTCHA v2 requires the user to click a checkbox indicating the user is not a robot. This will either pass the user immediately (with No CAPTCHA) or challenge them to validate whether or not they are human.</p>

<h2>Invisible reCAPTCHA</h2>
<p>Unlike reCAPTCHA v2, 'Invisible reCAPTCHA' does not require the user to click on a checkbox, instead it is invoked directly when the user clicks on an existing button on your site. By default only the most suspicious traffic will be prompted to solve a captcha. To alter this behavior edit your site security preference under advanced settings on the Google reCAPTCHA website.</p>

<p>For more information on the different reCAPTCHA types please go to <a href="https://developers.google.com/recaptcha/docs/versions">https://developers.google.com/recaptcha/docs/versions</a>.</p>

<h1>reCAPTCHA&reg; Plugin Configuration</h1>

<h2><a name="system">System</a></h2>
Expand Down Expand Up @@ -57,16 +69,6 @@ <h2><a name="system">System</a></h2>
(recaptcha.log).
</td>
</tr>
</table>

<h2><a name="integration">Integration</a></h2>

<table border="1" width="100%">
<tr>
<th style="width: 20%;">Variable</th>
<th style="width: 20%;">Default Value</th>
<th style="width: 60%;">Description</th>
</tr>
<tr>
<td valign="top"><a name="desc_anonymous_only">anonymous_only</a></td>
<td valign="top">No</td>
Expand All @@ -77,65 +79,75 @@ <h2><a name="integration">Integration</a></h2>
<td valign="top">No</td>
<td valign="top">If you set this to Yes, reCAPTCHA will be forced upon all Remote Users.</td>
</tr>
</table>

<h2><a name="integration">Integration</a></h2>

<table border="1" width="100%">
<tr>
<th style="width: 20%;">Variable</th>
<th style="width: 20%;">Default Value</th>
<th style="width: 60%;">Description</th>
</tr>
<tr>
<td valign="top"><a name="desc_enable_comment">enable_comment</a></td>
<td valign="top">Yes</td>
<td valign="top">If you set this to Yes, reCAPTCHA will be enabled for comments.</td>
<td valign="top">reCAPTCHA v2</td>
<td valign="top">If you set this to reCAPTCHA v2, reCAPTCHA (version 2) will be enabled for comments. If set to invisible reCAPTCHA, the invisible version will be used.</td>
</tr>
<tr>
<td valign="top"><a name="desc_enable_contact">enable_contact</a></td>
<td valign="top">Yes</td>
<td valign="top">If you set this to Yes, reCAPTCHA will be enabled for contact.</td>
<td valign="top">reCAPTCHA v2</td>
<td valign="top">If you set this to reCAPTCHA v2, reCAPTCHA (version 2) will be enabled for contact. If set to invisible reCAPTCHA, the invisible version will be used.</td>
</tr>
<tr>
<td valign="top"><a name="desc_enable_emailstory">enable_emailstory</a></td>
<td valign="top">Yes</td>
<td valign="top">If you set this to Yes, reCAPTCHA will be enabled for emailing a story.</td>
<td valign="top">reCAPTCHA v2</td>
<td valign="top">If you set this to reCAPTCHA v2, reCAPTCHA (version 2) will be enabled for emailing a article. If set to invisible reCAPTCHA, the invisible version will be used.</td>
</tr>
<tr>
<td valign="top"><a name="desc_enable_forum">enable_forum</a></td>
<td valign="top">Yes</td>
<td valign="top">If you set this to Yes, reCAPTCHA will be enabled for the Forum plugin.</td>
<td valign="top">reCAPTCHA v2</td>
<td valign="top">If you set this to reCAPTCHA v2, reCAPTCHA (version 2) will be enabled for the Forum plugin. If set to invisible reCAPTCHA, the invisible version will be used.</td>
</tr>
<tr>
<td valign="top"><a name="desc_enable_registration">enable_registration</a></td>
<td valign="top">Yes</td>
<td valign="top">If you set this to Yes, reCAPTCHA will be enabled for user registration.</td>
<td valign="top">reCAPTCHA v2</td>
<td valign="top">If you set this to reCAPTCHA v2, reCAPTCHA (version 2) will be enabled for user registration. If set to invisible reCAPTCHA, the invisible version will be used.</td>
</tr>
<tr>
<td valign="top"><a name="desc_enable_mediagallery">enable_mediagallery</a></td>
<td valign="top">Yes</td>
<td valign="top">If you set this to Yes, reCAPTCHA will be enabled for the Mediagallery plugin.</td>
<td valign="top">reCAPTCHA v2</td>
<td valign="top">If you set this to reCAPTCHA v2, reCAPTCHA (version 2) will be enabled for the Mediagallery plugin. invisible reCAPTCHA is currently not supported by the Mediagallery plugin.</td>
</tr>
<tr>
<td valign="top"><a name="desc_enable_rating">enable_rating</a></td>
<td valign="top">Yes</td>
<td valign="top">If you set this to Yes, reCAPTCHA will be enabled for the Rating plugin.</td>
<td valign="top">reCAPTCHA v2</td>
<td valign="top">If you set this to reCAPTCHA v2, reCAPTCHA (version 2) will be enabled for the Rating plugin. invisible reCAPTCHA is currently not supported by the Rating plugin.</td>
</tr>
<tr>
<td valign="top"><a name="desc_enable_story">enable_story</a></td>
<td valign="top">Yes</td>
<td valign="top">If you set this to Yes, reCAPTCHA will be enabled for submitting a story.</td>
<td valign="top">reCAPTCHA v2</td>
<td valign="top">If you set this to reCAPTCHA v2, reCAPTCHA (version 2) will be enabled for submitting a article. If set to invisible reCAPTCHA, the invisible version will be used.</td>
</tr>
<tr>
<td valign="top"><a name="desc_enable_calendar">enable_calendar</a></td>
<td valign="top">Yes</td>
<td valign="top">If you set this to Yes, reCAPTCHA will be enabled for the Calendar plugin.</td>
<td valign="top">reCAPTCHA v2</td>
<td valign="top">If you set this to reCAPTCHA v2, reCAPTCHA (version 2) will be enabled for the Calendar plugin. If set to invisible reCAPTCHA, the invisible version will be used.</td>
</tr>
<tr>
<td valign="top"><a name="desc_enable_links">enable_links</a></td>
<td valign="top">Yes</td>
<td valign="top">If you set this to Yes, reCAPTCHA will be enabled for the Links plugin.</td>
<td valign="top">reCAPTCHA v2</td>
<td valign="top">If you set this to reCAPTCHA v2, reCAPTCHA (version 2) will be enabled for the Links plugin. If set to invisible reCAPTCHA, the invisible version will be used.</td>
</tr>
<tr>
<td valign="top"><a name="desc_enable_getpassword">enable_getpassword</a></td>
<td valign="top">Yes</td>
<td valign="top">If you set this to Yes, reCAPTCHA will be enabled for Forget Password Form.</td>
<td valign="top">reCAPTCHA v2</td>
<td valign="top">If you set this to reCAPTCHA v2, reCAPTCHA (version 2) will be enabled for Forget Password Form. If set to invisible reCAPTCHA, the invisible version will be used.</td>
</tr>
<tr>
<td valign="top"><a name="desc_enable_loginform">enable_loginform</a></td>
<td valign="top">Yes</td>
<td valign="top">If you set this to Yes, reCAPTCHA will be enabled for Login Form.</td>
<td valign="top">reCAPTCHA v2</td>
<td valign="top">If you set this to reCAPTCHA v2, reCAPTCHA (version 2) will be enabled for Login Form. If set to invisible reCAPTCHA, the invisible version will be used.</td>
</tr>
</table>

Expand Down

0 comments on commit a733d2c

Please sign in to comment.