LocalSettings.php
From TechWiki
LocalSettings.php provides local configuration settings (based on the DefaultSettings.php file) of a MediaWiki installation. It is also where all third-party extensions are invoked with their parameter calls.
It is located in the root directory of your wiki installation (as is true for any Mediawiki installation). These same settings may be found in DefaultSettings.php. However, alway make changes in LocalSettings.php and make sure to comment them for later explanation.
External Manual
The external manual for LocalSettings is found at: http://www.mediawiki.org/wiki/Help:Configuration_settings
Current Wiki LocalSettings
Here is the current LocalSettings.php for this wiki. Please note that each component is commented via the lines prefaced with '#':
<?php
# This file was automatically generated by the MediaWiki installer.
# If you make manual changes, please keep track in case you need to
# recreate them later.
#
# See includes/DefaultSettings.php for all configurable settings
# and their default values, but don't forget to make changes in _this_
# file, not there.
#
# Further documentation for configuration settings may be found at:
# http://www.mediawiki.org/wiki/Manual:Configuration_settings
# If you customize your file layout, set $IP to the directory that contains
# the other MediaWiki files. It will be used as a base to locate files.
if( defined( 'MW_INSTALL_PATH' ) ) {
$IP = MW_INSTALL_PATH;
} else {
$IP = dirname( __FILE__ );
}
$path = array( $IP, "$IP/includes", "$IP/languages" );
set_include_path( implode( PATH_SEPARATOR, $path ) . PATH_SEPARATOR . get_include_path() );
require_once( "$IP/includes/DefaultSettings.php" );
# If PHP's memory limit is very low, some operations may fail.
ini_set( 'memory_limit', '128M' );
if ( $wgCommandLineMode ) {
if ( isset( $_SERVER ) && array_key_exists( 'REQUEST_METHOD', $_SERVER ) ) {
die( "This script must be run from the command line\n" );
}
}
## Uncomment this to disable output compression
# $wgDisableOutputCompression = true;
$wgSitename = "TechWiki";
## The URL base path to the directory containing the wiki;
## defaults for all runtime URL paths are based off of this.
## For more information on customizing the URLs please see:
## http://www.mediawiki.org/wiki/Manual:Short_URL
$wgScriptPath = "";
$wgScriptExtension = ".php";
## UPO means: this is also a user preference option
$wgEnableEmail = false;
$wgEnableUserEmail = false; # UPO
$wgEmergencyContact = "xxxxx";
$wgPasswordSender = "xxxxx";
# Enable reading by anonymous users
$wgGroupPermissions['*']['read'] = true;
# Disable granting access to any user
$wgGroupPermissions['*']['createaccount'] = false;
$wgGroupPermissions['*']['edit'] = false;
$wgGroupPermissions['*']['createpage'] = false;
$wgGroupPermissions['*']['createtalk'] = false;
# But allow them to read the Main Page, login page, and JS/CSS pages
#$wgWhitelistRead = array( ":Main Page", "Special:Userlogin", "-", "MediaWiki:Monobook.css" );
$wgEnotifUserTalk = false; # UPO
$wgEnotifWatchlist = false; # UPO
$wgEmailAuthentication = false;
## Database settings
$wgDBtype = "xxxxx";
$wgDBserver = "xxxxx";
$wgDBname = "xxxxx";
$wgDBuser = "xxxxx";
$wgDBpassword = "xxxxx";
# MySQL specific settings
$wgDBprefix = "xxxxx_";
# MySQL table options to use during installation or update
$wgDBTableOptions = "ENGINE=InnoDB, DEFAULT CHARSET=binary";
# Experimental charset support for MySQL 4.1/5.0.
$wgDBmysql5 = true;
## Shared memory settings
$wgMainCacheType = CACHE_NONE;
$wgMemCachedServers = array();
## To enable image uploads, make sure the 'images' directory
## is writable, then set this to true:
$wgEnableUploads = true;
$wgUseImageResize = true;
$wgVerifyMimeType = false;
$wgFileExtensions = array('png', 'gif', 'jpg', 'jpeg', 'doc', 'xls', 'pdf', 'ppt', 'zip', 'svg');
$wgAllowExternalImages = true;
# $wgUseImageMagick = true;
# $wgImageMagickConvertCommand = "/usr/bin/convert";
## If you use ImageMagick (or any other shell command) on a
## Linux server, this will need to be set to the name of an
## available UTF-8 locale
$wgShellLocale = "en_US.utf8";
## Enables namespace statistics; one of the Magic works; per http://www.mediawiki.org/wiki/Help:Magic_words
$wgAllowSlowParserFunctions = true;
## If you want to use image uploads under safe mode,
## create the directories images/archive, images/thumb and
## images/temp, and make them all writable. Then uncomment
## this, if it's not already uncommented:
# $wgHashedUploadDirectory = false;
## If you have the appropriate support software installed
## you can enable inline LaTeX equations:
$wgUseTeX = false;
$wgLocalInterwiki = strtolower( $wgSitename );
$wgLanguageCode = "en";
$wgSecretKey = "40f1e39049da107abd3e8a858330dbd5b7b0e580cf47df3c52030490fbeec5ab";
## Default skin: you can change the default skin. Use the internal symbolic
## names, ie 'standard', 'nostalgia', 'cologneblue', 'monobook':
$wgDefaultSkin = 'monobook';
## For attaching licensing metadata to pages, and displaying an
## appropriate copyright notice / icon. GNU Free Documentation
## License and Creative Commons licenses are supported so far.
$wgEnableCreativeCommonsRdf = true;
$wgRightsPage = "TechWiki:Copyrights"; # Set to the title of a wiki page that describes your license/copyright
$wgRightsUrl = "http://creativecommons.org/licenses/by/3.0/";
$wgRightsText = "CC Attribution 3.0";
$wgRightsIcon = "http://i.creativecommons.org/l/by/3.0/88x31.png";
# $wgRightsCode = "[license_code]"; # Not yet used
$wgDiff3 = "/usr/bin/diff3";
# When you make changes to this configuration file, this will make
# sure that cached pages are cleared.
$wgCacheEpoch = max( $wgCacheEpoch, gmdate( 'YmdHis', @filemtime( __FILE__ ) ) );
## Incorporation of the AnyWeb extension (per http://www.mediawiki.org/wiki/Extension:Anysite)
include("extensions/anywebsite.php");
## Incorporation of the SelectCategory extension (per http://www.mediawiki.org/wiki/Extension:SelectCategory)
## require_once( 'extensions/SelectCategory/SelectCategory.php' );
## Incorporation of the ManageCategories extension (per http://www.mediawiki.org/wiki/Extension:ManageCategories)
require_once("$IP/extensions/managecategories/managecategories.php");
## Incorporation of the CategoryTree extension (per http://www.mediawiki.org/wiki/Extension:CategoryTree)
$wgUseAjax = true;
require_once("$IP/extensions/CategoryTree/CategoryTree.php");
$wgCategoryTreeSidebarRoot = "OpenStructs_Projects";
## Incorporation of the MultiCategorySearch extension (per http://www.mediawiki.org/wiki/Extension:Multi-Category_Search)
require_once("$IP/extensions/MultiCategorySearch/MultiCategorySearch.php");
## Incorporation of the NiceCategoryList extension (per http://www.mediawiki.org/wiki/Extension:NiceCategoryList2)
require_once("$IP/extensions/NiceCategoryList.php");
## Incorporation of the Cite extension (per http://www.mediawiki.org/wiki/Extension:Cite/Cite.php)
require_once("$IP/extensions/Cite/Cite.php");
## Incorporation of the SyntaxHighlight GeSHi extension (per http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi)
require_once("$IP/extensions/SyntaxHighlight_GeSHi/SyntaxHighlight_GeSHi.php");
$wgSyntaxHighlightDefaultLang = "php";
## Incorporation of the Collections extension (per http://www.mediawiki.org/wiki/Extension:Collection)
## and the help file at (http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Collection/README.txt)
## also see http://edutechwiki.unige.ch/en/Mediawiki_collection_extension_installation#Collection_extension_installation
#require_once("$IP/extensions/Collection/Collection.php");
#$wgCollectionMWServeURL = "http://tools.pediapress.com/mw-serve/";
/** Login credentials to this MediaWiki as 'USERNAME:PASSWORD' string */
#$wgCollectionMWServeCredentials = 'Transfer:transfer_mojo';
## Incorporation of the Renameuser extension (per http://www.mediawiki.org/wiki/Extension:Renameuser)
require_once("$IP/extensions/Renameuser/SpecialRenameuser.php");
## Incorporation of the Replace Text (useful for page renames, for example) extension (per http://www.mediawiki.org/wiki/Extension:Replace_Text)
require_once( "$IP/extensions/ReplaceText/ReplaceText.php" );
$wgGroupPermissions['sysop']['replacetext'] = true;
## Incorporation of the SimpleSecurity extension (per http://www.mediawiki.org/wiki/Extension:SimpleSecurity)
$wgSecurityUseDBHook = true; # this directive MUST be used before the extension include
require_once("{$IP}/extensions/SimpleSecurity/SimpleSecurity.php");
$wgPageRestrictions['Category:Restrict']['read'] = array('sysop', 'bureaucrat');
$wgPageRestrictions['Category:Restrict']['edit'] = array('sysop');
#require_once("extensions/PdfExport/PdfExport.php");
#$wgPdfExportBackground = "path/to/the/background-image/image.jpg";
## Choose one of the following two rich-text editors, OR neither:
## Incorporation of the FCKeditor
#require_once( "$IP/extensions/FCKeditor/FCKeditor.php" );
## Incorporation of the WYSIWYG extension (CKEditor, used in Semantic Halo)
require_once("$IP/extensions/WYSIWYG/WYSIWYG.php");
$wgGroupPermissions['registered_users']['wysiwyg']=true;
# This file was automatically generated by the MediaWiki installer.
# If you make manual changes, please keep track in case you need to
# recreate them later.
#
# See includes/DefaultSettings.php for all configurable settings
# and their default values, but don't forget to make changes in _this_
# file, not there.
#
# Further documentation for configuration settings may be found at:
# http://www.mediawiki.org/wiki/Manual:Configuration_settings
# If you customize your file layout, set $IP to the directory that contains
# the other MediaWiki files. It will be used as a base to locate files.
if( defined( 'MW_INSTALL_PATH' ) ) {
$IP = MW_INSTALL_PATH;
} else {
$IP = dirname( __FILE__ );
}
$path = array( $IP, "$IP/includes", "$IP/languages" );
set_include_path( implode( PATH_SEPARATOR, $path ) . PATH_SEPARATOR . get_include_path() );
require_once( "$IP/includes/DefaultSettings.php" );
# If PHP's memory limit is very low, some operations may fail.
ini_set( 'memory_limit', '128M' );
if ( $wgCommandLineMode ) {
if ( isset( $_SERVER ) && array_key_exists( 'REQUEST_METHOD', $_SERVER ) ) {
die( "This script must be run from the command line\n" );
}
}
## Uncomment this to disable output compression
# $wgDisableOutputCompression = true;
$wgSitename = "TechWiki";
## The URL base path to the directory containing the wiki;
## defaults for all runtime URL paths are based off of this.
## For more information on customizing the URLs please see:
## http://www.mediawiki.org/wiki/Manual:Short_URL
$wgScriptPath = "";
$wgScriptExtension = ".php";
## UPO means: this is also a user preference option
$wgEnableEmail = false;
$wgEnableUserEmail = false; # UPO
$wgEmergencyContact = "xxxxx";
$wgPasswordSender = "xxxxx";
# Enable reading by anonymous users
$wgGroupPermissions['*']['read'] = true;
# Disable granting access to any user
$wgGroupPermissions['*']['createaccount'] = false;
$wgGroupPermissions['*']['edit'] = false;
$wgGroupPermissions['*']['createpage'] = false;
$wgGroupPermissions['*']['createtalk'] = false;
# But allow them to read the Main Page, login page, and JS/CSS pages
#$wgWhitelistRead = array( ":Main Page", "Special:Userlogin", "-", "MediaWiki:Monobook.css" );
$wgEnotifUserTalk = false; # UPO
$wgEnotifWatchlist = false; # UPO
$wgEmailAuthentication = false;
## Database settings
$wgDBtype = "xxxxx";
$wgDBserver = "xxxxx";
$wgDBname = "xxxxx";
$wgDBuser = "xxxxx";
$wgDBpassword = "xxxxx";
# MySQL specific settings
$wgDBprefix = "xxxxx_";
# MySQL table options to use during installation or update
$wgDBTableOptions = "ENGINE=InnoDB, DEFAULT CHARSET=binary";
# Experimental charset support for MySQL 4.1/5.0.
$wgDBmysql5 = true;
## Shared memory settings
$wgMainCacheType = CACHE_NONE;
$wgMemCachedServers = array();
## To enable image uploads, make sure the 'images' directory
## is writable, then set this to true:
$wgEnableUploads = true;
$wgUseImageResize = true;
$wgVerifyMimeType = false;
$wgFileExtensions = array('png', 'gif', 'jpg', 'jpeg', 'doc', 'xls', 'pdf', 'ppt', 'zip', 'svg');
$wgAllowExternalImages = true;
# $wgUseImageMagick = true;
# $wgImageMagickConvertCommand = "/usr/bin/convert";
## If you use ImageMagick (or any other shell command) on a
## Linux server, this will need to be set to the name of an
## available UTF-8 locale
$wgShellLocale = "en_US.utf8";
## Enables namespace statistics; one of the Magic works; per http://www.mediawiki.org/wiki/Help:Magic_words
$wgAllowSlowParserFunctions = true;
## If you want to use image uploads under safe mode,
## create the directories images/archive, images/thumb and
## images/temp, and make them all writable. Then uncomment
## this, if it's not already uncommented:
# $wgHashedUploadDirectory = false;
## If you have the appropriate support software installed
## you can enable inline LaTeX equations:
$wgUseTeX = false;
$wgLocalInterwiki = strtolower( $wgSitename );
$wgLanguageCode = "en";
$wgSecretKey = "40f1e39049da107abd3e8a858330dbd5b7b0e580cf47df3c52030490fbeec5ab";
## Default skin: you can change the default skin. Use the internal symbolic
## names, ie 'standard', 'nostalgia', 'cologneblue', 'monobook':
$wgDefaultSkin = 'monobook';
## For attaching licensing metadata to pages, and displaying an
## appropriate copyright notice / icon. GNU Free Documentation
## License and Creative Commons licenses are supported so far.
$wgEnableCreativeCommonsRdf = true;
$wgRightsPage = "TechWiki:Copyrights"; # Set to the title of a wiki page that describes your license/copyright
$wgRightsUrl = "http://creativecommons.org/licenses/by/3.0/";
$wgRightsText = "CC Attribution 3.0";
$wgRightsIcon = "http://i.creativecommons.org/l/by/3.0/88x31.png";
# $wgRightsCode = "[license_code]"; # Not yet used
$wgDiff3 = "/usr/bin/diff3";
# When you make changes to this configuration file, this will make
# sure that cached pages are cleared.
$wgCacheEpoch = max( $wgCacheEpoch, gmdate( 'YmdHis', @filemtime( __FILE__ ) ) );
## Incorporation of the AnyWeb extension (per http://www.mediawiki.org/wiki/Extension:Anysite)
include("extensions/anywebsite.php");
## Incorporation of the SelectCategory extension (per http://www.mediawiki.org/wiki/Extension:SelectCategory)
## require_once( 'extensions/SelectCategory/SelectCategory.php' );
## Incorporation of the ManageCategories extension (per http://www.mediawiki.org/wiki/Extension:ManageCategories)
require_once("$IP/extensions/managecategories/managecategories.php");
## Incorporation of the CategoryTree extension (per http://www.mediawiki.org/wiki/Extension:CategoryTree)
$wgUseAjax = true;
require_once("$IP/extensions/CategoryTree/CategoryTree.php");
$wgCategoryTreeSidebarRoot = "OpenStructs_Projects";
## Incorporation of the MultiCategorySearch extension (per http://www.mediawiki.org/wiki/Extension:Multi-Category_Search)
require_once("$IP/extensions/MultiCategorySearch/MultiCategorySearch.php");
## Incorporation of the NiceCategoryList extension (per http://www.mediawiki.org/wiki/Extension:NiceCategoryList2)
require_once("$IP/extensions/NiceCategoryList.php");
## Incorporation of the Cite extension (per http://www.mediawiki.org/wiki/Extension:Cite/Cite.php)
require_once("$IP/extensions/Cite/Cite.php");
## Incorporation of the SyntaxHighlight GeSHi extension (per http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi)
require_once("$IP/extensions/SyntaxHighlight_GeSHi/SyntaxHighlight_GeSHi.php");
$wgSyntaxHighlightDefaultLang = "php";
## Incorporation of the Collections extension (per http://www.mediawiki.org/wiki/Extension:Collection)
## and the help file at (http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Collection/README.txt)
## also see http://edutechwiki.unige.ch/en/Mediawiki_collection_extension_installation#Collection_extension_installation
#require_once("$IP/extensions/Collection/Collection.php");
#$wgCollectionMWServeURL = "http://tools.pediapress.com/mw-serve/";
/** Login credentials to this MediaWiki as 'USERNAME:PASSWORD' string */
#$wgCollectionMWServeCredentials = 'Transfer:transfer_mojo';
## Incorporation of the Renameuser extension (per http://www.mediawiki.org/wiki/Extension:Renameuser)
require_once("$IP/extensions/Renameuser/SpecialRenameuser.php");
## Incorporation of the Replace Text (useful for page renames, for example) extension (per http://www.mediawiki.org/wiki/Extension:Replace_Text)
require_once( "$IP/extensions/ReplaceText/ReplaceText.php" );
$wgGroupPermissions['sysop']['replacetext'] = true;
## Incorporation of the SimpleSecurity extension (per http://www.mediawiki.org/wiki/Extension:SimpleSecurity)
$wgSecurityUseDBHook = true; # this directive MUST be used before the extension include
require_once("{$IP}/extensions/SimpleSecurity/SimpleSecurity.php");
$wgPageRestrictions['Category:Restrict']['read'] = array('sysop', 'bureaucrat');
$wgPageRestrictions['Category:Restrict']['edit'] = array('sysop');
#require_once("extensions/PdfExport/PdfExport.php");
#$wgPdfExportBackground = "path/to/the/background-image/image.jpg";
## Choose one of the following two rich-text editors, OR neither:
## Incorporation of the FCKeditor
#require_once( "$IP/extensions/FCKeditor/FCKeditor.php" );
## Incorporation of the WYSIWYG extension (CKEditor, used in Semantic Halo)
require_once("$IP/extensions/WYSIWYG/WYSIWYG.php");
$wgGroupPermissions['registered_users']['wysiwyg']=true;
