Manual:MediaWiki: Toegang beperken

<languages />

For help customizing user rights, see <tvar|1>Manual:User rights</>.
This page contains examples useful for restricting access.

Most of the examples need changes to MediaWiki configuration file <tvar|1>Manual:LocalSettings.php</>.
Snippets of code with no accompanying instructions must be added to <tvar|1>LocalSettings.php</> to take effect.
To add one or more lines to the file, follow these steps:

1. If there is a <tvar|1>?></> at the end of the file, remove it. It's unnecessary and may cause problems in certain situations.

1. Add the line to the end of the file, using a text editor. It doesn't matter if there are some blank lines above or below the addition. Do not use Windows Notepad, which may add a "Byte Order Mark" (BOM) and prevent the file from being read correctly. Typical symptoms of BOMs include white pages and errors about headers already being sent. To remove a BOM, you'll have to edit the file in a hex editor. Windows WordPad seems to work fine, as does Notepad++. Removal of BOMs can also be accomplished using the Vim text editor by opening the file in Vim, typing :set nobomb, and resaving the file. If you're using a Mac, TextEdit will also do the job.

For more detailed information on editing <tvar|1>LocalSettings.php</>, read <tvar|2>Manual:LocalSettings.php</>.

Simple private wiki

For the common use case of "a private wiki, for oneself and approved others", you need to:

• Restrict viewing
• Restrict editing
• Restrict account creation

<syntaxhighlight lang="php">

1. Disable reading by anonymous users

$wgGroupPermissions['*']['read'] = false;

1. Disable anonymous editing

$wgGroupPermissions['*']['edit'] = false;

1. Prevent new user registrations except by sysops

$wgGroupPermissions['*']['createaccount'] = false; </syntaxhighlight>

Depending on what extensions you have installed, you may want to whitelist more pages.
For example if you are using the <tvar|1>Extension:ConfirmAccount</> extension, you probably want Special:RequestAccount whitelisted.
If the content language of your wiki is not English, you may have to use the translated name of the special pages in question.

Restrict account creation

To restrict account creation, you need to edit <tvar|1>LocalSettings.php</> in the root path of your MediaWiki installation.

<syntaxhighlight lang="php">

1. Prevent new user registrations except by sysops

$wgGroupPermissions['*']['createaccount'] = false; </syntaxhighlight>

^{1>Extension:ConfirmAccount</> extension if you want to set up an account confirmation queue. ( If not you may still proceed as follows.)}

^{New users will still be able to be created by sysops, in the following manner:}

1. Go to <tvar|1>Template:Blue</>, when logged in as a sysop.

1. Click on "Create an account" link to get to the account creation form.

1. Enter a username and an email address, and click the "by email" button. Note you need <tvar|1>Manual:$wgEnableEmail</> or else the sysop must pick a password and send it to the user.

