r33548 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r33547‎ | r33548 | r33549 >
Date:14:20, 18 April 2008
Author:ialex
Status:old
Tags:
Comment:
Updated URL and changed lines to 80 chars
Modified paths:
  • /trunk/phase3/INSTALL (modified) (history)

Diff [purge]

Index: trunk/phase3/INSTALL
@@ -2,101 +2,94 @@
33 Installing MediaWiki
44 ---
55
6 -Starting with MediaWiki 1.2.0, it's possible to install
7 -and configure the wiki "in-place", as long as you have
8 -the necessary prerequisites available.
 6+Starting with MediaWiki 1.2.0, it's possible to install and configure the wiki
 7+"in-place", as long as you have the necessary prerequisites available.
98
109 Required software:
1110 * Web server with PHP 5.x or higher.
1211 * A MySQL server, 4.0.14 or higher OR a Postgres server, 8.1 or higher
1312
14 -MediaWiki is developed and tested mainly on Unix/Linux
15 -platforms, but should work on Windows as well.
 13+MediaWiki is developed and tested mainly on Unix/Linux platforms, but should
 14+work on Windows as well.
1615
17 -If your PHP is configured as a CGI plug-in rather than
18 -an Apache module you may experience problems, as this
19 -configuration is not well tested. safe_mode is also not
20 -tested and unlikely to work.
 16+If your PHP is configured as a CGI plug-in rather than an Apache module you may
 17+experience problems, as this configuration is not well tested. safe_mode is also
 18+not tested and unlikely to work.
2119
2220 If you want math support see the instructions in math/README
2321
2422 Don't forget to check the RELEASE-NOTES file...
2523
2624
27 -Additional documentation is available online, which may include more
28 -detailed notes on particular operating systems and workarounds for
29 -difficult hosting environments:
 25+Additional documentation is available online, which may include more detailed
 26+notes on particular operating systems and workarounds for difficult hosting
 27+environments:
3028
31 -http://www.mediawiki.org/wiki/Manual:Installation
 29+http://www.mediawiki.org/wiki/Manual:Installation_guide
3230
3331
34 -********************** WARNING **************************
 32+******************* WARNING *******************
3533
36 -REMEMBER: ALWAYS BACK UP YOUR DATABASE BEFORE ATTEMPTING
37 -TO INSTALL OR UPGRADE!!!
 34+REMEMBER: ALWAYS BACK UP YOUR DATABASE BEFORE
 35+ATTEMPTING TO INSTALL OR UPGRADE!!!
3836
39 -********************** WARNING **************************
 37+******************* WARNING *******************
4038
4139 ----
4240 In-place web install
4341 ----
4442
45 -Decompress the MediaWiki installation archive either on
46 -your server, or on your local machine and upload the
47 -directory tree. Rename it from "mediawiki-1.x.x" to
 43+Decompress the MediaWiki installation archive either on your server, or on your
 44+local machine and upload the directory tree. Rename it from "mediawiki-1.x.x" to
4845 something nice, like "wiki", since it'll be in your URL.
4946
50 - +-----------------------------------------------------------+
51 - | Hint: If you plan to use a fancy URL-rewriting scheme |
52 - | to prettify your URLs, you should put the files in a |
53 - | *different* directory from the virtual path where page |
54 - | names will appear. |
55 - | |
56 - | See: http://www.mediawiki.org/wiki/Manual:Short_URL |
57 - +-----------------------------------------------------------+
 47+ +--------------------------------------------------------------------------+
 48+ | Hint: If you plan to use a fancy URL-rewriting scheme to prettify your |
 49+ | URLs, you should put the files in a *different* directory from the |
 50+ | virtual path where page names will appear. |
 51+ | |
 52+ | See: http://www.mediawiki.org/wiki/Manual:Short_URL |
 53+ +--------------------------------------------------------------------------+
5854
59 -To run the install script, you'll need to temporarily make
60 -the 'config' subdirectory writable by the web server. The
61 -simplest way to do this on a Unix/Linux system is to make
62 -it world-writable:
 55+To run the install script, you'll need to temporarily make the 'config'
 56+subdirectory writable by the web server. The simplest way to do this on a
 57+Unix/Linux system is to make it world-writable:
6358
6459 chmod a+w config
6560
66 -Hop into your browser and surf into the wiki directory.
67 -It'll direct you into the config script. Fill out the form...
68 -remember you're probably not on an encrypted connection.
 61+Hop into your browser and surf into the wiki directory. It'll direct you into
 62+the config script. Fill out the form... remember you're probably not on an
 63+encrypted connection.
6964 Gaaah! :)
7065
71 -If all goes well, you should soon be told that it's set up
72 -your wiki database and written a configuration file. There
73 -should now be a 'LocalSettings.php' in the config directory;
74 -move it back up to the main wiki directory, and the wiki
 66+If all goes well, you should soon be told that it's set up your wiki database
 67+and written a configuration file. There should now be a 'LocalSettings.php' in
 68+the config directory; move it back up to the main wiki directory, and the wiki
7569 should now be working.
7670
77 - +------------------------------------------------------------+
78 - | Security hint: if you have limited access on your server |
79 - | and cannot change ownership of files, you might want to |
80 - | *copy* instead of *move* LocalSettings.php. |
81 - | |
82 - | This will make the file owned by your user account |
83 - | instead of by the web server, which is safer in case |
84 - | another user's account is compromised. |
85 - +------------------------------------------------------------+
 71+ +-------------------------------------------------------------------------+
 72+ | Security hint: if you have limited access on your server and cannot |
 73+ | change ownership of files, you might want to *copy* instead of *move* |
 74+ | LocalSettings.php. |
 75+ | |
 76+ | This will make the file owned by your user account instead of by |
 77+ | the web server, which is safer in case another user's account is |
 78+ | compromised. |
 79+ +-------------------------------------------------------------------------+
8680
87 -Once the wiki is set up, you should remove the config
88 -directory, or at least make it not world-writable (though
89 -it will refuse to config again if the wiki is set up).
 81+Once the wiki is set up, you should remove the config directory, or at least
 82+make it not world-writable (though it will refuse to config again if the wiki
 83+is set up).
9084
9185
9286 ----
9387
94 -Don't forget that this is free software under development!
95 -Chances are good there's a crucial step that hasn't made it
96 -into the documentation. You should probably sign up for the
97 -MediaWiki developers' mailing list; you can ask for help (please
98 -provide enough information to work with, and preferably be aware
99 -of what you're doing!) and keep track of major changes to the
100 -software, including performance improvements and security patches.
 88+Don't forget that this is free software under development! Chances are good
 89+there's a crucial step that hasn't made it into the documentation. You should
 90+probably sign up for the MediaWiki developers' mailing list; you can ask for
 91+help (please provide enough information to work with, and preferably be aware of
 92+what you're doing!) and keep track of major changes to the software, including
 93+performance improvements and security patches.
10194
10295 http://lists.wikimedia.org/mailman/listinfo/mediawiki-announce (low traffic)
10396

Status & tagging log