Jump to content

Extension:InviteSignup

From mediawiki.org
Revision as of 21:17, 30 April 2013 by Krenair (talk | contribs)
MediaWiki extensions manual
InviteSignup
Release status: stable
Implementation User identity , Special page
Description Allows to invite users to signup to a closed wiki
Author(s) Niklas Laxström (Nikerabbittalk)
Latest version 2012-12-26
MediaWiki >= 1.46.0
PHP 5.3+
Database changes No
Composer mediawiki/invite-signup
$wgInviteSignupHash
  • invitesignup
Licence GNU General Public License (any version)
Download
Translate the InviteSignup extension if it is available at translatewiki.net

The InviteSignup extensions allows account creation to be offered to a user on a closed wiki where it's restricted.

The extension adds a Special:InviteSignup special page, available to users with invitesignup permission.

  • The inviter, from this page, by entering just an e-mail address, can quickly invite a single person to create an account on the wiki.
  • The person can then set a username and password, confirming the creation of the account, which is logged; until then, no account is created.
  • The inviter can optionally set additional user groups to which the account will be added automatically after creation.

Download

The extension can be retrieved directly from Git [?]:

  • Browse code
  • Some extensions have tags for stable releases.
  • Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).

Extract the snapshot and place it in the extensions/InviteSignup/ directory of your MediaWiki installation.

If you are familiar with Git and have shell access to your server, you can also obtain the extension as follows:

cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/InviteSignup.git

Installation

  • Download and move the extracted InviteSignup folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/InviteSignup
    
  • Add the following code at the bottom of your LocalSettings.php file:
    require_once "$IP/extensions/InviteSignup/InviteSignup.php";
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

You will also have to create a new variable $wgISGroups containing an array of groups where the user can be setup: $wgISGroups = array( 'user' );

See also