1. The account will be created with a random password which is then emailed to the given address (as with the "forgot password" feature). The user will be requested to change password at first login; when they do this, the email address will also be marked as confirmed.

   When you click the "create account" button instead, you have to manually send the user their password. If you've set <tvar|1>Manual:$wgMinimalPasswordLength</> (default configuration up to version 1.15) and you've left the password field blank, the user will be emailed an email address confirmation request but will be unable to access <tvar|2>Manual:Interface/Special pages summary</> to perform the confirmation. Instead, the user will get an error (unless you've added it to <tvar|1>Manual:$wgWhitelistRead</>); the user will be able to login with a blank password and then confirm email, but their password will not have been reset (it will have to be reset manually).

It may be appropriate to edit the text displayed when a non-user attempts to log in.
This can be done at <tvar|1>MediaWiki:Nosuchuser</>, when logged in as a sysop.
Use plain text without any special formatting, as the formatting is ignored and the text is literally rendered.
(Might have changed, see <tvar|1>bug 12952</>).

You may also modify the contents of the email sent to new users by editing the page <tvar|1>MediaWiki:Createaccount-text</>.

To prevent even sysops from creating accounts:

<syntaxhighlight lang="php">

1. Prevent new user registrations by anyone

$wgGroupPermissions['*']['createaccount'] = false; $wgGroupPermissions['sysop']['createaccount'] = false; </syntaxhighlight>

To add a message on top of the login form, modify <tvar|1>MediaWiki:Loginprompt</>.

Restrict editing

Restrict editing of all pages

Users will still be able to read pages with these modifications, and they can view the source by using [[<tvar|1>Special:Export</>/Article name]] or other methods.
See also <tvar|1>bug 1859</>.

See <tvar|1>Help:User rights</> and <tvar|2>Manual:$wgGroupPermissions</>.
If you use <tvar|1>Extension:AbuseFilter</>, any wiki admin can also put various restrictions in place.

Some examples of how to protect all pages from editing (not reading) by certain classes of users:

Restrict anonymous editing

Requires that a user be registered before they can edit.

<syntaxhighlight lang="php"> $wgGroupPermissions['*']['edit'] = false; </syntaxhighlight>

Restrict editing by all non-sysop users

Requires that a user be a member of the administrators (sysop) usergroup.

<syntaxhighlight lang="php"> $wgGroupPermissions['*']['edit'] = false; $wgGroupPermissions['user']['edit'] = false; $wgGroupPermissions['sysop']['edit'] = true; </syntaxhighlight>

Restrict editing by absolutely everyone

<syntaxhighlight lang="php"> $wgGroupPermissions['*']['edit'] = false; $wgGroupPermissions['user']['edit'] = false; $wgGroupPermissions['sysop']['edit'] = false; </syntaxhighlight>

Restrict editing of an entire namespace

Starting from MediaWiki version 1.10, it is possible to protect entire namespaces using the <tvar|1>Manual:$wgNamespaceProtection</> variable.
Examples:

<syntaxhighlight lang="php">

1. Only allow autoconfirmed users to edit Project namespace

$wgNamespaceProtection[NS_PROJECT] = array( 'autoconfirmed' );

1. Don't allow anyone to edit non-talk pages until they've confirmed their
2. email address (assuming we have no custom namespaces and allow edits
3. from non-emailconfirmed users to start with)
4. Note for 1.13: emailconfirmed group and right were removed from default
5. setup, if you want to use it, you'll have to re-enable it manually

$wgNamespaceProtection[NS_MAIN] = $wgNamespaceProtection[NS_USER] = $wgNamespaceProtection[NS_PROJECT] = $wgNamespaceProtection[NS_IMAGE] = $wgNamespaceProtection[NS_TEMPLATE] = $wgNamespaceProtection[NS_HELP] = $wgNamespaceProtection[NS_CATEGORY] = array( 'emailconfirmed' );

1. Only allow sysops to edit "Policy" namespace

$wgGroupPermissions['sysop']['editpolicy'] = true; $wgNamespaceProtection[NS_POLICY] = array( 'editpolicy' ); </syntaxhighlight>

Note that in the last case it's assumed that a custom namespace exists and that NS_POLICY is a defined constant equal to the namespace number. See Manual:Using custom namespaces and Manual:Namespace_constants for a list of MediaWiki's core namespaces.

Restrict editing of certain specific pages

Use the {{<tvar|1>ll|Manual:Administrators#Protection</>|Protect}} feature.
By default, any sysop can protect pages so only other sysops can edit them.
In 1.9 and higher, by default they can also protect pages so only "autoconfirmed" users (with accounts older than a configured period) can edit them.
This does not require editing configuration files.

If you want to restrict editing to groups with specific permissions, edit <tvar|1>Manual:$wgRestrictionLevels</>.
To prevent actions other than edit and move, use <tvar|1>Manual:$wgRestrictionTypes</>.

Restrict editing of all but a few pages

To impose a blanket restriction on editing for all pages, but allow a few (such as sandboxes, join request pages, etc.) to be more generously editable, you can use the <tvar|1>Extension:EditSubpages</> extension.
This may not fit too often, but you could also use the [[<tvar|1>#Restrict editing of certain specific pages</>|Restrict editing of certain specific pages]] method mentioned above, with all name spaces protected, and only a special one editable by everyone which has all the pages you want editable.

Restrict editing for certain IP address ranges

Schools and other institutions may want to block all edits not from a few specified IP address ranges.
To do so, see <tvar|1>Manual:Block and unblock</>.
The only way to do this at present  without modifying the code is to go to <tvar|1>Special:Blockip</> and systematically {{<tvar|2>ll|Help:Range blocks</>|rangeblock}} every one of the address ranges that you don't want to be able to edit.
This will work for all future versions of MediaWiki.
It will not work on a per-namespace basis.

Restrict editing by a particular user

Use the user {{<tvar|1>ll|Manual:Block and unblock</>|blocking}} functionality to deprive a user of all edit access.
MediaWiki does not include a possibility to give rights to separate users directly; instead rights are always given to a user group.
There is no way in the core software to change permissions of particular users in order to restrict or allow editing particular pages, except by changing their usergroup.

Restrict creating of all pages

^{Revoking the edit right already prevents affected users from creating new pages and talk pages.}

<syntaxhighlight lang="php">

1. Anonymous users can't create pages

$wgGroupPermissions['*']['createpage'] = false;

1. Only users with accounts four days old or older can create pages
2. Requires MW 1.6 or higher.

$wgGroupPermissions['*' ]['createpage'] = false; $wgGroupPermissions['user' ]['createpage'] = false; $wgGroupPermissions['autoconfirmed']['createpage'] = true; </syntaxhighlight>

Restrict creating pages in certain namespaces

There are separate rights for creating talk pages (<tvar|1>createtalk</>) and creating non-talk pages (<tvar|2>createpage</>).
If you need per-namespace control finer than that, it is not possible in core MediaWiki, and requires an extension such as <tvar|1>Extension:Lockdown</>.

Restrict access to uploaded files

→ Manual:Image authorization, Manual:img_auth.php, Manual:User rights#List of permissions

If you have enabled the ability to upload files, these will be served directly by the underlying web server.
As a result, {{<tvar|1>red</>|account-based access to the file is unrestricted by default}}.

Example for access restriction to uploaded files in the server configuration

If sensitive files are uploaded to an internet-accessible wiki, you may wish to add restrictions on where these can be accessed from.
On Apache, if your local network were 10.1.2.*, you could restrict serving files to local addresses with:

  <Location /mediawiki/images>
    Order deny,allow
    Allow from 10.1.2.3
    Deny from all
  </Location>

Restrict viewing

Restrict viewing of all pages

^{If anonymous users can't view your page, neither can search engines. Your site will not be indexed on Google.}

Add this line to your LocalSettings.php file:

<syntaxhighlight lang="php">

1. Disable reading by anonymous users

$wgGroupPermissions['*']['read'] = false;

1. But allow them to read e.g., these pages:

$wgWhitelistRead = [ "Main Page", "Help:Contents" ];

1. Allow Jobs to be run

$wgWhitelistRead = [ "Special:RunJobs" ]; </syntaxhighlight>

The <tvar|1>Manual:$wgWhitelistRead</> setting allows users to view the main page.
If page names have more than one word, use a space "<tvar|1> </>" between them, not an underscore "<tvar|2>_</>".

In addition to the main page of such a private site, you could give access to the Recentchanges page (if you think that its content isn't private) for feed readers by adding "Special:Recentchanges" to <tvar|1>Manual:$wgWhitelistRead</>.

If you need to protect even the sidebar, main page, or login screen for any reason, it's recommended that you use higher-level authentication such as <tvar|1>.htpasswd</> or equivalent.

^{1>Special:Listusers</> won't be available, it can be determined if a username is correct from Userlogin errors. You may want to give a common text for <tvar}

Restrict viewing of certain specific pages

To prevent anyone but sysops from viewing a page, it can simply be {{<tvar|1>ll|Help:Deletion and undeletion</>|deleted}}.
To prevent even sysops from viewing it, it can be removed more permanently using <tvar|1>Manual:RevisionDelete</>.
To completely destroy the text of the page, it can be manually removed from the database.
In any case, the page cannot be edited while in this state, and for most purposes no longer exists.

To have a page act normally for some users but be invisible to others, as is possible for instance in most forum software, is a very different matter.
MediaWiki is designed for two basic access modes:

1. Everyone can view every single page on the wiki (with the possible exception of a few special pages). This is the mode used by Wikipedia and its sister projects.

1. Anonymous users can only view the Main Page and login page, and cannot edit any page. This is basically the same as the above, in terms of technical implementation (just an extra check for every page view), which is why it exists. This is the mode of operation used by certain private wikis such as those used by various Wikimedia committees.

If you intend to have different view permissions than that, MediaWiki is not designed for your usage. ( See <tvar|1>T3924</>.)

Data is not necessarily clearly delineated by namespace, page name, or other criteria, and there are a lot of leaks you'll have to plug if you want to make it so (see <tvar|1>security issues with authorization extensions</> for a sample).
Other wiki software may be more suitable for your purpose.
You have been warned.
If you must use MediaWiki, there are three basic possibilities:

1. Set your wiki up private and whitelist specific pages that will be public with <tvar|1>Manual:$wgWhitelistRead</> in the <tvar|2>LocalSetting.php</> file. See the section above.

1. Set up separate wikis with a {{<tvar|1>ll|Manual:$wgSharedDB</>|shared user database}}, configure one as viewable and one as unviewable ([[<tvar|2>#Disable anonymous reading</>|see above]]), and {{<tvar|3>ll|Help:Interwiki linking</>|make interwiki links}} between them.

1. Install a third-party hack or extension. You will have to reapply it every time you upgrade the software, and it may not be updated immediately when new security fixes or upgrades of MediaWiki are released. Third-party hacks are, of course, not supported by MediaWiki developers, and if you're having problems you shouldn't ask on <tvar|1>MediaWiki-l</>, <tvar|2>#mediawiki</>, or other official support channels. A number of hacks are listed in <tvar|1></>. Read about <tvar|1>security issues with authorization extensions</> if you plan to use one of those.

Restricting exporting

See also: Manual:Parameters_to_Special:Export

It is not possible to export the contents of a page that cannot be read since <tvar|1>Template:Rev</>.

Removing the Login link from all pages

One can remove the login/create account link from the upper right corner of all pages,
as users can still go to <tvar|1>Special:SpecialPages</>><tvar|2>Special:UserLogin</> to login.
In LocalSettings.php use (tested with MediaWiki 1.16)

<syntaxhighlight lang="php"> function NoLoginLinkOnMainPage( &$personal_urls ){

   unset( $personal_urls['login'] );
   unset( $personal_urls['anonlogin'] );
   return true;

} $wgHooks['PersonalUrls'][]='NoLoginLinkOnMainPage'; </syntaxhighlight>

Removing accounts

If you want to completely remove access to a user, e.g. on a [[<tvar|1>#Simple private wiki</>|simple private wiki]], it's not possible to simply delete the account ({{<tvar|2>ll|Manual:removeUnusedAccounts.php</>|unless no edits have been made}}); you can {{<tvar|3>ll|Manual:Block and unblock</>|block}} it, but the user will still {{<tvar|4>ll|Manual:Block_and_unblock#Effects_of_being_blocked</>|be able}} to read pages.
However, using <tvar|1>Extension:User Merge and Delete</> extension you can merge the account in another one and delete the former; the original account will then "disappear".
If you want to preserve history readability (i.e., to have edits from the user to be still shown under their name), you can create a new account e.g. with username "OriginalUserName (deactivated)" and then merge "OriginalUserName" into the former, or even use <tvar|1>Extension:Renameuser</> extension to rename "OriginalUserName" into "AnotherUserName", then create an account under "OriginalUserName" and merge "AnotherUserName" into it: in this manner, "OriginalUserName" will be completely "usurped" (if you've set a non-null password).

Since MediaWiki 1.16.0, it is possible to set <tvar|1>Manual:$wgBlockDisablesLogin</> to true to prevent access and reading to blocked users.

Other restrictions

You may want to have pages editable only by their creator, or ban viewing of history, or any of a number of other things.
None of these features are available in an unhacked version of MediaWiki.
If you need more fine-grained permissions, see the [[<tvar|1>#See also</>|#See also]] section for links to other wiki packages that are designed for this, as well as hacks that attempt to contort MediaWiki into something it's not designed to be but may work anyway.

See also

There are some related manual/help pages that may be of interest:

• Manual:LocalSettings.php
• Manual:$wgGroupPermissions
• Manual:$wgRestrictionTypes
• Manual:$wgRestrictionLevels
• Manual:$wgNamespaceProtection
• Manual:$wgEmailConfirmToEdit
• Manual:$wgNonincludableNamespaces
• Manual:User rights
• Help:User rights and groups

Other wiki software may have better support for fine-grained access control than MediaWiki:

• MoinMoin
• TWiki
• TikiWiki - has fully configuable access control to features and permission levels.

If you want better access control but want to use MediaWiki, this is a list of extensions and hacks to allow restrictions not possible in the software proper.
These hacks may be out-of-date (check the version they're for).
Please don't ask in official MediaWiki support channels if something goes wrong with a third-party hack.

• Extension:FlaggedRevs
• Extension:Moderation
• Extension:Approved Revs
• Extension:Lockdown
• Extension:AuthorProtect
• Extension:ArticleProtection
• Extension:EditSubpages - restricts anonymous users from editing most pages
• Extension:NSFileRepo

[[Category:MediaWiki configuration{{#translation:}}]] [[Category:Configure{{#translation:}}]] [[Category:Permission{{#translation:}}]] [[Category:Namespace{{#translation:}}]]