mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/ConfirmEdit
synced 2024-12-04 12:38:40 +00:00
Attempt to more consistently document $wg values in extension.json and README
Change-Id: I83ae3dc8a2bd1d9e4655eba1d8da5e5974930357
This commit is contained in:
parent
da22e2c767
commit
12490340ff
32
README.md
32
README.md
|
@ -101,12 +101,12 @@ $wgCaptchaStorageClass = 'MediaWiki\Extension\ConfirmEdit\Store\CaptchaSessionSt
|
||||||
* Number of seconds a captcha session should last in the data cache
|
* Number of seconds a captcha session should last in the data cache
|
||||||
* before expiring when managing through CaptchaCacheStore class.
|
* before expiring when managing through CaptchaCacheStore class.
|
||||||
*
|
*
|
||||||
* Default is a half hour.
|
* Default is a half-hour.
|
||||||
*/
|
*/
|
||||||
$wgCaptchaSessionExpiration = 30 * 60;
|
$wgCaptchaSessionExpiration = 30 * 60;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Number of seconds after a bad login that a captcha will be shown to
|
* Number of seconds after a bad login (from a specific IP address) that a captcha will be shown to
|
||||||
* that client on the login form to slow down password-guessing bots.
|
* that client on the login form to slow down password-guessing bots.
|
||||||
*
|
*
|
||||||
* Has no effect if 'badlogin' is disabled in $wgCaptchaTriggers or
|
* Has no effect if 'badlogin' is disabled in $wgCaptchaTriggers or
|
||||||
|
@ -116,9 +116,20 @@ $wgCaptchaSessionExpiration = 30 * 60;
|
||||||
*/
|
*/
|
||||||
$wgCaptchaBadLoginExpiration = 5 * 60;
|
$wgCaptchaBadLoginExpiration = 5 * 60;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of seconds after a bad login (for a specific user account) that a captcha will be shown to
|
||||||
|
* that client on the login form to slow down password-guessing bots.
|
||||||
|
*
|
||||||
|
* Has no effect if 'badlogin' is disabled in $wgCaptchaTriggers or
|
||||||
|
* if there is not a caching engine enabled.
|
||||||
|
*
|
||||||
|
* Default is 10 minutes
|
||||||
|
*/
|
||||||
|
$wgCaptchaBadLoginPerUserExpiration = 10 * 60;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Allow users who have confirmed their email addresses to post
|
* Allow users who have confirmed their email addresses to post
|
||||||
* URL links without being harassed by the captcha.
|
* URL links without being shown a captcha.
|
||||||
*
|
*
|
||||||
* @deprecated since 1.36
|
* @deprecated since 1.36
|
||||||
* $wgGroupPermissions['emailconfirmed']['skipcaptcha'] = true; should be used instead.
|
* $wgGroupPermissions['emailconfirmed']['skipcaptcha'] = true; should be used instead.
|
||||||
|
@ -126,11 +137,17 @@ $wgCaptchaBadLoginExpiration = 5 * 60;
|
||||||
$wgAllowConfirmedEmail = false;
|
$wgAllowConfirmedEmail = false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Number of bad login attempts before triggering the captcha. 0 means the
|
* Number of bad login attempts (from a specific IP address) before triggering the captcha. 0 means the
|
||||||
* captcha is presented on the first login.
|
* captcha is presented on the first login.
|
||||||
*/
|
*/
|
||||||
$wgCaptchaBadLoginAttempts = 3;
|
$wgCaptchaBadLoginAttempts = 3;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of bad login attempts (for a specific user account) before triggering the captcha. 0 means the
|
||||||
|
* captcha is presented on the first login.
|
||||||
|
*/
|
||||||
|
$wgCaptchaBadLoginPerUserAttempts = 20;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Regex to ignore URLs to known-good sites...
|
* Regex to ignore URLs to known-good sites...
|
||||||
* For instance:
|
* For instance:
|
||||||
|
@ -144,9 +161,14 @@ $wgCaptchaIgnoredUrls = false;
|
||||||
* other than URLs such as junk edits.
|
* other than URLs such as junk edits.
|
||||||
*
|
*
|
||||||
* If the new version matches one and the old version doesn't,
|
* If the new version matches one and the old version doesn't,
|
||||||
* toss up the captcha screen.
|
* show the captcha screen.
|
||||||
*
|
*
|
||||||
* @fixme Add a message for local admins to add items as well.
|
* @fixme Add a message for local admins to add items as well.
|
||||||
*/
|
*/
|
||||||
$wgCaptchaRegexes = [];
|
$wgCaptchaRegexes = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Feature flag to toggle list of available custom actions to enable in AbuseFilter. See AbuseFilterHooks::onAbuseFilterCustomActions
|
||||||
|
*/
|
||||||
|
$wgConfirmEditEnabledAbuseFilterCustomActions = [];
|
||||||
```
|
```
|
||||||
|
|
|
@ -127,9 +127,11 @@
|
||||||
"value": false
|
"value": false
|
||||||
},
|
},
|
||||||
"Captcha": {
|
"Captcha": {
|
||||||
|
"description": "Captcha class to be used; when enabling sub extensions (ie FancyCaptcha) this will be set for you",
|
||||||
"value": null
|
"value": null
|
||||||
},
|
},
|
||||||
"CaptchaTriggers": {
|
"CaptchaTriggers": {
|
||||||
|
"description": "Actions which can trigger a captcha",
|
||||||
"value": {
|
"value": {
|
||||||
"edit": false,
|
"edit": false,
|
||||||
"create": false,
|
"create": false,
|
||||||
|
@ -142,28 +144,36 @@
|
||||||
"merge_strategy": "array_plus"
|
"merge_strategy": "array_plus"
|
||||||
},
|
},
|
||||||
"CaptchaTriggersOnNamespace": {
|
"CaptchaTriggersOnNamespace": {
|
||||||
|
"description": "Allows forcing/turning off Captcha in specific namespaces",
|
||||||
"value": {},
|
"value": {},
|
||||||
"merge_strategy": "array_plus_2d"
|
"merge_strategy": "array_plus_2d"
|
||||||
},
|
},
|
||||||
"CaptchaStorageClass": {
|
"CaptchaStorageClass": {
|
||||||
|
"description": "PHP class used for storing Captcha related session data",
|
||||||
"value": "MediaWiki\\Extension\\ConfirmEdit\\Store\\CaptchaSessionStore"
|
"value": "MediaWiki\\Extension\\ConfirmEdit\\Store\\CaptchaSessionStore"
|
||||||
},
|
},
|
||||||
"CaptchaSessionExpiration": {
|
"CaptchaSessionExpiration": {
|
||||||
|
"description": "Number of seconds a captcha session should last in the data cache before expiring when managing through CaptchaCacheStore class.",
|
||||||
"value": 1800
|
"value": 1800
|
||||||
},
|
},
|
||||||
"CaptchaBadLoginExpiration": {
|
"CaptchaBadLoginExpiration": {
|
||||||
|
"description": "Number of seconds after a bad login (from a specific IP address) that a captcha will be shown to that client on the login form to slow down password-guessing bots.",
|
||||||
"value": 300
|
"value": 300
|
||||||
},
|
},
|
||||||
"CaptchaBadLoginPerUserExpiration": {
|
"CaptchaBadLoginPerUserExpiration": {
|
||||||
|
"description": "Number of seconds after a bad login (for a specific user account) that a captcha will be shown to that client on the login form to slow down password-guessing bots.",
|
||||||
"value": 600
|
"value": 600
|
||||||
},
|
},
|
||||||
"AllowConfirmedEmail": {
|
"AllowConfirmedEmail": {
|
||||||
|
"description": "Allow users who have confirmed their email addresses to post URL links without being shown a captcha.",
|
||||||
"value": false
|
"value": false
|
||||||
},
|
},
|
||||||
"CaptchaBadLoginAttempts": {
|
"CaptchaBadLoginAttempts": {
|
||||||
|
"description": "Number of bad login attempts (from a specific IP address) before triggering the captcha. 0 means the captcha is presented on the first login.",
|
||||||
"value": 3
|
"value": 3
|
||||||
},
|
},
|
||||||
"CaptchaBadLoginPerUserAttempts": {
|
"CaptchaBadLoginPerUserAttempts": {
|
||||||
|
"description": "Number of bad login attempts (for a specific user account) before triggering the captcha. 0 means the captcha is presented on the first login.",
|
||||||
"value": 20
|
"value": 20
|
||||||
},
|
},
|
||||||
"CaptchaWhitelist": {
|
"CaptchaWhitelist": {
|
||||||
|
@ -175,6 +185,7 @@
|
||||||
"value": false
|
"value": false
|
||||||
},
|
},
|
||||||
"CaptchaRegexes": {
|
"CaptchaRegexes": {
|
||||||
|
"description": "Additional regexes to check for. Use full regexes; can match things other than URLs such as junk edits. If the new version matches one and the old version doesn't, show the captcha screen.",
|
||||||
"value": []
|
"value": []
|
||||||
},
|
},
|
||||||
"ConfirmEditEnabledAbuseFilterCustomActions": {
|
"ConfirmEditEnabledAbuseFilterCustomActions": {
|
||||||
|
|
Loading…
Reference in a new issue