getLocalUrl instead of escapeLocalUrl
[mediawiki.git] / LocalSettings.sample
blob3046303351d93a57b89f1e50d3a20c2596961989
1 <?php
2 # Local settings work like this: the file LocalSettings.sample
3 # should be copied to LocalSettings.php in the source directory
4 # and edited for your local file system settings and software
5 # configuration preferences. The install script will copy it to
6 # the installation path, but a copy should also remain in the
7 # source tree so that maintenance scripts can refer to it (you
8 # may want to make it a symbolic link after installation). 
10 # Developers: Do not check LocalSettings.php into CVS! Make
11 # changes to LocalSettings.sample instead.
13 # Note that you will find many more settings in 
14 # includes/DefaultSettings.php - if you want to change any of
15 # them, copy the variables into LocalSettings.php, and change them
16 # here, otherwise your settings will be overwritten with your
17 # next update.
19 # The most important setting is here: $IP is the installation
20 # path for the software. In the example below, the htdocs
21 # dir should be set as the DocumentRoot in the httpd.conf 
22 # configuration file of Apache. To put it more simply:
23 # The directory below needs to be accessible in some way
24 # through your web browser.
26 $IP = "/usr/local/apache/htdocs/wiki";
29 ## Don't change this bit; install.php needs it.
31 if ( ! isset( $DP ) ) { $DP = $IP; }
32 include_once( "$DP/DefaultSettings.php" );
34 ## Please customize!
36 $wgSitename         = "MediaWiki";
38 # You can customize a lot of URLs and paths, but you will
39 # almost certainly want to customize the following.  The
41 # Normally the server will be auto-detected, but you can
42 # force the base URL. Don't forget http:// (or https://)!
44 #$wgServer           = "http://www.myhost.com";
46 ## The location of the main script, you need this to be correct!
48 $wgScriptPath       = "/wiki";
49 $wgScript           = "{$wgScriptPath}/index.php";
50 $wgRedirectScript   = "{$wgScriptPath}/redirect.php";
52 # ArticlePath one is especially useful if you want to use
53 # mod_redirect to make page-viewing URLs look static.
55 $wgArticlePath      = "{$wgScript}/$1";
56 # $wgArticlePath     = "/wiki/$1"; # Prettier if you're setup for it
58 ## Normally you don't need to change these once the above are set...
60 $wgStyleSheetPath   = "{$wgScriptPath}/style";
61 $wgStyleSheetDirectory = "{$IP}/style";
63 $wgUploadPath       = "{$wgScriptPath}/upload";
64 $wgUploadDirectory      = "{$IP}/upload";
65 $wgLogo                         = "{$wgUploadPath}/wiki.png";
67 ## Preferably these addresses should be able to receive mail asking for help
69 $wgEmergencyContact = "wikiadmin@" . getenv( "SERVER_NAME" );
70 $wgPasswordSender       = "Wikipedia Mail <apache@" . getenv( "SERVER_NAME" ) . ">";
72 # MySQL settings
74 # The user you specify here DOES NOT NEED TO EXIST.
75 # It is created by the installation script, if
76 # you have root privileges on your database.
78 # IF on the other hand you have only limited privs
79 # on your DB and have to do a manual install, use
80 # your existing username and password. Be sure this
81 # file doesn't get left around on the web legible...
83 # $wgDBsqluser is used for queries through the 
84 # web interface. It is also created by the script.
85 # Unlike the regular user, it has no write 
86 # permissions and can not access passwords.
88 $wgDBserver         = "localhost";
89 $wgDBname           = "wikidb";
90 $wgDBuser           = "wikiuser";
91 $wgDBpassword       = "userpass"; # Use a better password! ;)
92 $wgDBsqluser        = "sqluser";
93 $wgDBsqlpassword        = "sqlpass";
95 ## Advanced DB settings
97 $wgDBminWordLen         = 3;     # Match this to your MySQL fulltext
99 ## Set these to true to turn on some optimizations when using
100 ## MySQL 4.x:
102 # $wgDBmysql4                   = true;
103 # $wgEnablePersistentLC = true;
105 ## You can customize the interface messages through the wiki;
106 ## see [[MediaWiki:All pages]]. (This requires a sysop account.)
107 ## This causes a performance hit, though; if you don't need it,
108 ## feel free to turn it off:
110 # $wgUseDatabaseMessages = false;
112 ## Set $wgUseImageResize to true if you want to enable dynamic
113 ## server side image resizing ("Thumbnails")
115 # $wgUseImageResize             = true;
117 ## Resizing can be done using PHP's internal image libraries
118 ## or using ImageMagick. The later supports more file formats
119 ## than PHP, which only supports PNG, GIF, JPG, XBM and WBMP.
121 ## Set $wgUseImageMagick to true to use Image Magick instead
122 ## of the builtin functions
124 # $wgUseImageMagick             = true;
125 # $wgImageMagickConvertCommand    = "/usr/bin/convert";
127 ## If you have the appropriate support software installed
128 ## you can enable inline LaTeX equations:
129 # $wgUseTeX                     = true;
130 # $wgMathPath         = "{$wgUploadPath}/math";
131 # $wgMathDirectory    = "{$wgUploadDirectory}/math";
132 # $wgTmpDirectory     = "{$wgUploadDirectory}/tmp";
134 $wgLocalInterwiki   = $wgSitename;
136 ## If you want a non-English wiki, add a line like this
137 # $wgLanguageCode = "de";
139 ## Character encoding: normally auto-selected by the language.
140 ## English, German, Danish, Dutch, French, Spanish, and Swedish
141 ## will be in ISO-8859-1 by default, all other languages in
142 ## UTF-8 encoding. UTF-8 is more flexible, but some older browsers
143 ## have trouble with it. You can force an English-language wiki
144 ## to UTF-8 by uncommenting the lines below. The other languages
145 ## mentioned above might not work properly this way without
146 ## additional tweaking.
148 # $wgInputEncoding      = "UTF-8";
149 # $wgOutputEncoding     = "UTF-8";
151 ## Extremely high-traffic wikis may want to disable
152 ## some database-intensive features here:
154 # $wgDisableTextSearch = true;
155 # $wgDisableCounters = true;
156 # $wgMiserMode          = true;
158 ## The following three config variables are used to define
159 ## the rights of users in your system. 
161 # If wgWhitelistEdit is set to true, only logged in users
162 # are allowed to edit articles.
163 # If wgWhitelistRead is set to true, only logged in users
164 # are allowed to read articles.
166 # wgWhitelistAccount lists user types that can add user accounts:
167 # "key" => 1 defines permission if user has right "key".
169 # Typical setups are:
171 # Everything goes (this is the default behaviour):
172 # $wgWhitelistEdit = false;
173 # $wgWhitelistRead = false;
174 # $wgWhitelistAccount = array ( "user" => 1, "sysop" => 1, "developer" => 1 );
176 # Invitation-only closed shop type of system
177 # $wgWhitelistEdit = true;
178 # $wgWhitelistRead = true;
179 # $wgWhitelistAccount = array ( "user" => 0, "sysop" => 1, "developer" => 1 );
181 # Public website, closed editorial team
182 # $wgWhitelistEdit = true;
183 # $wgWhitelistRead = false;
184 # $wgWhitelistAccount = array ( "user" => 0, "sysop" => 1, "developer" => 1 );
187 # Squid-related settings
189 # Enable/disable Squid
190 # $wgUseSquid = true;
191 # If you run Squid3 with ESI support, enable this (default:false):
192 # $wgUseESI = true;
193 # Internal server name as known to Squid, if different
194 # $wgInternalServer = 'http://yourinternal.tld:8000';
195 # Cache timeout for the squid, will be sent as s-maxage (without ESI) or 
196 # Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in the Squid config.
197 # 18000 seconds = 5 hours, more cache hits with 2678400 = 31 days
198 # $wgSquidMaxage = 18000;
199 # A list of proxy servers (ips if possible) to purge on changes
200 # don't specify ports here (80 is default)
201 # $wgSquidServers = array('127.0.0.1');