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