some more comments and moved parameters in their sections
authorAntoine Musso <hashar@users.mediawiki.org>
Sun, 15 Aug 2004 23:25:52 +0000 (23:25 +0000)
committerAntoine Musso <hashar@users.mediawiki.org>
Sun, 15 Aug 2004 23:25:52 +0000 (23:25 +0000)
includes/DefaultSettings.php

index ea1bea3..1375c74 100644 (file)
@@ -3,6 +3,7 @@
 # $Id$
 # DO NOT EDIT THIS FILE!
 # To customize your installation, edit "LocalSettings.php".
+# 
 # Note that since all these string interpolations are expanded
 # before LocalSettings is included, if you localize something
 # like $wgScriptPath, you must also localize everything that
@@ -38,6 +39,9 @@ $wgUsePathInfo                = ( strpos( php_sapi_name(), 'cgi' ) === false );
 $wgScript           = "{$wgScriptPath}/index.php";
 $wgRedirectScript   = "{$wgScriptPath}/redirect.php";
 
+
+# Paths Settings
+# 
 $wgStylePath   = "{$wgScriptPath}/style";
 $wgStyleDirectory = "{$IP}/style";
 $wgStyleSheetPath = &$wgStylePath;
@@ -49,6 +53,10 @@ $wgLogo                              = "{$wgUploadPath}/wiki.png";
 $wgMathPath         = "{$wgUploadPath}/math";
 $wgMathDirectory    = "{$wgUploadDirectory}/math";
 $wgTmpDirectory     = "{$wgUploadDirectory}/tmp";
+
+
+# Email settings
+#
 $wgEmergencyContact = 'wikiadmin@' . getenv( 'SERVER_NAME' );
 $wgPasswordSender      = 'Wikipedia Mail <apache@' . getenv( 'SERVER_NAME' ) . '>';
 
@@ -56,6 +64,7 @@ $wgPasswordSender     = 'Wikipedia Mail <apache@' . getenv( 'SERVER_NAME' ) . '>';
 # "host" => 'SMTP domain', "IDHost" => 'domain for MessageID', "port" => "25", "auth" => true/false, "username" => user, "password" => password
 $wgSMTP                                = false;
 
+
 # Database settings
 #
 $wgDBserver         = 'localhost';
@@ -85,6 +94,9 @@ $wgDBprefix         = ''; # Table name prefix
 $wgDBservers           = false; 
 
 # Sysop SQL queries
+#   The sql user shouldn't have too many rights other the database, restrict
+#   it to SELECT only on 'cur' table for example
+#
 $wgAllowSysopQueries = false; # Dangerous if not configured properly.
 $wgDBsqluser           = 'sqluser';
 $wgDBsqlpassword       = 'sqlpass';
@@ -92,6 +104,11 @@ $wgDBpassword       = 'userpass';
 $wgSqlLogFile           = "{$wgUploadDirectory}/sqllog_mFhyRe6";
 $wgDBerrorLog          = false; # File to log MySQL errors to
 
+# wgDBminWordLen :
+#  MySQL 3.x : used to discard words that MySQL will not return any results for
+#  shorter values configure mysql directly
+#  MySQL 4.x : ignore it and configure mySQL
+# See: http://dev.mysql.com/doc/mysql/en/Fulltext_Fine-tuning.html
 $wgDBminWordLen     = 4;
 $wgDBtransactions      = false; # Set to true if using InnoDB tables
 $wgDBmysql4                    = false; # Set to true to use enhanced fulltext search
@@ -103,7 +120,8 @@ $wgBufferSQLResults     = true; # use buffered queries by default
 # Array, interwiki prefix => database name
 $wgLocalDatabases   = array();
 
-# memcached settings
+
+# Memcached settings
 # See docs/memcached.doc
 #
 $wgMemCachedDebug   = false; # Will be set to false in Setup.php, if the server isn't working
@@ -113,6 +131,7 @@ $wgMemCachedDebug   = false;
 $wgSessionsInMemcached = false;
 $wgLinkCacheMemcached = false; # Not fully tested
 
+
 # Language settings
 #
 $wgLanguageCode     = 'en';
@@ -132,21 +151,26 @@ $wgAmericanDates    = false; # Enable for English module to print dates
 $wgTranslateNumerals = true; # For Hindi and Arabic use local numerals instead
                              # of Western style (0-9) numerals in interface.
 
-$wgLocalInterwiki   = 'w';
-$wgShowIPinHeader      = true; # For non-logged in users
-$wgMaxNameChars     = 32; # Maximum number of bytes in username
-$wgInterwikiExpiry = 10800; # Expiry time for cache of interwiki table
 
 # Translation using MediaWiki: namespace
 # This will increase load times by 25-60% unless memcached is installed
+# Interface messages will be get from the database.
 $wgUseDatabaseMessages = true;
 $wgMsgCacheExpiry      = 86400;
 
-$wgExtraSubtitle       = '';
-$wgSiteSupportPage     = '';
 
 # Miscellaneous configuration settings
 #
