Fixed spelling
[lhc/web/wiklou.git] / LocalSettings.sample
index 6bda7fd..68ec52c 100644 (file)
@@ -1,4 +1,4 @@
-<?
+<?php
 # Local settings work like this: the file LocalSettings.sample
 # should be copied to LocalSettings.php in the source directory
 # and edited for your local file system settings and software
 # here, otherwise your settings will be overwritten with your
 # next update.
 
+# You can get some useful informations online at:
+# http://meta.wikipedia.org/wiki/LocalSettings.php
+
+
 # The most important setting is here: $IP is the installation
 # path for the software. In the example below, the htdocs
 # dir should be set as the DocumentRoot in the httpd.conf 
 #
 $IP = "/usr/local/apache/htdocs/wiki";
 
+
+## Don't change this bit; install.php needs it.
+#
 if ( ! isset( $DP ) ) { $DP = $IP; }
 include_once( "$DP/DefaultSettings.php" );
 
+## Please customize!
+#
+$wgSitename         = "MediaWiki";
+
 # You can customize a lot of URLs and paths, but you will
 # almost certainly want to customize the following.  The
+
+# Normally the server will be auto-detected, but you can
+# force the base URL. Don't forget http:// (or https://)!
+# If you are running php as CGI, the $_SERVER variable might
+# not be set, you will then need to manually set $wgServer
+#
+#$wgServer           = "http://www.myhost.com";
+
+## The location of the main script, you need this to be correct!
+#
+$wgScriptPath      = "/wiki";
+$wgScript           = "{$wgScriptPath}/index.php";
+$wgRedirectScript   = "{$wgScriptPath}/redirect.php";
+
 # ArticlePath one is especially useful if you want to use
 # mod_redirect to make page-viewing URLs look static.
 #
-$wgServer           = "http://www.myhost.com";
-$wgScriptPath      = "/wiki";
-$wgArticlePath      = "{$wgScript}?title=$1";
-$wgEmergencyContact = "wikiadmin@myhost.com";
+$wgArticlePath      = "{$wgScript}/$1";
+# $wgArticlePath     = "/wiki/$1"; # Prettier if you're setup for it
+
+## Normally you don't need to change these once the above are set...
+#
+$wgStylePath   = "{$wgScriptPath}/style";
+$wgStyleSheetDirectory = "{$IP}/style";
+
+$wgUploadPath       = "{$wgScriptPath}/upload";
+$wgUploadDirectory     = "{$IP}/upload";
+$wgLogo                                = "{$wgStylePath}/images/wiki.png";
+
+## Preferably these addresses should be able to receive mail asking for help
+#
+$wgEmergencyContact = "wikiadmin@" . getenv( "SERVER_NAME" );
+$wgPasswordSender      = "Wikipedia Mail <apache@" . getenv( "SERVER_NAME" ) . ">";
 
 # MySQL settings
 #
 # The user you specify here DOES NOT NEED TO EXIST.
-# It is created by the installation script.
+# It is created by the installation script, if
+# you have root privileges on your database.
+#
+# IF on the other hand you have only limited privs
+# on your DB and have to do a manual install, use
+# your existing username and password. Be sure this
+# file doesn't get left around on the web legible...
 #
 # $wgDBsqluser is used for queries through the 
 # web interface. It is also created by the script.
@@ -51,62 +94,84 @@ $wgEmergencyContact = "wikiadmin@myhost.com";
 $wgDBserver         = "localhost";
 $wgDBname           = "wikidb";
 $wgDBuser           = "wikiuser";
-$wgDBpassword       = "userpass";
+$wgDBpassword       = "userpass"; # Use a better password! ;)
 $wgDBsqluser        = "sqluser";
 $wgDBsqlpassword       = "sqlpass";
 
-# Advanced DB settings
+## Advanced DB settings
 #
 $wgDBminWordLen                = 3;     # Match this to your MySQL fulltext
-$wgDBtransactions   = false; # Set to true if using InnoDB tables
 
+## Set these to true to turn on some optimizations when using
+## MySQL 4.x:
 #
-# Set $wgUseImageResize to true if you want to enable dynamic
-# server side image resizing ("Thumbnails")
-# 
-$wgUseImageResize              = false;
+# $wgDBmysql4                  = true;
+# $wgEnablePersistentLC        = true;
 
-# Resizing can be done using PHP's internal image libraries
-# or using ImageMagick. The later supports more file formats
-# than PHP, which only supports PNG, GIF, JPG, XBM and WBMP.
-#
-# Set $wgUseImageMagick to true to use Image Magick instead
-# of the builtin functions
+## You can customize the interface messages through the wiki;
+## see [[MediaWiki:All pages]]. (This requires a sysop account.)
+## This causes a performance hit, though; if you don't need it,
+## feel free to turn it off:
 #
