LocalSettings.php

From OSF Wiki
Jump to: navigation, search

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 1.21.2
# 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

# Protect against web entry
if ( !defined( 'MEDIAWIKI' ) ) {
        exit;
}

## Uncomment this to disable output compression
# $wgDisableOutputCompression = true;

$wgSitename = "XXXXX";
$wgMetaNamespace = "XXXXX";

## 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
## (like /w/index.php/Page_title to /wiki/Page_title) please see:
## http://www.mediawiki.org/wiki/Manual:Short_URL
$wgScriptPath = "";
$wgScriptExtension = ".php";

## The protocol and server name to use in fully-qualified URLs
$wgServer = "XXXXX";

## The relative URL path to the skins directory
$wgStylePath = "$wgScriptPath/skins";

## The relative URL path to the logo.  Make sure you change this from the default,
## or else you'll overwrite your logo when you upgrade!
$wgLogo         = "$wgStylePath/common/images/wiki.png";
$wgFavicon      = "$wgStylePath/common/images/favicon.ico";

## UPO means: this is also a user preference option

$wgEnableEmail = false;
$wgEnableUserEmail = true; # UPO

$wgEmergencyContact = "XXXXX";
$wgPasswordSender = "XXXXX";

# During development, we limit access to the site using the following commands; comment out after dev:
# Disable for everyone.
$wgGroupPermissions['*']['read']          = false;
# Disable granting access to any user
$wgGroupPermissions['*']['createaccount'] = false;
$wgGroupPermissions['*']['edit']          = false;
$wgGroupPermissions['*']['createpage']    = false;
$wgGroupPermissions['*']['createtalk']    = false;

# But allow them to read the login page, and JS/CSS pages
$wgWhitelistRead = array( "Special:Userlogin", "-", "MediaWiki:Monobook.css" );

# After development, we use the following commands to control spam and such:
# 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;

$wgEnotifUserTalk = false; # UPO
$wgEnotifWatchlist = false; # UPO
$wgEmailAuthentication = true;

## Database settings
$wgDBtype = "mysql";
$wgDBserver = "localhost";
$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=utf8";

# Experimental charset support for MySQL 5.0.
$wgDBmysql5 = false;

## 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;
#$wgUseImageMagick = true;
#$wgImageMagickConvertCommand = "/usr/bin/convert";
$wgTmpDirectory = "$IP/images/temp";

# InstantCommons allows wiki to use images from http://commons.wikimedia.org
$wgUseInstantCommons = false;

## 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;
$wgEnableUploads       = true;
$wgUseImageResize      = true;
$wgVerifyMimeType      = false;
$wgFileExtensions      = array('png', 'gif', 'jpg', 'jpeg', 'doc', 'docx', 'xls', 'xlsx', 'pdf', 'ppt', 'pptx', 'zip', 'svg');
$wgAllowExternalImages = true;

## Set $wgCacheDirectory to a writable directory on the web server
## to make your wiki go slightly faster. The directory should not
## be publically accessible from the web.
#$wgCacheDirectory = "$IP/cache";

# Site language code, should be one of the list in ./languages/Names.php
$wgLanguageCode = "en";

$wgSecretKey = "XXXXX";

# Site upgrade key. Must be set to a string (default provided) to turn on the
# web installer while LocalSettings.php is in place
$wgUpgradeKey = "XXXXX";

## Default skin: you can change the default skin. Use the internal symbolic
## names, ie 'standard', 'nostalgia', 'cologneblue', 'monobook', 'vector':
$wgDefaultSkin = "vector";

## 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.
$wgRightsPage = ""; # Set to the title of a wiki page that describes your license/copyright
$wgRightsUrl = "http://creativecommons.org/licenses/by-sa/3.0/";
$wgRightsText = "Creative Commons Attribution Share Alike";
$wgRightsIcon = "{$wgStylePath}/common/images/cc-by-sa.png";

# Path to the GNU diff3 utility. Used for conflict resolution.
$wgDiff3 = "/usr/bin/diff3";

# Query string length limit for ResourceLoader. You should only set this if
# your web server has a query string length limit (then set it to that limit),
# or if you have suhosin.get.max_value_length set in php.ini (then set it to
# that value)
$wgResourceLoaderMaxQueryLength = -1;

# Enabled Extensions. Most extensions are enabled by including the base extension file here
# but check specific extension documentation for more details
# The following extensions were automatically enabled:
require_once( "$IP/extensions/Cite/Cite.php" );
require_once( "$IP/extensions/SyntaxHighlight_GeSHi/SyntaxHighlight_GeSHi.php" );
require_once( "$IP/extensions/Vector/Vector.php" );
require_once( "$IP/extensions/WikiEditor/WikiEditor.php" );

# End of automatically generated settings.
# Add more configuration options below.

## Incorporation of the AnyWeb extension (per http://www.mediawiki.org/wiki/Extension:Anysite)
include("extensions/anywebsite.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 ManageCategories extension (per http://www.mediawiki.org/wiki/Extension:ManageCategories)
require_once("$IP/extensions/managecategories/managecategories.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 Renameuser extension (per http://www.mediawiki.org/wiki/Extension:Renameuser)
require_once("$IP/extensions/Renameuser/SpecialRenameuser.php");