+
+$wgLocalInterwiki   = 'w';
+$wgInterwikiExpiry = 10800; # Expiry time for cache of interwiki table
+
+$wgShowIPinHeader      = true; # For non-logged in users
+$wgMaxNameChars     = 32; # Maximum number of bytes in username
+
+$wgExtraSubtitle       = '';
+$wgSiteSupportPage     = ''; # A page where you users can receive donations
+
 $wgReadOnlyFile         = "{$wgUploadDirectory}/lock_yBgMBwiR";
 
 # The debug log file should be not be publicly accessible if it is
@@ -189,22 +213,35 @@ $wgEnableParserCache = false; # requires that php was compiled --with-zlib
 
 $wgHitcounterUpdateFreq = 1;
 
-# User rights 
+# User rights
+#   It's not 100% safe, there could be security hole using that one. Use at your
+# own risks.
+
 $wgWhitelistEdit = false;   # true = user must login to edit.
 $wgWhitelistRead = false;      # Pages anonymous user may see, like: = array ( ":Main_Page", "Special:Userlogin", "Wikipedia:Help");
 $wgWhitelistAccount = array ( 'user' => 1, 'sysop' => 1, 'developer' => 1 );
+
+$wgAllowAnonymousMinor = false; # Allow anonymous users to mark changes as 'minor'
+
 $wgSysopUserBans        = false; # Allow sysops to ban logged-in users
 $wgSysopRangeBans              = false; # Allow sysops to ban IP ranges
 $wgDefaultBlockExpiry  = '24 hours'; # default expiry time
                                 # strtotime format, or "infinite" for an infinite block
 $wgAutoblockExpiry             = 86400; # Number of seconds before autoblock entries expire
+
+# Proxy scanner settings
+#
 $wgBlockOpenProxies = false; # Automatic open proxy test on edit
 $wgProxyPorts = array( 80, 81, 1080, 3128, 6588, 8000, 8080, 8888, 65506 );
 $wgProxyScriptPath = "$IP/proxy_check.php";
 $wgProxyMemcExpiry = 86400;
 $wgProxyKey = 'W1svekXc5u6lZllTZOwnzEk1nbs';
 $wgProxyList = array();  # big list of banned IP addresses, in the keys not the values
-$wgAccountCreationThrottle = 0; # Number of accounts each IP address may create, 0 to disable. Requires memcached
+
+# Number of accounts each IP address may create, 0 to disable.
+# Requires memcached
+$wgAccountCreationThrottle = 0;
+
 
 # Client-side caching:
 $wgCachePages       = true; # Allow client-side caching of pages
@@ -213,6 +250,7 @@ $wgCachePages       = true; # Allow client-side caching of pages
 # Affects both client- and server-side caching.
 $wgCacheEpoch = '20030516000000';
 
+
 # Server-side caching:
 #  This will cache static pages for non-logged-in users
 #  to reduce database traffic on public sites.
@@ -231,19 +269,25 @@ $wgUseGzip = false;
 
 $wgCookieExpiration = 2592000;
 
+
 # Squid-related settings
 #
+
 # Enable/disable Squid
  $wgUseSquid = false;
 # If you run Squid3 with ESI support, enable this (default:false):
  $wgUseESI = false;
 # Internal server name as known to Squid, if different
 # $wgInternalServer = 'http://yourinternal.tld:8000';
  $wgInternalServer = $wgServer;
 # 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');
@@ -252,17 +296,20 @@ $wgCookieExpiration = 2592000;
 $wgMaxSquidPurgeTitles = 400;
 
 
-# Set to set an explicit domain on the login cookies
-# eg, "justthis.domain.org" or ".any.subdomain.net"
+# Cookie settings:
+#   Set to set an explicit domain on the login cookies
+#   eg, "justthis.domain.org" or ".any.subdomain.net"
 $wgCookieDomain = '';
 $wgCookiePath = '/';
 $wgDisableCookieCheck = false;
 
+# Whether to allow inline image pointing to other websites
 $wgAllowExternalImages = true;
+
 $wgMiserMode = false; # Disable database-intensive features
 $wgDisableQueryPages = false; # Disable all query pages if miser mode is on, not just some
 $wgUseWatchlistCache = false; # Generate a watchlist once every hour or so
-$wgWLCacheTimeout = 3600;      # The hour or so mentioned above
+$wgWLCacheTimeout = 3600;     # The hour or so mentioned above
 
 # To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory
 # of the MediaWiki package and have latex, dvips, gs (ghostscript), and
@@ -293,6 +340,7 @@ $wgDisableAnonTalk = false;
 # edit conflicts will fall back to the old behaviour (no merging).
 $wgDiff3 = '/usr/bin/diff3';
 
+
 # We can also compress text in the old revisions table. If this is set on,
 # old revisions will be compressed on page save if zlib support is available.
 # Any compressed revisions will be decompressed on load regardless of this
@@ -339,9 +387,6 @@ $wgNamespacesToBeSearchedDefault = array( -1 => 0, 0 => 1, 1 => 0,
 # If set, a bold ugly notice will show up at the top of every page.
 $wgSiteNotice = "";
 
-# Whether to allow anonymous users to set changes to 'minor'
-$wgAllowAnonymousMinor = false;
-
 ## Set $wgUseImageResize to true if you want to enable dynamic
 ## server side image resizing ("Thumbnails")
 #