Merge "Import: Handle uploads with sha1 starting with 0 properly"
[mediawiki.git] / INSTALL
blob2054a57e83c0b504091c1e8c313dfee2725bb7b8
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.3 or higher.
10 * A SQL server, the following types are supported
11 ** MySQL 5.0.3 or higher
12 ** PostgreSQL 8.3 or higher
13 ** SQLite 3.3.7 or higher
14 ** Oracle 9.0.1 or higher
15 ** Microsoft SQL Server 2005 (9.00.1399)
17 MediaWiki is developed and tested mainly on Unix/Linux platforms, but should
18 work on Windows as well.
20 If your PHP is configured as a CGI plug-in rather than an Apache module you may
21 experience problems, as this configuration is not well tested. safe_mode is also
22 not tested and unlikely to work.
24 Support for rendering mathematical formulas requires installing the Math extension,
25 see https://www.mediawiki.org/wiki/Extension:Math
27 Don't forget to check the RELEASE-NOTES file...
30 Additional documentation is available online, which may include more detailed
31 notes on particular operating systems and workarounds for difficult hosting
32 environments:
34 https://www.mediawiki.org/wiki/Manual:Installation_guide
37 ******************* WARNING *******************
39 REMEMBER: ALWAYS BACK UP YOUR DATABASE BEFORE
40 ATTEMPTING TO INSTALL OR UPGRADE!!!
42 ******************* WARNING *******************
44 ----
45 In-place web install
46 ----
48 Decompress the MediaWiki installation archive either on your server, or on your
49 local machine and upload the directory tree. Rename it from "mediawiki-1.x.x" to
50 something nice, like "wiki", since it will be appearing in your URL,
51 ie. /wiki/index.php/Article.
53   +--------------------------------------------------------------------------+
54   |  Note: If you plan to use a fancy URL-rewriting scheme to prettify your  |
55   |  URLs, such as http://www.example.com/wiki/Article, you should put the   |
56   |  files in a *different* directory from the virtual path where page names |
57   |  will appear. It is common in this case to use w as the folder name and  |
58   |  /wiki/ as the virtual article path where your articles pretend to be.   |
59   |                                                                          |
60   |    See: https://www.mediawiki.org/wiki/Manual:Short_URL                  |
61   +--------------------------------------------------------------------------+
63 Hop into your browser and surf into the wiki directory. It'll direct you into
64 the config script. Fill out the form... remember you're probably not on an
65 encrypted connection.
66 Gaaah! :)
68 If all goes well, you should soon be told that it's set up your wiki database
69 and generated a configuration file. There is now a copy of "LocalSettings.php"
70 available to download from the installer. Download this now, there is not a
71 way (yet) to get it after you exit the installer. Place it in the main wiki
72 directory, and the wiki should now be working.
74 Once the wiki is set up, you should remove the mw-config directory (though it will
75 refuse to config again if the wiki is set up).
77 ----
79 Don't forget that this is free software under development! Chances are good
80 there's a crucial step that hasn't made it into the documentation. You should
81 probably sign up for the MediaWiki developers' mailing list; you can ask for
82 help (please provide enough information to work with, and preferably be aware of
83 what you're doing!) and keep track of major changes to the software, including
84 performance improvements and security patches.
86 http://lists.wikimedia.org/mailman/listinfo/mediawiki-announce (low traffic)
88 http://lists.wikimedia.org/mailman/listinfo/mediawiki-l (site admin support)
90 http://lists.wikimedia.org/mailman/listinfo/wikitech-l (development)