Jump to content

Extension:PrivateDomains

From mediawiki.org
MediaWiki extensions manual
PrivateDomains
Release status: stable
Implementation Special page
Description Allows to restrict editing to users with a certain email address.
Author(s) Inez Korczyński
Jack Phoenix
Latest version 1.5.0
MediaWiki 1.39+
License GNU General Public License 2.0 or later
Download
  • privatedomains
Quarterly downloads 2 (Ranked 137th)
Translate the PrivateDomains extension if it is available at translatewiki.net

The PrivateDomains extension restricts wiki editing to users with a certain email address. It adds a new special page, Special:PrivateDomains, to allow changing the name of the organization and to add "trusted" email addresses. Bureaucrats and staff members can access this special page by default.

If a non-privileged user (someone who does not have the organization's email address) tries to edit, they see a warning box about the fact that they cannot change pages on the wiki. Be aware that the user can't view pages' wikitext source either.

Installation

  • Download and move the extracted PrivateDomains 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/PrivateDomains
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'PrivateDomains' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

While PrivateDomains settings are meant to be edited via Special:PrivateDomains, they are stored in the MediaWiki: namespace and thus they can also be directly edited.

  • MediaWiki:Privatedomains-domains — contains the list of allowed email domains
  • MediaWiki:Privatedomains-affiliatename — contains the name of the organization, i.e. FooCorp, Inc. or Bar State University
  • MediaWiki:Privatedomains-emailadmin — contains the name of a wiki user whom users can contact if they're having issues