Manual:Short URL

According to World Wide Web inventor Tim Berners-Lee, good page addresses should never change. Short URLs which hide complex programming code from the page address are good for webpage visitors. Please take a few minutes to devise a stable URL structure for your website before getting started, to reduce problems later. This page has been divided into separate "how to" mini-guides listed below to make things easier.

Introduction

Defaults

MediaWiki's default installation path usually looks something like this:

/var/www/localhost/htdocs/mediawiki/w (installed as root user)

/home/johndoe/public_html/mediawiki/w (installed with a shared hosting provider)

MediaWiki's default page addresses looks like these examples:

http://example.com/w/index.php/Page_title (recent versions of MediaWiki, unless using CGI)

http://example.com/w/index.php?title=Page_title (recent versions of MediaWiki, using CGI)

Using the methods below, short webpage addresses can be changed to addresses such as these:

http://example.com/wiki/Page_title (this is the standard, same as in Wikipedia)

http://wiki.example.com/Page_title (not recommended!)

Advantages & disadvantages

Long URLs have a key advantage: they work in all hosting environments — a good thing to know lest one day you move your wiki to a hosting environment where you can't keep using the same URLs everyone has bookmarked or linked to.

The advantages of short URLs are that they hide all technical details, as is best practice for URLs – among other things this means they can be kept stable when the underlying mechanism change, if your hosting environment supports this. They are also easier for visitors to remember and allow visitors to navigate the site by URL more conveniently.

Once you've decided that you really want short URLs and are willing to go through the effort, you're ready for the long trial and error configuration as detailed below.

Shared hosting

Most shared hosting systems do not allow changes to httpd.conf. If you are using a shared host, first try asking your hosting provider who may well solve your problem for you. If that doesn't work out, depending on your hosting provider, you may be able to edit .htaccess (detailed below).

If you have a choice, you should edit httpd.conf (which requires root access and is the preferred method because your wiki will perform better). You only need to edit either .htaccess or httpd.conf, not both.

Recommended how-to guide (setup used on Wikipedia)

