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