Extension:InviteSignup: Difference between revisions

**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	2014-01-05 (2014-01-05)
MediaWiki	>= 1.46.0
PHP	5.3+
Database changes	Yes
Composer	mediawiki/invite-signup
	Parameters $wgInviteSignupHash; $wgISGroups;
	Added rights invitesignup
	Hooks used BeforeInitialize; UserGetRights; UserCreateForm; AddNewAccount; LoadExtensionSchemaUpdates;
Licence	GNU General Public License (any version)
Download	Download extension ; Git [?]: Browse repository (GitHub); Gerrit code review; Git commit log; Download source tarball;
	Translate the InviteSignup extension if it is available at translatewiki.net

Content deleted Content added

Inline

Revision as of 10:22, 25 February 2014

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.

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

Browse code
Some extensions have tags for stable releases.
- Browse tags
- Select the tag
- Click "snapshot"
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).
- Browse branches
- Select a branch name
- Click Continue

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:

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";
```
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' );

Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

@@ Line 43: / Line 43: @@
 $wgGroupPermissions['sysop']['invitesignup'] = true;
 </syntaxhighlight>
-* You should also set the variable <code>$wgISGroups</code>, which holds an array of the user groups to which the invited user will be added automatically. Most likely, this should simply be:
+* You can also set the variable <code>$wgISGroups</code> 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.
-<syntaxhighlight lang="php">$wgISGroups = array( 'user' );</syntaxhighlight>
+<syntaxhighlight lang="php">$wgISGroups = array( 'translator', 'sysop' );</syntaxhighlight>
 }}