Pass phpcs-strict on some test files (10/11)
[mediawiki.git] / INSTALL
blobe8731a1ecc1f921b98af8ef75a6d32cc8288051a
1 ---
2 Installing MediaWiki
3 ---
5 Starting with MediaWiki 1.2.0, it's possible to install and configure the wiki
6 "in-place", as long as you have the necessary prerequisites available.
8 Required software:
9 * Web server with PHP 5.3.2 or higher.
10 * A SQL server, the following types are supported
11 ** MySQL 5.0.2 or higher
12 ** PostgreSQL 8.3 or higher
13 ** SQLite 3.3.7 or higher
14 ** Oracle 9.0.1 or higher
16 MediaWiki is developed and tested mainly on Unix/Linux platforms, but should
17 work on Windows as well.
19 If your PHP is configured as a CGI plug-in rather than an Apache module you may
20 experience problems, as this configuration is not well tested. safe_mode is also
21 not tested and unlikely to work.
23 Support for rendering mathematical formulas requires installing the Math extension,
24 see https://www.mediawiki.org/wiki/Extension:Math
26 Don't forget to check the RELEASE-NOTES file...
29 Additional documentation is available online, which may include more detailed
30 notes on particular operating systems and workarounds for difficult hosting
31 environments:
33 https://www.mediawiki.org/wiki/Manual:Installation_guide
36 ******************* WARNING *******************
38 REMEMBER: ALWAYS BACK UP YOUR DATABASE BEFORE
39 ATTEMPTING TO INSTALL OR UPGRADE!!!
41 ******************* WARNING *******************
43 ----
44 In-place web install
45 ----
47 Decompress the MediaWiki installation archive either on your server, or on your
48 local machine and upload the directory tree. Rename it from "mediawiki-1.x.x" to
49 something nice, like "wiki", since it will be appearing in your URL,
50 ie. /wiki/index.php/Article.
52   +--------------------------------------------------------------------------+
53   |  Note: If you plan to use a fancy URL-rewriting scheme to prettify your  |
54   |  URLs, such as http://www.example.com/wiki/Article, you should put the   |
55   |  files in a *different* directory from the virtual path where page names |
56   |  will appear. It is common in this case to use w as the folder name and  |
57   |  /wiki/ as the virtual article path where your articles pretend to be.   |
58   |                                                                          |
59   |    See: https://www.mediawiki.org/wiki/Manual:Short_URL                  |
60   +--------------------------------------------------------------------------+
62 Hop into your browser and surf into the wiki directory. It'll direct you into
63 the config script. Fill out the form... remember you're probably not on an
64 encrypted connection.
65 Gaaah! :)
67 If all goes well, you should soon be told that it's set up your wiki database
68 and generated a configuration file. There is now a copy of "LocalSettings.php"
69 available to download from the installer. Download this now, there is not a
70 way (yet) to get it after you exit the installer. Place it in the main wiki
71 directory, and the wiki should now be working.
73 Once the wiki is set up, you should remove the mw-config directory (though it will
74 refuse to config again if the wiki is set up).
76 ----
78 Don't forget that this is free software under development! Chances are good
79 there's a crucial step that hasn't made it into the documentation. You should
80 probably sign up for the MediaWiki developers' mailing list; you can ask for
81 help (please provide enough information to work with, and preferably be aware of
82 what you're doing!) and keep track of major changes to the software, including
83 performance improvements and security patches.
85 http://lists.wikimedia.org/mailman/listinfo/mediawiki-announce (low traffic)
87 http://lists.wikimedia.org/mailman/listinfo/mediawiki-l (site admin support)
89 http://lists.wikimedia.org/mailman/listinfo/wikitech-l (development)