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