-$wgUseImageMagick              = false;
-$wgImageMagickConvertCommand    = "/usr/bin/convert";
+# $wgUseDatabaseMessages = false;
 
-# If you want a non-English wiki, add a line like this
-# $wgLanguageCode = "de";
+## Set $wgUseImageResize to true if you want to enable dynamic
+## server side image resizing ("Thumbnails")
+# 
+# $wgUseImageResize            = true;
+
+## Resizing can be done using PHP's internal image libraries
+## or using ImageMagick. The later supports more file formats
+## than PHP, which only supports PNG, GIF, JPG, XBM and WBMP.
+##
+## Set $wgUseImageMagick to true to use Image Magick instead
+## of the builtin functions
+#
+# $wgUseImageMagick            = true;
+# $wgImageMagickConvertCommand    = "/usr/bin/convert";
 
-# Turn this on during database maintenance
-# $wgReadOnly = true;
+## If you have the appropriate support software installed
+## you can enable inline LaTeX equations:
+# $wgUseTeX                    = true;
+# $wgMathPath         = "{$wgUploadPath}/math";
+# $wgMathDirectory    = "{$wgUploadDirectory}/math";
+# $wgTmpDirectory     = "{$wgUploadDirectory}/tmp";
 
-# Turn this on to get HTML debug comments
-# $wgDebugComments     = true;
+$wgLocalInterwiki   = $wgSitename;
 
-$wgUseTeX                      = false;
-$wgUseCategoryMagic = true ;
+## If you want a non-English wiki, add a line like this
+# $wgLanguageCode = "de";
 
-$wgLocalInterwiki   = "w";
+## Character encoding: normally auto-selected by the language.
+## English, German, Danish, Dutch, French, Spanish, and Swedish
+## will be in ISO-8859-1 by default, all other languages in
+## UTF-8 encoding. UTF-8 is more flexible, but some older browsers
+## have trouble with it. You can force an English-language wiki
+## to UTF-8 by uncommenting the lines below. The other languages
+## mentioned above might not work properly this way without
+## additional tweaking.
+#
+# $wgInputEncoding     = "UTF-8";
+# $wgOutputEncoding    = "UTF-8";
 
-$wgInputEncoding       = "ISO-8859-1";
-$wgOutputEncoding      = "ISO-8859-1";
+## Default skin: you can change the default skin. Use the internal symbolic
+## names, ie 'standard', 'nostalgia', 'cologneblue', 'monobook':
+# $wgDefaultSkin = 'monobook';
 
-# Extremely high-traffic wikis may want to disable
-# some database-intensive features here:
+## Extremely high-traffic wikis may want to disable
+## some database-intensive features here:
 #
 # $wgDisableTextSearch = true;
 # $wgDisableCounters = true;
 # $wgMiserMode         = true;
 
-# The following three config variables are used to define
-# the rights of users in your system. 
+## The following three config variables are used to define
+## the rights of users in your system. 
 #
 # If wgWhitelistEdit is set to true, only logged in users
 # are allowed to edit articles.
-# If wgWhitelistRead is set to true, only logged in users
-# are allowed to read articles.
+# If wgWhitelistRead is set to an array of page names, only logged in users
+# are allowed to read pages *not in the list*.
 #
 # wgWhitelistAccount lists user types that can add user accounts:
 # "key" => 1 defines permission if user has right "key".
@@ -120,7 +185,7 @@ $wgOutputEncoding   = "ISO-8859-1";
 #
 # Invitation-only closed shop type of system
 # $wgWhitelistEdit = true;
-# $wgWhitelistRead = true;
+# $wgWhitelistRead = array ( ":Main_Page" );
 # $wgWhitelistAccount = array ( "user" => 0, "sysop" => 1, "developer" => 1 );
 #
 # Public website, closed editorial team
@@ -137,6 +202,10 @@ $wgOutputEncoding  = "ISO-8859-1";
 # $wgUseESI = true;
 # Internal server name as known to Squid, if different
 # $wgInternalServer = 'http://yourinternal.tld:8000';
+# Cache timeout for the squid, will be sent as s-maxage (without ESI) or 
+# Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in the Squid config.
+# 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days
+# $wgSquidMaxage = 18000;
 # A list of proxy servers (ips if possible) to purge on changes
 # don't specify ports here (80 is default)
 # $wgSquidServers = array('127.0.0.1');