Jump to content

Extension:InviteSignup

From mediawiki.org
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 1.0.0+2021-09-01
MediaWiki >= 1.39.0
Database changes Yes
Composer mediawiki/invite-signup
Tables invitesignup
License GNU General Public License 2.0 or later
Download
  • $wgInviteSignupHash
  • $wgISGroups
  • invitesignup
Quarterly downloads 11 (Ranked 118th)
Translate the InviteSignup extension if it is available at translatewiki.net
Issues Open tasks ¡ Report a bug

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 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:
    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 = [ 'translator', 'sysop' ];
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

See also

[edit]