GeezerVisonThe World Wide Web, restored to 800 pixels of glory. | ||||||||||||||||||
| Home|About|Gaming cabinet|Archives|How it works|Starter sites | ||||||||||||||||||
GeezerVison is showing www.mediawiki.org — Manual:FAQ - MediaWiki
For a complete list of support venues, see Communication .
The basicsWhat are the differences between MediaWiki, Wikimedia, Wikipedia, and wiki?Please see Differences between Wikipedia, Wikimedia, MediaWiki, and wiki for a detailed answer. I want to use a MediaWiki instance to (blank). Am I allowed to?MediaWiki is free software: this means that you may use it for any purpose without legal hindrance. Furthermore, its licensing conditions apply solely to the software itself. This means that although many wikis license their content under a permissive license, you are not obliged to license the content submitted to your wiki in any particular way. Of course, as a project founded to support sites like Wikipedia, we encourage you to license the texts you write under a free license, but, in short, you are not required to. If you wish to alter or amend the software itself, in general, you are permitted to, but there are some restrictions and you should consult the full text of the GNU GPL version 2 for details. Because MediaWiki is provided free of charge, there is no warranty, to the extent permitted by applicable law. How do I create a wiki?Creating a wiki implies installing MediaWiki on a server and having access to manage it. There are different options, depending on your level of expertise:
There is no mechanism provided by this site (MediaWiki.org) or the Wikimedia Foundation by which a wiki can be created on behalf of an individual or organization. Please use one of the methods listed above.
Installation and configurationWhere do I download MediaWiki?Download the latest stable release of MediaWiki. Files are supplied in a .tar.gz archive. MediaWiki can also be obtained directly from our Git repository. How to install MediaWiki?Installing MediaWiki takes around 10 to 30 minutes, and involves uploading/copying files, and running the installer script to configure the software. See Manual:Installation guide , where you will also find the minimum system requirements. How do I install MediaWiki using a package?Many Linux distributions provide MediaWiki in a packaged format for that distribution. The MediaWiki development team refers you to your Linux distribution for assistance with installing, configuring or using them. The individual communities and companies who maintain such packages should provide installation instructions. Be warned that third-party distributions may be older versions, so pay close attention to compatibility information for directions and extensions.
Can I install more than one wiki on a server using MediaWiki?It is possible to install more than one wiki on a server provided that:
Or
Or
For information on the latter two options, see $wgDBname and $wgDBprefix respectively. For more information on setting up a wiki family (wikifarm), see Manual:Wiki family . How do I install an existing wiki, like Wikipedia or Wiktionary?The main (but not necessarily the easiest) method is to import. See Wiki importing, below. (Non-MediaWiki methods, such as Xowa and Kiwix can be found at w:Wikipedia:Database download). Does MediaWiki require shell access?Shell access (SSH) is not required for installing MediaWiki, but it is highly recommended. Without shell access, it may even be difficult for you to get a backup of your wiki, or to upgrade to a new version. Some maintenance tasks are not possible at all without shell access. Many major extensions work best with shell access. How do I install extensions?See Manual:Extensions for information about installing and writing extensions. See Category:Extensions to find existing extensions. How do I add extra namespaces?See Creating a custom namespace. How do I enable uploading?File uploads are an often-used feature of MediaWiki, but are disabled by default in all current release versions.
To enable them, first make the upload directory (default
How do I allow uploading of additional formats?MediaWiki requires that allowed file upload formats are specified using the $wgFileExtensions configuration directive.
Usually this directive is situated in For example, to extend uploading to PDF files, add the following to $wgFileExtensions[] = 'pdf'; To extend uploading to more than one type of file, use the following syntax $wgFileExtensions = array_merge( $wgFileExtensions, [ 'pdf', 'txt', 'mp3' ] );
How do I enable embedded math formulas?MediaWiki allows embedded math formulas. See Extension:Math for complete setup instructions. How do I set the timezone for my MediaWiki?
How do I purge a cached page?To purge a cached page, such as when making changes to the navigation bar, add E.g. https://www.mediawiki.org/w/index.php?title=Main_Page&action=purge Or E.g. https://www.mediawiki.org/wiki/Main_Page?action=purge
How do I completely disable caching?Add in your
"File is corrupt or has an invalid extension"Some users have reported that after adding a file format to the allowed extensions list, an error is encountered. The text of the error is similar to the following:
As a possible solution, set the value of $wgMimeDetectorCommand . Under Unix or Linux, this would be $wgMimeDetectorCommand = "file --brief --mime";
Initial user was not created by installer or it is not an administratorSometimes, the installer fails to create the default user, or the maintenance/createAndPromote.php
This will create a new user and promote them to an administrator.
For help, run the script with the parameter Alter the database
Temporarily let everyone assign rights to promote your initial user
This method essentially involves letting all users temporarily modify user permissions in order to promote one user
How do I reset a user's MediaWiki password?How can I create interwiki links in my wiki?
How do I make my base URLs shorter?(i.e. /wiki/Article_Name as opposed to /w/index.php?title=Article_Name)
How do I organize pages into subdirectories like /wiki/subdir/PageName?Is downloading and using all of MediaWiki.org free?Yes, it is free in the sense of Free software. See Project:Copyrights for licensing issues regarding the written content of this site.
How do I administrate/manage user rights?See Manual:User rights for general information. See Manual:Preventing access for methods and strategies for restricting access. How do I stop anonymous users from editing any page?The recommended method is by changing the value of the $wgGroupPermissions['*']['edit'] = false; If you use Extension:AbuseFilter , any admin can also disable IP editing temporarily as needed.
How do I stop anonymous users from reading any page?
$wgGroupPermissions['*']['read'] = false; See also Manual:$wgWhitelistRead . See Manual:Preventing access#Restrict viewing of all pages for more information.
How do I restrict account creation?
$wgGroupPermissions['*']['createaccount'] = false; See Manual:Preventing access#Restrict account creation for more information. How do I require an email address be specified at registration?How do I put MediaWiki into Read Only mode?
How do I change default user preferences?
The MediaWiki default user preferences are in MainConfigSchema.php Don't edit that file, just use it for reference. Say if you want to hide minor edits in recent changes by default. MainConfigSchema.php says: public const DefaultUserOptions = [ ... 'hideminor' => 0, ... ] To change the preference, put this in your $wgDefaultUserOptions["hideminor"] = 1; To change the default namespaces to be searched, in any version of MediaWiki, set $wgNamespacesToBeSearchedDefault in LocalSettings.php to an array mapping namespace indexes to boolean values. For example, to search the main namespace and the category namespace, use: $wgNamespacesToBeSearchedDefault = [ NS_MAIN => true, NS_CATEGORY => true, ]; In some cases, after you change a default user preference, you may also want to change the user preferences of all existing user accounts. If so, use the userOptions.php script in the php userOptions.php --dry --nowarn hideminor --old 0 --new 1 Also, always backup your database before making these kinds of changes (you do not need to if you are just using --dry).
How can I make MediaWiki run faster?How do MediaWiki and GDPR go together?Upgrading
MovingIs it possible to move my wiki to a different machine?Yes. It should be. In essence, you will be backing up your old installation and then "restoring" it onto the new machine. Finally, you will have to make additional modifications to update the wiki configuration so that everything points to the new location. How do I move my wiki to a different server?Follow the instructions at Manual:Moving a wiki . Changing the interfaceHow do I change the logo?
See Manual:$wgLogos for the current recommendations on the sizes and filetypes that are acceptable for site logos.
The logo that appears in the top left of each page is determined by the $wgLogos configuration line in the LocalSettings.php file. (MediaWiki installations prior to MediaWiki 1.35.0 used $wgLogo .) There are two ways to change the logo:
Then, modify the $wgLogos = [ '1x' => "{$wgUploadPath}/6/62/myRasterLogo.png", 'icon' => "{$wgScriptPath}/myVectorLogo.svg", ]; Replace the paths above as appropriate, depending on where you actually uploaded the images. If you only want to change the logo on specific pages, override How do I edit the wiki's CSS?You shouldn't edit the CSS files (such as common.css) directly, because it will make upgrading harder if you need to apply your customizations each time you upgrade the software. Instead you need to edit a wiki page called MediaWiki:Common.css if you want to apply your CSS changes for all skins, or a wiki page called MediaWiki:Vector.css if you want to apply the customizations only for the Vector skin. The content of the MediaWiki:Common.css and MediaWiki:Vector.css pages always overrides the default CSS styles specified in the skin files. How do I hide the left vertical navigation toolbar?In other words, how do you make the main content div take up 100% of the display, hiding the logo, toolbox, navigation and search engine? To hide it permanently, copy and paste the following into the MediaWiki:Common.css page: #column-content { margin: 0 0 .6em 0; } #content { margin: 2.8em 0 0 0; } #p-logo, .generated-sidebar, #p-lang, #p-tb, #p-search { display:none; } #p-cactions { left: .1em; } To instead hide the toolbar when the user presses F11, enter this in your wiki's MediaWiki:Common.js: document.onkeydown = function( e ) { if( e == null ) e = event if( testKey( e, 122 ) ) { //F11 appendCSS('#column-content {margin: 0 0 .6em 0;} #content {margin: 2.8em 0 0 0;} #p-logo, .generated-sidebar, #p-lang, #p-tb, #p-search {display:none;} #p-cactions {left: .1em;} #footer {display:none;}'); return false; } } function testKey( e, intKeyCode ) { if( window.createPopup ) return e.keyCode == intKeyCode else return e.which == intKeyCode }
How do I hide the categories at the bottom of each page?You can hide display of the categories on each page by modifying your MediaWiki:Common.css and adding: .catlinks { display: none; }
How do I customize the link-URL of the site-logo in the top left corner of all pages that activates when the site-logo is clicked upon?By default, clicking the site-logo takes you to the main site-page. If you want to change which internal site-page is the "main" site-page, edit MediaWiki:Mainpage. To make the link of the site-logo link externally to any other arbitrary URL, you can use jQuery code within MediaWiki:Common.js: $("a.mw-wiki-logo").attr("href", "http://www.example.com"); $("a.mw-wiki-logo").attr("title", "Go to example.com website"); How do I change the icon in the browser's address line (favicon)?
See Manual:$wgFavicon for more details. Tip: The favicon image should be either 16 x 16 pixels or 32 x 32 pixels. Rewrite RuleIf you are using a rewrite rule in .htaccess to remove "index.php" from the URL, you will also need to add an exception for .ico files. Simply add the following rule to your .htaccess: RewriteRule .*\.ico$ - [L] This rule must appear before the index.php rule. Case sensitivityWhen uploading the favicon file, be sure the filename is in lowercase. (That is, "favicon.ico", not "Favicon.ico".) A lot of servers (e.g., those on UNIX-like operating systems) will not be able to find the file unless its name is in lowercase. How do I customize the navigation bar?The contents of the navigation bar which appears to the left of each page using the Vector or the Monobook skin are determined by the MediaWiki:Sidebar page there on your wiki. For information on customising these, please see Manual:Interface/Sidebar . How do I put a text message (sitenotice) on every page?Put a text in the MediaWiki:Sitenotice page. It will be displayed on top of every article page. You can also add text to MediaWiki:Anonnotice to create a message that only displays for logged-out users. It is often a good idea to transclude the site notice on the anon notice to make sure that logged-out users still get the information on the site notice. How do I change which page is the main page?By default, MediaWiki looks for a page with the title Main Page and serves this as the default page. This can be changed by altering the contents of MediaWiki:Mainpage to point to a different title. If this does not change the 'Main Page' link included on the sidebar at install time, edit MediaWiki:Sidebar . How do I change the Main Page title?Simply click on the "Move" tab, and move the page to the desired page title. Usually you also want to change which page is the configured as "main page". How do I hide the main page title?The displayed title of the main page can be changed using the MediaWiki messages MediaWiki:mainpage-title and MediaWiki:mainpage-title-loggedin (for logged-out and logged-in users respectively). The main page title can be hidden by setting both messages to empty (or only either of them if the title should still be displayed to logged-out or logged-in users). How can I hide the table of contents?The table of contents (TOC) is automatically shown once there are four or more headings in the article. There are multiple ways to hide it.
How do I change the interface text?Interface text is altered using the MediaWiki namespace. For each deviation from the default in the site language there is a page MediaWiki:Englishmessagename, and for each deviation from the default in each other language a page MediaWiki:Englishmessagename/languagecode. (Since release 1.9 there are no pages for messages equal to the default.). On creation of a page the edit box autofills with the default. When creating a page to override the default it is useful to first save the default version, to allow diffs with it. See also Help:System message .
How do I edit error messages?Special:Allmessages contains a complete list of messages (error or otherwise), that can be edited. You may also add ?uselang=qqx or &uselang=qqx to a URL which will display the name of each messages in the interface. How do I change the interface language?To change the default interface language, alter the value of $wgLanguageCode = "fr"; You may also need to bypass your browser's cache to see the changes. The new default interface language will be applied to all users who haven't ever customised it. If you want to provide users the possibility to create and choose pages and interface elements in languages other than the default one of the wiki, you need the Translate extension, which can make your wiki multilingual. If you want to change the language settings for all existing users, use the userOptions.php maintenance script. For instance, to have all users with English set use French instead, run: php userOptions.php language --old en --new fr
How do I remove the article/edit etc tabs?For a little more control see: User:Subfader/Hide_page_tabs Edit MediaWiki:Common.css on your wiki, and add this: li#ca-edit { display: none; } See the page source for the various #ca-* ids used in the content tabs. This will only work for Monobook and derived skins such as Modern and Vector (the default skin), and doesn't actually stop people from editing. To do that, see Manual:User rights .
How do I add/remove tabs throughout my wiki?See Manual:User group CSS and JavaScript How do I remove a tab on only one page?
For example, to remove the Discussion (talk) page tab from the Main Page, on the MediaWiki:Common.css page add: body.page-Main_Page li#ca-talk { display: none !important; } To modify MediaWiki:Common.css you must be an Interface administrator .
How do I remove a tab on all pages
For example, to remove the Discussion (talk) page tab on all wikipages, on the MediaWiki:Common.css page add: #ca-talk { display:none!important; } Other tabs to remove are #ca-history, #ca-viewsource, #ca-view (Read tab), #ca-nstab-main (Page tab). Other drop down menu items you can remove are #ca-watch, #ca-move, #ca-delete. To modify MediaWiki:Common.css you must be an Interface administrator . How do I remove the 'Talk for this IP' link at the top right (e.g. when $wgDisableAnonTalk is true)?One option is to hide the link using the following CSS in the wiki page MediaWiki:Common.css in your wiki: #p-personal #pt-anonuserpage { display: none; } How do I remove the "Create an Account or Login" link at the top right of the screen?To remove the login / create account links from the personal_urls you can use this code in your LocalSettings.php to hook in and remove them: $wgHooks['SkinTemplateNavigation::Universal'][] = function ( $skinTemplate, &$links ) { unset( $links['user-menu']['login'] ); unset( $links['user-menu']['login-private'] ); unset( $links['user-menu']['createaccount'] ); }; How can I suppress actions and special pages?To disable a specific special page (such as Special:SpecialPages), you may use: $wgSpecialPages['Name'] = DisabledSpecialPage::getCallback( 'Name', 'message' ); where To disable an action (such as edit), you may use: $wgActions['edit'] = false; See API:Restricting API usage to disable an API module. This is only the basic usages. Usually you may want to disable special pages, actions or API modules conditionally. How do I change the footer?
How can I edit / remove the Powered by MediaWiki image (and possible other images) from the footer?You can hide the Powered by MediaWiki image by adding the following to your wiki's MediaWiki:Common.css: #footer-poweredbyico { display: none; } If you want to remove it completely, you can use unset( $wgFooterIcons['poweredby'] ); Note that this will also remove other powered-by icons, e.g. also the one coming from BlueSpice. If you wish to change the icon images, urls, alt text, or add new icons please see How do I add a reply link to default signature tildes (~~~~) template?Install DiscussionTools to enable automatic reply links on talk pages. How can I change what the |
| Some HTML tags can be unsafe and may be misused to harm users or create security vulnerabilities. Only allow them if you are certain they are safe. |
See HTML restriction for ways to make this safer.
The basic steps to improving MediaWiki (that is, becoming a MediaWiki developer) are:
You might want to use the Pywikibot framework.
Set $wgNoFollowLinks = false; in LocalSettings.php
The OutputPage class includes an addMeta method which can be used to add meta tags. The RequestContext can be used to get the relevant OutputPage object.
$out->addMeta ( 'description', 'This is a meta description.' );
The Help namespace currently ships in a blank state. It's up to you how much or how little help you give to your site visitors and whether this relates to other aspects of your site. Obviously you can easily link your visitors to help resources elsewhere.
We don't currently have a clean, internationalised set of help pages under a free license. However, if you want to copy in some help information onto your site, about how to use a wiki (a MediaWiki powered wiki) you are free to copy the Help:Contents from this wiki. This set of pages have been deliberately created for this purpose, with wiki-neutral information, and no license restrictions. See Project:PD help .
Several users have reported that, following an upgrade or a moving of their wiki, several images fail to be shown inline.
The files exist, and the image description pages show a MIME type of unknowncode>/unknown and, in some cases, a warning about potentially dangerous files.
To fix this, run the maintenance/rebuildImages.php script from the command line.
This will set MIME information for each file in the database.
MediaWiki 1.21 and newer implements responsive images.
Due to a bug, if the server locale is set to one that uses commas instead of dots for representing a decimal point, images may not render on some browsers/devices.
This can be confirmed by inspecting a thumbnail of a medium or big image on a page with the browser tools, looking at the HTML code, and see if the srcset attribute contains commas instead of dots when representing the 1.5x value.
After upgrading to a more recent version of PHP, it is possible a different MimeMagic.php function is being used to detect file MIME types, particularly the built-in PHP function mime_content_type, which fails to detect PNG files. Search the web for mime_content_type png for information on fixing this bug at the PHP level, possibly by editing your magic.mime file.
See File is corrupt or has an invalid extension for more info.
MediaWiki 1.47 is in a development state at present, and has not been packaged into a general release. The code can be downloaded from Git if desired. Or, if you want the latest development version packaged as an archive, get it at mediawiki-master.tar.gz (GitHub).
Wikipedia and other Wikimedia web sites use the current version of the code in development; at present, this is MediaWiki 1.48.0-wmf.4 (0486582), pulled from the current development branch. Coupled with the use of several extensions, this means that functionality between these wikis and your particular setup may differ.
Fedora enables SELinux by default. Instructions for setting SELinux permissions for MediaWiki are available.
Many hosting providers only handle zip archives, and we only provide gz compressed tar archives, thus the archives has to be recompressed before uploading. This should not be a hurdle, but it seems like some archive tools occasionally fail to include all files in large archives. When this happen the vendor folder is left out, leaving the user with the rather non-explanatory error message.
Use a command line tool when recompressing the tar archive into a zip archive.
This is probably related to cookies or session data. See Log in problems for information.
If this is happening constantly to all users, it probably means that caching is misconfigured. Setting $wgSessionCacheType = CACHE_DB; can be used to determine if caching is the cause of the problem. If that solves the problem, you should still investigate what is wrong with your caching configuration.
Parts of this page (those related to Manual edits to rev_user fields in the database; MediaWiki uses the actor table now) are outdated. It was written for an older version of MediaWiki and may not apply to the most recent version. If you have checked or updated this page and found the content to be suitable, please remove this notice. See the talk page for a possible discussion on this. |
At many times you just want to remove a user account out of the wiki either because it belonged to a spammer account or you just feel like it. The appropriate choice is to block the account or rename it if needed. Here is why:
Do I just remove this row from the user table?
Rob Church posted the following regarding this issue on the wikitech-l mailing list:
If the user has made edits, then removing rows from theusertable cause theoretical loss of referential integrity.Now, to be honest with you, I can't think of any conditions where this would cause an actual problem; "undefined behaviour" is the phrase we use.
What I'd suggest doing, to be on the safe side, is running a couple of quick updates against the database:
UPDATE revision SET rev_user = 0 WHERE rev_user = <current_user_id> UPDATE archive SET ar_user = 0 WHERE ar_user = <current_user_id>What this will do is cause MediaWiki to treat the revisions as having been made anonymously when generating things like page histories, which should eliminate any problems caused by these routines attempting to check user details from other tables.
If the user has caused log entries, i.e. rows in the
If the username is offensive or undesirable, then you could consider renaming it .loggingtable, or uploaded images, then the situation becomes trickier, as you'll have to start mopping up all the rows everywhere and it could become a bit of a mess, so if the user's done anything other than edit, I would strongly recommend just blocking them indefinitely.
Another option is to give Admins the 'hideuser' right, and indefinitely block the user with the Hide username from edits and lists option selected.
Extension:UserMerge is also useful.
By default, $wgArticleCountMethod is set to link.
This means the number of "Content pages" on the Special:Statistics page only counts pages which include at least one internal link.
This can be changed by setting $wgArticleCountMethod to any.
Afterwards, run updateArticleCount.php and/or initSiteStats.php .
(On Wikimedia websites, initSiteStats.php is run on the 1st and 15th of each month.)
There might still be wrong behavior, see for example phab:T212706.
$wgSpamRegex is a powerful filter for page content. Adding multiple items to the regex, however, can be awkward. Consider this snippet:
$wgSpamRegexLines[] = 'display\s*:\s*none'; $wgSpamRegexLines[] = 'overflow\s*:\s*auto'; [...] $wgSpamRegex = '/(' . implode( '|', $wgSpamRegexLines ) . ')/i';
This example code allows convenient addition of additional items to the regex without fiddling about each time. It also demonstrates two popular filters, which block some of the most common spam attacks.
See Manual:Combating spam for an overview of anti-spam measures such as Captcha, content filtering and restricting edition.
See Manual:Combating vandalism for hints and suggestions on how to deal with wiki vandalism.
Bugs and feature requests should be posted on Phabricator . See How to report a bug.
Nine times out of ten this is because you didn't clear your cache. The simple test for this is to request a page that hasn't been requested before. Select the part of the URL in the address bar that contains the page title (e.g. Main_Page). Twiddle your fingers on the keyboard for a while, hit enter. Check if the problem is on that page too.
MediaWiki uses both a server-side cache and a client-side cache, so clearing your browser cache is often not enough. See the relevant entry above for more details.
Here are some other things to check:
<?php phpinfo() ?>. Upload it into your web directory and invoke it with your browser. Check the document root and the path to php.ini.LocalSettings.php, not to the beginning.If you've exhausted the FAQ above, please try the following:
See the support venues listed on Communication .