Extension:ConfirmAccount

From MediaWiki.org

Jump to: navigation, search
Manual on MediaWiki Extensions
List of MediaWiki Extensions
Confirm Account

Release status: stable
Implementation User identity, Database
Description Requires submission and approval of accounts.
Author(s) Aaron Schulz
Version 1.41
MediaWiki 1.11+
Download SVN
Added rights confirmaccount, requestips, lookupcredentials

The ConfirmAccount extension disables direct account creation and requires submission and approval of accounts by bureaucrats. Account creations can be enabled through configuring user rights, such as if you wanted Sysops/Bureaucrats to be able to directly make them.

If installed with the ConfirmEdit extension, captchas can be used to stop flood requests.

The new user log extension also works with ConfirmAccount.

Contents

[edit] Setup

  • Download the extension from SVN to subdirectory ConfirmAccount/ of extensions-directory
  • Run the SQL query, substituting in your wiki's table prefix. ConfirmAccount.pg.sql is for PostgreSQL, and ConfirmAccount.sql is for MySQL. That is, find whichever of those two files, and send a query that creates the account_credentials and account_requests tables, with /*$wgDBprefix*/ replaced according to whatever is appropriate.
  • Add the include_once('extensions/ConfirmAccount/SpecialConfirmAccount.php'); line to LocalSettings.php.
  • Make sure that $wgEnableEmail is true in localsettings and you have a working email system.
  • Make sure '../extensions/ConfirmAccount' is readable (for CSS)

[edit] Configuration

Several variable definitions can be added to localsettings.php:

  • $wgMakeUserPageFromBio - Replace a new user's new page with their biography if set to true. Some options below may append to their new page. These options have no affect if this is set to false. [Type: boolean].
  • $wgAutoWelcomeNewUsers - Replace the new user's talk page with a welcome message if set to true. Configurable at MediaWiki:Confirmaccount-welc. [Type: boolean].
  • $wgUseRealNamesOnly - If set to true requires users (usernames) to use their real name. [Type: boolean].
  • $wgRejectedAccountMaxAge - How long, in seconds, rejected requests are kept before being discarded. [Type: positive integer]
  • $wgConfirmAccountRejectAge - How long, in seconds, until inactive requests become rejected. [Type: positive integer].
  • $wgAccountRequestThrottle - Count of how many requests can come from an IP address per day. This only matters if throttling is true. [Type: positive integer].
  • $wgAccountRequestMinWords - Minimum word count in user biography. [Type: positive integer].
  • $wgAccountRequestToS - If set to true show the Terms of Service checkbox on the request form and require it to be checked to submit the form. [Type: boolean].
  • $wgAccountRequestExtraInfo - If set to true show the extra confirmation fields such as resume, contacts, urls, and CV. [Type: boolean].
  • $wgAllowAccountRequestFiles - Allows users to attach a file to their request if set to true. [Type: boolean].
    • Note Note: This has no effect if $wgAccountRequestExtraInfo is set to false.
  • $wgAccountRequestExts - Array of strings containing the file types that a user is allowed to upload. [Type: array(string)].
    • Note Note: This has no effect unless $wgAllowAccountRequestFiles is set to true;
  • $wgFileStore['accountreqs'] - A key/value map where the key is 'accountreqs' and the value is an associative array that contains the directory, url, and hash of the account request attachment storage location. The default value should work as long as MW is able to create folders with the correct permissions in the $wgUploadDirectory directory. [Type: array('accountreqs' => array('directory'=>string, 'url'=>string, 'hash'=>integer)) ].
  • $wgAutoUserBioText - If $wgMakeUserPageFromBio is set to true this text is appended to the end of each user's automatic user page text. [Type: string ].
  • $wgAccountRequestTypes - An array, with integer keys, of sub-arrays. These sub-arrays have values of the form (subpage param, user group, autotext). The subpage param (string) is used to separate the queues when browsing Special:ConfirmAccount. The user group (string) lets people approved to a certain position start off with a corresponding user group. (You can still grant any position to anyone, regardless of what they applied for, however.) The optional autotext value is added to the end of the user page of new accounts. The default is array( 0 => array('authors','user') ) where autotext is empty. [Type: array(integer => array(string,string,string)) ].
  • $wgConfirmAccountSaveInfo - If set to true the applicant's information is saved and accessible via Special:UserCredentials for users with the 'lookupcredentials' right. [Type: boolean ].
  • $wgFileStore['accountcreds'] - similar to $wgFileStore['accountreqs'] above but for permanent storage. [Type: array('accountcreds' => array('directory' => string, 'url' => string, 'hash'=>integer) ].
  • $wgConfirmAccountContact - If set non-empty send an email to this address whenever an account request has the email address confirmed. [Type: string ].

The default values are in SpecialConfirmAccount.php

Note Note: Sysops can still directly create accounts. To disable this, add: $wgGroupPermissions['*']['createaccount'] = false; to localsettings.php

Note Note: If only logged-in users are allowed to view pages, make sure you add the request account page to $wgWhitelistRead. For example: $wgWhitelistRead = array('Special:RequestAccount','Main Page');

In other languages you have to replace "Special" and "Main Page" with the words that are used instead of special in your language like "Spezial" and "Hauptseite" in a German wiki, otherwise nobody will be able to create an account.

To further categorize users based on their interests, you can set up MediaWiki:Requestaccount-areas. This should be in a format like:

*Topic|Topic wiki page|text to append to all interested users' bios |text to append to all interested users' bios in group0|text to append to all interested users' bios group1|text to append to all interested users' bios in group2|...

These group numbers are based on $wgAccountRequestTypes. So if 0 is the index for 'authors', then 'authors' interested in a topic will have the group0 text appended to their biography. This can be useful, say, if users can be approved as either authors or editors. Authors can have "category:X authors" where X is a topic, like "mathematics", and editors can have "category:x editors". You can have as many groups as you want, but you need at least one.

[edit] Use

Confirming account requests on Special:ConfirmAccounts (beta form)
Confirming account requests on Special:ConfirmAccounts (beta form)
  1. As a bureaucrat (or other user with the confirmaccount permission), browse to Special:ConfirmAccounts
  2. Click Review
  3. You will see the whole form with the users' data. Carefully review the form, and proceed to creating the account or rejecting the request.
  4. If you chose to create the account, the user's biography will become their userpage and the userpage will be automatically created with the default summary of Creating user page with biography of new user.

[edit] Issues

  • Do not set MediaWiki:Requestaccount-areas/xx where xx is a language code, the first part of each line is used as the keys to store in the DB for the items account requesters check.
  • Older versions of MediaWiki may not show the link to Special:RequestAccount at the user login form. You can edit MediaWiki:loginprompt to remedy this.
  • Name collisions: account creations will be checked and stopped if it collides with a pending name. Requests are checked for pending/account name collisions too.
  • AuthPlugin stuff: If a central login is used, when accounts are confirmed and made, we may get name collisions if each wiki of the farm lets you request accounts on it. Collisions are dealt with by picking a new name.
  • If your email client loses its mail data before sending it out, users will not get their passwords but may have an account. Since no one knows the passwords, you may want to use Extension:Password Reset to send them new ones.
  • If only a few people view the confirm accounts page, the randomly triggered pruning of old request will not trigger often, so old rejected requests may persist.

[edit] External link

Retrieved from "http://www.mediawiki.org/wiki/Extension:ConfirmAccount"
Personal tools