| Index: trunk/phase3/docs/distributors.txt |
| — | — | @@ -58,12 +58,11 @@ |
| 59 | 59 | following files *must* all be web-accessible for MediaWiki to function |
| 60 | 60 | correctly: |
| 61 | 61 | |
| 62 | | - * api.php, img_auth.php, index.php,opensearch_desc.php, profileinfo.php, |
| 63 | | - redirect.php, thumb.php, trackback.php. These are the entry points for |
| | 62 | + * api.php, img_auth.php, index.php, load.php, opensearch_desc.php, thumb.php, |
| | 63 | + profileinfo.php, redirect.php, trackback.php. These are the entry points for |
| 64 | 64 | normal usage. This list may be incomplete and is subject to change. |
| 65 | 65 | * mw-config/index.php: Used for web-based installation (sets up the database, |
| 66 | | - prompts for the name of the wiki, etc.). No command-line installation is |
| 67 | | - currently available. |
| | 66 | + prompts for the name of the wiki, etc.). |
| 68 | 67 | * images/: Used for uploaded files. This could be somewhere else if |
| 69 | 68 | $wgUploadDirectory and $wgUploadPath are changed appropriately. |
| 70 | 69 | * skins/*/: Subdirectories of skins/ contain CSS and JavaScript files that |
| — | — | @@ -92,6 +91,9 @@ |
| 93 | 92 | LocalSettings.php at the present time -- although hacking mw-config/index.php |
| 94 | 93 | would work. It would be nice if this situation could be improved. |
| 95 | 94 | |
| | 95 | +There's a new maintenance/install.php script which could be used for performing |
| | 96 | +an install through the command line. |
| | 97 | + |
| 96 | 98 | Some configuration options that distributors might be in a position to set |
| 97 | 99 | intelligently: |
| 98 | 100 | |
| — | — | @@ -103,6 +105,19 @@ |
| 104 | 106 | * $wgSMTP: Can be configured to use SMTP for mail sending instead of PHP |
| 105 | 107 | mail(). |
| 106 | 108 | |
| | 109 | +== Updates == |
| | 110 | +The correct way for updating a wiki is to update the files and then run from |
| | 111 | +command line the maintenance/update.php script (with appropriate parameters if |
| | 112 | +files were moved). It will perform all the needed steps to update the database |
| | 113 | +schema and contents to the version from whatever old one it has. |
| | 114 | +Any package manager which replaces the files but doesn't update the db is leaving |
| | 115 | +an inconsistent wiki that may produce blank pages (php errors) when new features |
| | 116 | +using the changed schema would be used. |
| | 117 | + |
| | 118 | +Since MediaWiki 1.17 it is possible to upgrade using the installer by providing |
| | 119 | +an arbitrary secret value stored as $wgUpgradeKey in LocalSettings (older versions |
| | 120 | +needed to rename LocalSettings.php in order to upgrade using the installer). |
| | 121 | + |
| 107 | 122 | == Documentation == |
| 108 | 123 | |
| 109 | 124 | MediaWiki's official documentation is split between two places: the source |
| — | — | @@ -156,8 +171,8 @@ |
| 157 | 172 | "$wgAntivirus = 'clamav';". |
| 158 | 173 | * DjVuLibre: Allows processing of DjVu files. To enable this, set |
| 159 | 174 | "$wgDjvuDump = 'djvudump'; $wgDjvuRenderer = 'ddjvu'; $wgDjvuTxt = 'djvutxt';". |
| 160 | | - * HTML Tidy: Fixes errors in HTML at runtime. Can be enabled with "$wgUseTidy |
| 161 | | - = true;". |
| | 175 | + * HTML Tidy: Fixes errors in HTML at runtime. Can be enabled with |
| | 176 | + "$wgUseTidy = true;". |
| 162 | 177 | * ImageMagick: For resizing images. "$wgUseImageMagick = true;" will enable |
| 163 | 178 | it. PHP's GD can also be used, but ImageMagick is preferable. |
| 164 | 179 | * Squid: Can provide a drastic speedup and a major cut in resource |
| — | — | @@ -172,7 +187,7 @@ |
| 173 | 188 | |
| 174 | 189 | MediaWiki uses some standard GNU utilities as well, such as diff and diff3. If |
| 175 | 190 | these are present in /usr/bin or some other reasonable location, they will be |
| 176 | | -used automatically. |
| | 191 | +configured automatically on install. |
| 177 | 192 | |
| 178 | 193 | MediaWiki also has a "job queue" that handles background processing. Because |
| 179 | 194 | shared hosts often don't provide access to cron, the job queue is run on every |