Extension:InviteSignup

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
InviteSignup
Release status: stable
InviteSignup.png
Implementation User identity, Special page
Description Allows to invite users to signup to a closed wiki
Author(s) Niklas Laxström (Nikerabbittalk)
Latest version 2015-07-31
MediaWiki 1.27+
Database changes Yes
Composer mediawiki/invite-signup
License GNU General Public License 2.0 or later
Download
Parameters
  • $wgInviteSignupHash
  • $wgISGroups
Added rights
invitesignup
Hooks used
BeforeInitialize
UserGetRights
UserCreateForm
AddNewAccount
LoadExtensionSchemaUpdates
Translate the InviteSignup extension if it is available at translatewiki.net
Check usage and version matrix.

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.

Installation[edit]

  • Download and place the file(s) in a directory called InviteSignup in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'InviteSignup' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • You will need to give the invitesignup permission to at least one user group. To have administrators be able to do the inviting, for instance, add the following to LocalSettings.php:
$wgGroupPermissions['sysop']['invitesignup'] = true;
  • You can also set the variable $wgISGroups to an array of user groups. When inviting, you can mark to which groups the invited user will be added automatically. For example, with the following setting, you are able to invite 1) normal users 2) translators 3) sysops.
$wgISGroups = array( 'translator', 'sysop' );
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

See also[edit]