X-Git-Url: https://git.cyclocoop.org/?a=blobdiff_plain;f=docs%2Fdistributors.txt;h=4a654315335ccb770378936bea9499c9427b57bf;hb=21bafdfa24c40af12fa7c4733c1097ee09d75374;hp=5586df1222d08c5255a41a50311cb9e154bb0f0a;hpb=bbbd4b91b4865200f08cd1fcc3197b2218288729;p=lhc%2Fweb%2Fwiklou.git

diff --git a/docs/distributors.txt b/docs/distributors.txt
index 5586df1222..4a65431533 100644
--- a/docs/distributors.txt
+++ b/docs/distributors.txt
@@ -58,13 +58,11 @@ If you really must mess around with the directory structure, note that the
 following files *must* all be web-accessible for MediaWiki to function
 correctly:
 
-  * api.php, img_auth.php, index.php, mwScriptLoader.php, opensearch_desc.php,
-  profileinfo.php, redirect.php, thumb.php, trackback.php.  These are the entry
-  points for normal usage.  This list may be incomplete and is subject to
-  change.
-  * config/index.php: Used for web-based installation (sets up the database,
-  prompts for the name of the wiki, etc.).  No command-line installation is
-  currently available.
+  * api.php, img_auth.php, index.php, load.php, opensearch_desc.php, thumb.php,
+  profileinfo.php, redirect.php, trackback.php.  These are the entry points for
+  normal usage.  This list may be incomplete and is subject to change.
+  * mw-config/index.php: Used for web-based installation (sets up the database,
+  prompts for the name of the wiki, etc.).
   * images/: Used for uploaded files.  This could be somewhere else if
   $wgUploadDirectory and $wgUploadPath are changed appropriately.
   * skins/*/: Subdirectories of skins/ contain CSS and JavaScript files that
@@ -84,25 +82,43 @@ something.  You have been warned.
 == Configuration ==
 
 MediaWiki is configured using LocalSettings.php.  This is a PHP file that's
-generated when the user visits config/index.php to install the software, and
+generated when the user visits mw-config/index.php to install the software, and
 which the user can edit by hand thereafter.  It's just a plain old PHP file,
 and can contain any PHP statements.  It usually sets global variables that are
 used for configuration, and includes files used by any extensions.
 
-Distributors cannot easily add extra statements to the autogenerated
-LocalSettings.php at the present time -- although hacking config/index.php
-would work.  It would be nice if this situation could be improved.
+Distributors can easily add extra statements to the autogenerated
+LocalSettings.php by changing mw-config/overrides.php (see that file for details
+and examples).
+
+There's a new maintenance/install.php script which could be used for performing
+an install through the command line.
 
 Some configuration options that distributors might be in a position to set
 intelligently:
 
   * $wgEmergencyContact: An e-mail address that can be used to contact the wiki
-  administrator.  By default, "wikiadmin@$wgServerName".
+  administrator.  By default, "wikiadmin@ServerName".
   * $wgPasswordSender: The e-mail address to use when sending password e-mails.
-  By default, "MediaWiki Mail <apache@$wgServerName>".
+  By default, "MediaWiki Mail <apache@ServerName>".
+	(with ServerName guessed from the http request)
   * $wgSMTP: Can be configured to use SMTP for mail sending instead of PHP
   mail().
 
+== Updates ==
+
+The correct way for updating a wiki is to update the files and then run from 
+command line the maintenance/update.php script (with appropriate parameters if
+files were moved). It will perform all the needed steps to update the database 
+schema and contents to the version from whatever old one it has.
+Any package manager which replaces the files but doesn't update the db is leaving
+an inconsistent wiki that may produce blank pages (php errors) when new features 
+using the changed schema would be used.
+
+Since MediaWiki 1.17 it is possible to upgrade using the installer by providing 
+an arbitrary secret value stored as $wgUpgradeKey in LocalSettings (older versions 
+needed to rename LocalSettings.php in order to upgrade using the installer).
+
 == Documentation ==
 
 MediaWiki's official documentation is split between two places: the source
@@ -156,8 +172,8 @@ perhaps configure it to use them (see Configuration section of this document):
   "$wgAntivirus = 'clamav';".
   * DjVuLibre: Allows processing of DjVu files.  To enable this, set
   "$wgDjvuDump = 'djvudump'; $wgDjvuRenderer = 'ddjvu'; $wgDjvuTxt = 'djvutxt';".
-  * HTML Tidy: Fixes errors in HTML at runtime.  Can be enabled with "$wgUseTidy
-  = true;".
+  * HTML Tidy: Fixes errors in HTML at runtime.  Can be enabled with 
+	"$wgUseTidy = true;".
   * ImageMagick: For resizing images.  "$wgUseImageMagick = true;" will enable
   it.  PHP's GD can also be used, but ImageMagick is preferable.
   * Squid: Can provide a drastic speedup and a major cut in resource
@@ -172,7 +188,7 @@ perhaps configure it to use them (see Configuration section of this document):
 
 MediaWiki uses some standard GNU utilities as well, such as diff and diff3.  If
 these are present in /usr/bin or some other reasonable location, they will be
-used automatically.
+configured automatically on install.
 
 MediaWiki also has a "job queue" that handles background processing.  Because
 shared hosts often don't provide access to cron, the job queue is run on every