docs/distributors.txt

   1 This document is intended to provide useful advice for parties seeking to
   2 redistribute MediaWiki to end users.  It's targeted particularly at maintainers
   3 for Linux distributions, since it's been observed that distribution packages of
   4 MediaWiki often break.  We've consistently had to recommend that users seeking
   5 support use official tarballs instead of their distribution's packages, and
   6 this often solves whatever problem the user is having.  It would be nice if
   7 this could change.
   8
   9 == Background: why web applications are different ==
  10
  11 MediaWiki is intended to be usable on any web host that provides support for
  12 PHP and a database.  Many users of low-end shared hosting have very limited
  13 access to their machine: often only FTP access to some subdirectory of the web
  14 root.  Support for these users entails several restrictions, such as:
  15
  16   1) We cannot require installation of any files outside the web root.  Few of
  17   our users have access to directories like /usr or /etc.
  18   2) We cannot require the ability to run any utility on the command line.
  19   Many shared hosts have exec() and similar PHP functions disabled.
  20   3) We cannot assume that the software has write access anywhere useful.  The
  21   user account that MediaWiki (including its installer) runs under is often
  22   different from the account the user used to upload the files, and we might be
  23   restricted by PHP settings such as safe mode or open_basedir.
  24   4) We cannot assume that the software even has read access anywhere useful.
  25   Many shared hosts run all users' web applications under the same user, so
  26   they can't rely on Unix permissions, and must forbid reads to even standard
  27   directories like /tmp lest users read each others' files.
  28   5) We cannot assume that the user has the ability to install or run any
  29   programs not written as web-accessible PHP scripts.
  30
  31 Since anything that works on cheap shared hosting will work if you have shell
  32 or root access too, MediaWiki's design is based around catering to the lowest
  33 common denominator.  Although we support higher-end setups as well (like
  34 Wikipedia!), the way many things work by default is tailored toward shared
  35 hosting.  These defaults are unconventional from the point of view of normal
  36 (non-web) applications -- they might conflict with distributors' policies, and
  37 they certainly aren't ideal for someone who's installing MediaWiki as root.
  38
  39 == Directory structure ==
  40
  41 Because of constraint (1) above, MediaWiki does not conform to normal
  42 Unix filesystem layout.  Hopefully we'll offer direct support for standard
  43 layouts in the future, but for now *any change to the location of files is
  44 unsupported*.  Moving things and leaving symlinks will *probably* not break
  45 anything, but it is *strongly* advised not to try any more intrusive changes to
  46 get MediaWiki to conform more closely to your filesystem hierarchy.  Any such
  47 attempt will almost certainly result in unnecessary bugs.
  48
  49 The standard recommended location to install MediaWiki, relative to the web
  50 root, is /w (so, e.g., /var/www/w).  Rewrite rules can then be used to enable
  51 "pretty URLs" like /wiki/Article instead of /w/index.php?title=Article.  (This
  52 is the convention Wikipedia uses.)  In theory, it should be possible to enable
  53 the appropriate rewrite rules by default, if you can reconfigure the web
  54 server, but you'd need to alter LocalSettings.php too.  See
  55 <http://www.mediawiki.org/wiki/Manual:Short_URL> for details on short URLs.
  56
  57 If you really must mess around with the directory structure, note that the
  58 following files *must* all be web-accessible for MediaWiki to function
  59 correctly:
  60
  61   * api.php, img_auth.php, index.php, mwScriptLoader.php, opensearch_desc.php,
  62   profileinfo.php, redirect.php, thumb.php, trackback.php.  These are the entry
  63   points for normal usage.  This list may be incomplete and is subject to
  64   change.
  65   * config/index.php: Used for web-based installation (sets up the database,
  66   prompts for the name of the wiki, etc.).  No command-line installation is
  67   currently available.
  68   * images/: Used for uploaded files.  This could be somewhere else if
  69   $wgUploadDirectory and $wgUploadPath are changed appropriately.
  70   * skins/*/: Subdirectories of skins/ contain CSS and JavaScript files that
  71   must be accessible to web browsers.  The PHP files and Skin.sample in skins/
  72   don't need to be accessible.  This could be somewhere else if
  73   $wgStyleDirectory and $wgStylePath are changed appropriately.
  74   * extensions/: Many extensions include CSS and JavaScript files in their
  75   extensions directory, and will break if they aren't web-accessible.  Some
  76   extensions might theoretically provide additional entry points as well, at
  77   least in principle.
  78
  79 But all files should keep their position relative to the web-visible
  80 installation directory no matter what.  If you must move includes/ somewhere in
  81 /usr/share, provide a symlink from /var/www/w.  If you don't, you *will* break
  82 something.  You have been warned.
  83
  84 == Configuration ==
  85
  86 MediaWiki is configured using LocalSettings.php.  This is a PHP file that's
  87 generated when the user visits config/index.php to install the software, and
  88 which the user can edit by hand thereafter.  It's just a plain old PHP file,
  89 and can contain any PHP statements.  It usually sets global variables that are
  90 used for configuration, and includes files used by any extensions.
  91
  92 Distributors cannot easily add extra statements to the autogenerated
  93 LocalSettings.php at the present time -- although hacking config/index.php
  94 would work.  It would be nice if this situation could be improved.
  95
  96 Some configuration options that distributors might be in a position to set
  97 intelligently:
  98
  99   * $wgEmergencyContact: An e-mail address that can be used to contact the wiki
 100   administrator.  By default, "wikiadmin@$wgServerName".
 101   * $wgPasswordSender: The e-mail address to use when sending password e-mails.
 102   By default, "MediaWiki Mail <apache@$wgServerName>".
 103   * $wgSMTP: Can be configured to use SMTP for mail sending instead of PHP
 104   mail().
 105
 106 == Documentation ==
 107
 108 MediaWiki's official documentation is split between two places: the source
 109 code, and <http://www.mediawiki.org/>.  The source code documentation is written
 110 exclusively by developers, and so is likely to be reliable (at worst,
 111 outdated).  However, it can be pretty sparse.  mediawiki.org documentation is
 112 often much more thorough, but it's maintained by a wiki that's open to
 113 anonymous edits, so its quality is sometimes sketchy -- don't assume that
 114 anything there is officially endorsed!
 115
 116 == Upstream ==
 117
 118 MediaWiki is a project hosted and led by the Wikimedia Foundation, the
 119 not-for-profit charity that operates Wikipedia.  Wikimedia employs the lead
 120 developer and several other paid developers, but commit access is given out
 121 liberally and there are multiple very active volunteer developers as well.  A
 122 list of developers can be found at <http://www.mediawiki.org/wiki/Developers>.
 123
 124 MediaWiki's bug tracker is at <https://bugzilla.wikimedia.org>.  However, most
 125 developers follow the bug tracker little or not at all.  The best place to
 126 post if you want to get developers' attention is the wikitech-l mailing list
 127 <https://lists.wikimedia.org/mailman/listinfo/wikitech-l>.  Posts to wikitech-l
 128 will inevitably be read by multiple experienced MediaWiki developers.  There's
 129 also an active IRC chat at <irc://irc.freenode.net/mediawiki>, where there are
 130 usually several developers at reasonably busy times of day.
 131
 132 Unfortunately, we don't have a very good system for patch review.  Patches
 133 should be submitted on Bugzilla (as unified diffs produced with "svn diff"
 134 against the latest trunk revision), but many patches languish without review
 135 until they bitrot into uselessness.  You might want to get a developer to
 136 commit to reviewing your patch before you put too much effort into it.
 137 Reasonably straightforward patches shouldn't be too hard to get accepted if
 138 there's an interested developer, however -- posting to Bugzilla and then
 139 dropping a note on wikitech-l if nobody responds is a good tactic.
 140
 141 All redistributors of MediaWiki should be subscribed to mediawiki-announce
 142 <https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce>.  It's
 143 extremely low-traffic, with an average of less than one post per month.  All
 144 new releases are announced here, including critical security updates.
 145
 146 == Useful software to install ==
 147
 148 There are several other pieces of software that MediaWiki can make good use of.
 149 Distributors might choose to install these automatically with MediaWiki and
 150 perhaps configure it to use them (see Configuration section of this document):
 151
 152   * APC (Alternative PHP Cache), XCache, or similar: Will greatly speed up the
 153   execution of MediaWiki, and all other PHP applications, at some cost in
 154   memory usage.  Will be used automatically for the most part.
 155   * clamav: Can be used for virus scanning of uploaded files.  Enable with
 156   "$wgAntivirus = 'clamav';".
 157   * DjVuLibre: Allows processing of DjVu files.  To enable this, set
 158   "$wgDjvuDump = 'djvudump'; $wgDjvuRenderer = 'ddjvu'; $wgDjvuTxt = 'djvutxt';".
 159   * HTML Tidy: Fixes errors in HTML at runtime.  Can be enabled with "$wgUseTidy
 160   = true;".
 161   * ImageMagick: For resizing images.  "$wgUseImageMagick = true;" will enable
 162   it.  PHP's GD can also be used, but ImageMagick is preferable.
 163   * Squid: Can provide a drastic speedup and a major cut in resource
 164   consumption, but enabling it may interfere with other applications.  It might
 165   be suitable for a separate mediawiki-squid package.  For setup details, see:
 166   <http://www.mediawiki.org/wiki/Manual:Squid_caching>
 167   * rsvg or other SVG rasterizer: ImageMagick can be used for SVG support, but
 168   is not ideal.  Wikipedia (as of the time of this writing) uses rsvg.  To
 169   enable, set "$wgSVGConverter = 'rsvg';" (or other as appropriate).
 170   * texvc: Included with MediaWiki.  Instructions for compiling and
 171   installing it are in the math/ directory.
 172
 173 MediaWiki uses some standard GNU utilities as well, such as diff and diff3.  If
 174 these are present in /usr/bin or some other reasonable location, they will be
 175 used automatically.
 176
 177 MediaWiki also has a "job queue" that handles background processing.  Because
 178 shared hosts often don't provide access to cron, the job queue is run on every
 179 page view by default.  This means the background tasks aren't really done in
 180 the background.  Busy wikis can set $wgJobRunRate to 0 and run
 181 maintenance/runJobs.php periodically out of cron.  Distributors probably
 182 shouldn't set this up as a default, however, since the extra cron job is
 183 unnecessary overhead for a little-used wiki.
 184
 185 == Web server configuration ==
 186
 187 MediaWiki includes several .htaccess files to restrict access to some
 188 directories.  If the web server is not configured to support these files, and
 189 the relevant directories haven't been moved someplace inaccessible anyway (e.g.
 190 symlinked in /usr/share with the web server configured to not follow symlinks),
 191 then it might be useful to deny web access to those directories in the web
 192 server's configuration.