The following setup is used on Wikipedia, and tends to be robust and easy to set up. This setup should be used unless you really dislike some aspects of it (it doesn't rewrite all URLs) or you simply can't use it (it requires root access).

Advantages

• This method is reliable and guaranteed to work in all versions of MediaWiki for the indefinite future. Other schemes are not tested by MediaWiki developers and might break when changes are made to the software.
• Not all URLs are rewritten, but this is good. With a single simple rule, this allows you to easily block search engine spiders from viewing background pages (like the edit form or history pages), separate actual article views from other accesses in log analysis, et cetera. Although links to edit pages and background pages are slightly less memorable, this is no big deal: the important thing is the articles.
• The method uses Alias instead of Rewrite. This is simpler and more reliable.

Disadvantages

• This method requires Apache and root access.

Setup steps

First of all, ensure that you are using Apache and have root access (so you can modify httpd.conf; modifying .htaccess is not enough!). If either of these is false, you cannot use this exact method; you need to modify it appropriately, or use some other method listed below, preferably Manual:Short URL/wiki/Page title -- no root access.

1. Find the directory in which your wiki was installed. By default, this is a subdirectory called /w, within your web server's document root (web root). The web root is the directory where you put all the html files that your web server makes publicly available. For instance, if your web root is /var/www, then your wiki is probably in /var/www/w. Inside this directory you should see files like index.php and LocalSettings.php. This can all be a little confusing, because on some systems (e.g., Debian), the subdirectory /w may actually be a symbolic link (e.g., to /usr/share/mediawiki/).
2. Choose a virtual directory in which you want your articles to appear. This guide will assume that you choose /wiki/ (as Wikipedia does), articles will then be accessed like http://www.example.com/wiki/Article_title. Do not create this virtual directory and it should not exist in the web root folder!. This guide assumes that you have installed MediaWiki in /w/ folder relative to your web root as Wikipedia does, and not in /wiki/ folder.
   Note: In case you earlier chose /wiki/ as your folder for installing MediaWiki unknowingly, then rename the folder name to new name (here /w/) and replace /wiki/ with new path (here /w/) wherever you see it (one typically only needs to change LocalSettings.php file).
   Note: The install path must not be same as virtual directory and must not be the web root directory itself, the first point is important, do not try to ignore it to get prettier URLs, or else this method will not work.
3. In LocalSettings.php, modify with the following:

   $wgScriptPath = '/w';         # Path to the actual files.
   

   $wgArticlePath = '/wiki/$1';  # Virtual path. This directory MUST be different from the one used in $wgScriptPath
   

   $wgUsePathInfo = true;        # Enable use of pretty URLs
   

   Note that $wgScriptPath should already be set to /w. If it is not (for example, if you're moving from a different URL scheme), make sure to set it to that.
4. Edit httpd.conf to contain the rule Alias /wiki /path/to/your/wiki/index.php. Note that the second path is relative to the filesystem root, not the web root! This might be, for instance, Alias /wiki /var/www/w/index.php, if /var/www/ is your web root. If this does not work or you get a 403 error, use an absolute path that begins with the drive MediaWiki is installed on such as C:/absolute/path/to/your/wiki/index.php. This ALIAS configuration is a minimum configuration, see Apache configuration for further options. If you're using Apache 2, the configuration file is called apache2.conf. If you don't have a httpd.conf, then use this.
5. Make Apache reread its configuration file (gracefully restart). You might use, for instance, apachectl graceful or a similar command as root, or use features of WebHost Manager or similar software.If you're using Apache 2, the command is apache2ctl graceful.
6. In your web root, create a file called robots.txt if one does not already exist. Then add the following to the end of the file:

   User-agent: *
   

   Disallow: /w/
   

   Disallow: /wiki/Special:Search
   

   Disallow: /wiki/Special:Random
   

   The first "Disallow" rule stops spiders from indexing histories, edit pages, and other background pages that are useless to users performing a search. This will also prevent duplicate content from being indexed. The second and third rules stop spiders from indexing two special pages that might confuse them, and generally be unhelpful.
   Note: If you're using a localized version of MediaWiki (non-English) the names of the Special pages will be translated. Check the actual links in your wiki for the special page URLs. These are independent of the personal language choice of individual users.

You're done; your wiki should be working perfectly. If not, go to irc://irc.freenode.org/mediawiki and report any problems.

Other how-to mini-guides

Anyone is welcome to create a how-to solution page and list it below. Please use a sensible name for the page, one that fits in with the below names. When each unique solution has its own page, readers can skip complexity they do not want. Keep it simple, readable, short, with a separate page per separate solution.

To help others find out which Short URL methods really work, after trying each method please edit the page and increase the "worked" or "didn't_work" numbers for that guide and make a brief (or long, your choice) description on what went wrong by clicking the link on your number.

URL like - example.com/wiki/Page_title

How to create example.com/wiki/Page_title URLs:

• wiki/Page title -- no root access ^{x117 x9} - recommended method if you don't have root access; should also work with PHP as CGI mode
• wiki/Page title -- GoDaddy Shared Linux Subdomain ^{x4 x1}
• wiki/Page title -- GoDaddy Shared Linux (Not Subdomain) ^x7
• wiki/Page title -- DreamHost Shared Hosting ^x10
• wiki/Page title -- PHP as a CGI module, no root access ^{x21 x5}
• wiki/Page title -- No hidden subdirectory, no root access ^{x14 x2}
• wiki/Page title -- Both no root and root access ^{x2 x3}
• wiki/Page title -- no root access, version 1.11, 1.12 and 1.13 ^{x2 x2}
• wiki/Page title -- No Root Access, 1.13 alternative ^x2
• wiki/Page title -- no root access cpanel

Root access
These methods require that you have access to the server configuration. If you are on a shared host, you most likely don't; see the "no root access" examples instead.

• wiki/Page title ^{x19 x2}
• wiki/Page title -- with aliases--root access ^{x7 x3}
• wiki/Page title -- Apache rewrite--root access ^{x8 x1} (If the Alias method is not suitable [for example, you use PHP as a CGI], you can use Apache instead.)
• wiki/Page title -- Lighttpd rewrite--root access ^x1
• wiki/Page title -- nginx rewrite--root access
• wiki/Page title -- Cherokee rewrite--root access ^x1

URL like - example.com/Page_title

How to create example.com/Page_title URLs:

• Page title -- PHP as a CGI module, no root access ^{x46 x7}
• Page title -- Aliasing method--Root access ^{x8 x7}
• Page title -- Working method with mediawiki-1.11 ^{x26 x5} (used this method: ^x2)
• Page title -- Solution for mediawiki-1.12 ^{x4 x1} (also works with 1.10 & 1.13, but not with 1.11., very similar to the above solution)
• Page title - nginx, Root Access, PHP as a CGI module ^x3
• Page title -- Windows & Apache without 403 on Special Pages ^x1

URL like - example.com/wiki.php/Page_Title

• wiki.php/Page title -- No root No htaccess ^x1

URL like - example.com/sub_directory/wiki/Page_Title

• sub_directory/wiki/Page Title -- .htaccess ^{x3 x2}

URL like - wiki.example.com/Page_title

How to create wiki.example.com/Page_title URLs.

• wiki.example.com/Page_title--difficult ^{x1 x1}
• wiki.example.com/Page_title--Subdomain with no Subdirectory in Article URL ^{x21 x3}
• wiki.example.com/Page_title--OwnMachine ^x1 (the above enhanced, work with 1.14)
• wiki.example.com/Page_title--Subdomain using mod-rewrite ^{x4 x1}
• wiki.example.com/Page_title--Subdomain using Lighttpd
• wiki.example.com/Page_title--Enabling a wiki using Apache Rewrite ^x2
• wiki.example.com/Page_title--Very Simple Rewrite Solution ^x2
• wiki.example.com/Page_title--Subdomain using mod-rewrite (easy) ^x2

Troubleshooting

Ampersand (&) problem

The ampersand problem shows up when you have page titles with symbols in (such as &, ?, #, + and /) that, despite being correctly encoded in the link are not being passed correctly from mod_rewrite to the script. This manifests in 404 page-not-found errors, because the title gets cut off at the special character. For example, clicking on a link to "John & Maria's page" gets a 404, because MediaWiki is looking for a page named "John ".

This is because ampersands in long-form names are treated as query string separators, and would never reach the PHP runtime environment. This is caused by an old and problematic mod_rewrite bug. There are discussions of other possible solutions at lists.wikimedia.org and fgiasson.com.

Solutions:

• Ampersand solution
• Ampersand semi-friendly solution with root access

Looping alias/rewrite errors

If you receive looping alias/rewrite errors such as "Cannot find page www.example.com/wiki/wiki/wiki/wiki/wiki/ [...] /index.php", try one of these fixes:

• Repeated directory errors
• Page title -- Working method with mediawiki-1.11

No Skins

With Ubuntu 8.10 and Mediawiki 1.11.2 (and maybe later versions) if you use the Mediawiki sanctioned directions your skins may fail to load. To fix this, create a symbolic link in /var/www pointing to /var/lib/mediawiki with the value of $wgScriptPath in LocalSettings.php. If, for example, $wgScriptPath is set to "/w" then you need to run the command "sudo ln -s /var/lib/mediawiki /var/www/w".

Purging cache

If you notice that your changes to $wgArticlePath in LocalSettings.php are not being reflected in mysite.com/wiki/Main_Page, it may be due MediaWiki's caching of the links according to previous settings.

Go to mysite.com/wiki/Main_Page?action=purge to force MediaWiki to regenerate the cached links.

Also you can:

1. execute the MySQL query "TRUNCATE objectcache;", or
2. set $wgCacheEpoch to the current date.

Revert to default

If you need to revert to the default values of your wiki but have accidentally deleted them, here are the defaults:

$wgScriptPath       = "/wiki";
$wgScript           = "$wgScriptPath/index.php";
$wgRedirectScript   = "$wgScriptPath/redirect.php";
 
## If using PHP as a CGI module, the ?title= style usually must be used.
# $wgArticlePath      = "$wgScript/$1";
 
$wgArticlePath      = "$wgScript?title=$1";

Redirect visitor of your domain to your wiki

Drop a index.php file in your web root directory with the following lines:

<?php
header( 'Location: http://yourdomain/w/' ) ; # header of web site index is located elsewhere.

Tricks

• IIS6 ^{x1 x1}
• Prevent bots from crawling index.php
• Ignoring the Trailing slash ^x1
• Allowing for escaped characters in URI ^{x2 x1}

See also

• An explanation of what each Apache Rewrite rule does
• Explanation of what CGI modules are
• $wgUsePathInfo - configuration setting that defines whether to use 'pretty' URLs or not

External links

• Apache Module mod_rewrite at Apache.org