| 1 | # Configuration of Foswiki - The Free and Open Source Wiki, http://foswiki.org/ |
|---|
| 2 | # See bottom of file for license and copyright information. |
|---|
| 3 | |
|---|
| 4 | # This specification file is held in 'foswiki/lib' directory. DO NOT EDIT |
|---|
| 5 | # THIS FILE! |
|---|
| 6 | |
|---|
| 7 | # DO NOT COPY THIS FILE TO LocalSite.cfg - Run configure from your browser |
|---|
| 8 | # which will guess required settings, merge the files and write a new |
|---|
| 9 | # LocalSite.cfg. |
|---|
| 10 | |
|---|
| 11 | # If for some reason you still want to copy this file to LocalSite.cfg, you |
|---|
| 12 | # must un-comment and complete the 10 PATH and URLPATH settings that are flagged |
|---|
| 13 | # as Mandatory ( M** ) and remove the __DATA__ line toward the end of the file. |
|---|
| 14 | |
|---|
| 15 | # Manually building LocalSite.cfg is STRONGLY DISCOURAGED. |
|---|
| 16 | |
|---|
| 17 | # See 'setlib.cfg' in the 'bin' directory for how to configure a non-standard |
|---|
| 18 | # include path for Perl modules. |
|---|
| 19 | # |
|---|
| 20 | # Note that the comments in this file are formatted specifically so |
|---|
| 21 | # that the 'configure' script can extract documentation from here. See |
|---|
| 22 | # http://foswiki.org/System/DevelopingPlugins#Integrating_with_configure |
|---|
| 23 | # for details of the syntax used. |
|---|
| 24 | # |
|---|
| 25 | # NOTE FOR DEVELOPERS: you can use $Foswiki::cfg variables in other settings, |
|---|
| 26 | # but you must be sure they are only evaluated under program control and |
|---|
| 27 | # not when this file is loaded. For example: |
|---|
| 28 | ## $Foswiki::cfg{Blah} = "$Foswiki::cfg{DataDir}/blah.dat"; # BAD |
|---|
| 29 | ## $Foswiki::cfg{Blah} = '$Foswiki::cfg{DataDir}/blah.dat'; # GOOD |
|---|
| 30 | |
|---|
| 31 | # Note that the general path settings are deliberately commented out. |
|---|
| 32 | # This is because they *must* be defined in LocalSite.cfg, and *not* here. |
|---|
| 33 | |
|---|
| 34 | #---+ General path settings |
|---|
| 35 | # <p><strong>If you are a first-time installer:</strong> once you have set |
|---|
| 36 | # up the eight paths below, your wiki should work - try it. You can |
|---|
| 37 | # always come back and tweak other settings later.</p> |
|---|
| 38 | # <p><b>Security Note:</b> Only the URL paths listed below should |
|---|
| 39 | # be browseable from the web. If you expose any other directories (such as |
|---|
| 40 | # lib or templates) you are opening up routes for possible hacking attempts.</p> |
|---|
| 41 | |
|---|
| 42 | # **URL M** |
|---|
| 43 | # This is the root of all Foswiki URLs e.g. http://myhost.com:123. |
|---|
| 44 | # $Foswiki::cfg{DefaultUrlHost} = 'http://your.domain.com'; |
|---|
| 45 | |
|---|
| 46 | # **STRING** |
|---|
| 47 | # If your host has aliases (such as both www.mywiki.net and mywiki.net |
|---|
| 48 | # and some IP addresses) you need to tell Foswiki that redirecting to them |
|---|
| 49 | # is OK. Foswiki uses redirection as part of its normal mode of operation |
|---|
| 50 | # when it changes between editing and viewing. |
|---|
| 51 | # To prevent Foswiki from being used in phishing attacks and to protect it |
|---|
| 52 | # from middleman exploits, the security setting {AllowRedirectUrl} is by |
|---|
| 53 | # default disabled, restricting redirection to other domains. If a redirection |
|---|
| 54 | # to a different host is attempted, the target URL is compared against this |
|---|
| 55 | # list of additional trusted sites, and only if it matches is the redirect |
|---|
| 56 | # permitted.<br /> |
|---|
| 57 | # Enter as a comma separated list of URLs (protocol, hostname and (optional) |
|---|
| 58 | # port) e.g. <code>http://your.domain.com:8080,https://other.domain.com</code> |
|---|
| 59 | $Foswiki::cfg{PermittedRedirectHostUrls} = ''; |
|---|
| 60 | |
|---|
| 61 | # **URLPATH M** |
|---|
| 62 | # This is the 'cgi-bin' part of URLs used to access the Foswiki bin |
|---|
| 63 | # directory e.g. <code>/foswiki/bin</code><br /> |
|---|
| 64 | # Do <b>not</b> include a trailing /. |
|---|
| 65 | # <p /> |
|---|
| 66 | # See <a href="http://foswiki.org/Support/ShorterUrlCookbook" target="_new">ShorterUrlCookbook</a> for more information on setting up |
|---|
| 67 | # Foswiki to use shorter script URLs. Expand expert settings to get to settings for the <code>view</code> script. Other scripts need to |
|---|
| 68 | # be manually added to <code>lib/LocalSite.cfg</code> |
|---|
| 69 | # $Foswiki::cfg{ScriptUrlPath} = '/foswiki/bin'; |
|---|
| 70 | |
|---|
| 71 | # **URLPATH M** |
|---|
| 72 | # This is the complete path used to access the Foswiki view script including any suffix. Do not include a trailing /. |
|---|
| 73 | # (This is an exception override, so the ScriptSuffix is not automatically added.) |
|---|
| 74 | # e.g. <code>/foswiki/bin/view.pl</code><br /> Note: The default is acceptable except when shorter URLs are used. |
|---|
| 75 | # <p /> |
|---|
| 76 | # If you are using Shorter URL's, then this is typically set to the base path of your wiki, which should be the value |
|---|
| 77 | # of {ScriptUrlPath} excluding <code>/bin</code>. e.g. if your {ScriptUrlPath} is either empty or set to <code>/bin</code> leave |
|---|
| 78 | # <code>{ScriptUrlPaths}{view}</code> empty; if it is set to something like <code>/directory/bin</code> set it to <code>/directory</code> |
|---|
| 79 | # <p /> |
|---|
| 80 | # Do not change |
|---|
| 81 | # this unless your Web Server configuration has been set to use shorter URLs. See also the Foswiki |
|---|
| 82 | # <a href="http://foswiki.org/Support/ApacheConfigGenerator" target="_new">Apache Config Generator</a> and |
|---|
| 83 | # <a href="http://foswiki.org/Support/ShorterUrlCookbook" target="_new">Shorter URL Cookbook</a> |
|---|
| 84 | $Foswiki::cfg{ScriptUrlPaths}{view} = '$Foswiki::cfg{ScriptUrlPath}/view$Foswiki::cfg{ScriptSuffix}'; |
|---|
| 85 | |
|---|
| 86 | # **PATH M** |
|---|
| 87 | # This is the file system path used to access the Foswiki bin |
|---|
| 88 | # directory. |
|---|
| 89 | # $Foswiki::cfg{ScriptDir} = '/home/httpd/foswiki/bin'; |
|---|
| 90 | |
|---|
| 91 | # **URLPATH M** |
|---|
| 92 | # Attachments URL path e.g. /foswiki/pub |
|---|
| 93 | # <p /><b>Security Note:</b> files in this directory are *not* |
|---|
| 94 | # protected by Foswiki access controls. If you require access controls, you |
|---|
| 95 | # will have to use webserver controls (e.g. .htaccess on Apache) |
|---|
| 96 | # $Foswiki::cfg{PubUrlPath} = '/foswiki/pub'; |
|---|
| 97 | |
|---|
| 98 | # **NUMBER EXPERT** |
|---|
| 99 | # This is the maximum number of files and directories that will be checked |
|---|
| 100 | # for permissions for the pub and data Directory paths. This limit is initially set to |
|---|
| 101 | # 4200, which should be reasonable for a default installation. If it is |
|---|
| 102 | # exceeded, then an informational message is returned stating that incomplete |
|---|
| 103 | # checking was performed. If this is set to a large number on large installations, |
|---|
| 104 | # then a significant delay will be incurred when configure is run, due to the |
|---|
| 105 | # recursive directory checking. |
|---|
| 106 | $Foswiki::cfg{PathCheckLimit} = 4200; |
|---|
| 107 | |
|---|
| 108 | # **PATH M** |
|---|
| 109 | # Attachments store (file path, not URL), must match /foswiki/pub e.g. |
|---|
| 110 | # /usr/local/foswiki/pub |
|---|
| 111 | # $Foswiki::cfg{PubDir} = '/home/httpd/foswiki/pub'; |
|---|
| 112 | |
|---|
| 113 | # **PATH M** |
|---|
| 114 | # Topic files store (file path, not URL) e.g. /usr/local/foswiki/data |
|---|
| 115 | # $Foswiki::cfg{DataDir} = '/home/httpd/foswiki/data'; |
|---|
| 116 | |
|---|
| 117 | # **PATH M** |
|---|
| 118 | # Tools directory e.g. /usr/local/foswiki/tools |
|---|
| 119 | # $Foswiki::cfg{ToolsDir} = '/home/httpd/foswiki/tools'; |
|---|
| 120 | |
|---|
| 121 | # **PATH M** |
|---|
| 122 | # Template directory e.g. /usr/local/foswiki/templates |
|---|
| 123 | # $Foswiki::cfg{TemplateDir} = '/home/httpd/foswiki/templates'; |
|---|
| 124 | |
|---|
| 125 | # **PATH M** |
|---|
| 126 | # Translation files directory (file path, not URL) e.g. /usr/local/foswiki/locale |
|---|
| 127 | # $Foswiki::cfg{LocalesDir} = '/home/httpd/foswiki/locale'; |
|---|
| 128 | |
|---|
| 129 | # **PATH M** |
|---|
| 130 | # Directory where Foswiki stores files that are required for the management |
|---|
| 131 | # of Foswiki, but are not required to be browsed from the web. |
|---|
| 132 | # A number of subdirectories will be created automatically under this |
|---|
| 133 | # directory: |
|---|
| 134 | # <ul><li>{WorkingDir}<tt>/tmp</tt> - used for security-related temporary |
|---|
| 135 | # files (these files can be deleted at any time without permanent damage) |
|---|
| 136 | # <ul><li> |
|---|
| 137 | # <i>Passthrough files</i> are used by Foswiki to work around the limitations |
|---|
| 138 | # of HTTP when redirecting URLs</li> |
|---|
| 139 | # <li><i>Session files</i> are used to record information about active |
|---|
| 140 | # users - for example, whether they are logged in or not.</li> |
|---|
| 141 | # </ul> |
|---|
| 142 | # For obvious reasons, these files must <b>not</b> be browseable from the web! |
|---|
| 143 | # Additionally you are recommended to restrict access rights to this directory |
|---|
| 144 | # so only the web server user can create files.</li> |
|---|
| 145 | # <li>{WorkingDir}<tt>/work_areas</tt> - these are work areas used by |
|---|
| 146 | # extensions that need to store data on the disc </li> |
|---|
| 147 | # <li>{WorkingDir}<tt>/registration_approvals</tt> - this is used by the |
|---|
| 148 | # default Foswiki registration process to store registrations that are pending |
|---|
| 149 | # verification.</li> |
|---|
| 150 | # </ul> |
|---|
| 151 | # $Foswiki::cfg{WorkingDir} = '/home/httpd/foswiki/working'; |
|---|
| 152 | |
|---|
| 153 | # **STRING 10** |
|---|
| 154 | # Suffix of Foswiki CGI scripts (e.g. .cgi or .pl). You may need to set this |
|---|
| 155 | # if your webserver requires an extension. |
|---|
| 156 | $Foswiki::cfg{ScriptSuffix} = ''; |
|---|
| 157 | |
|---|
| 158 | # **STRING 20 EXPERT** |
|---|
| 159 | # {OS} and {DetailedOS} are calculated in the Foswiki code. <b>You |
|---|
| 160 | # should only need to override if there is something badly wrong with |
|---|
| 161 | # those calculations.</b><br /> |
|---|
| 162 | # {OS} may be one of UNIX WINDOWS VMS DOS MACINTOSH OS2 |
|---|
| 163 | $Foswiki::cfg{OS} = ''; |
|---|
| 164 | # **STRING 20 EXPERT** |
|---|
| 165 | # The value of Perl $OS |
|---|
| 166 | $Foswiki::cfg{DetailedOS} = ''; |
|---|
| 167 | |
|---|
| 168 | #---+ Security and Authentication -- TABS |
|---|
| 169 | # <p>In order to support tracking who changed what, and apply access controls, |
|---|
| 170 | # Foswiki is normally configured to use logins. The tabs below control |
|---|
| 171 | # various aspects of logins.</p> |
|---|
| 172 | #---++ Sessions |
|---|
| 173 | # <p>Sessions are how Foswiki tracks a user across multiple requests. |
|---|
| 174 | # A user's session id is stored in a cookie, and this is used to identify |
|---|
| 175 | # the user for each request they make to the server. |
|---|
| 176 | # You can use sessions even if you are not using login. |
|---|
| 177 | # This allows you to have persistent session variables - for example, skins. |
|---|
| 178 | # Client sessions are not required for logins to work, but Foswiki will not |
|---|
| 179 | # be able to remember logged-in users consistently. |
|---|
| 180 | # See <a href="http://foswiki.org/System/UserAuthentication" target="_new">User |
|---|
| 181 | # Authentication</a> for a full discussion of the pros and |
|---|
| 182 | # cons of using persistent sessions.</p> |
|---|
| 183 | |
|---|
| 184 | # **BOOLEAN** |
|---|
| 185 | # Control whether Foswiki will use persistent sessions. |
|---|
| 186 | $Foswiki::cfg{UseClientSessions} = 1; |
|---|
| 187 | |
|---|
| 188 | # **STRING 20** |
|---|
| 189 | # Set the session timeout, in seconds. The session will be cleared after this |
|---|
| 190 | # amount of time without the session being accessed. The default is 6 hours |
|---|
| 191 | # (21600 seconds).<p /> |
|---|
| 192 | # <b>Note</b> By default, session expiry is done "on the fly" by the same |
|---|
| 193 | # processes used to |
|---|
| 194 | # serve Foswiki requests. As such it imposes a load on the server. When |
|---|
| 195 | # there are very large numbers of session files, this load can become |
|---|
| 196 | # significant. For best performance, you can set {Sessions}{ExpireAfter} |
|---|
| 197 | # to a negative number, which will mean that Foswiki won't try to clean |
|---|
| 198 | # up expired sessions using CGI processes. Instead you should use a cron |
|---|
| 199 | # job to clean up expired sessions. The standard maintenance cron script |
|---|
| 200 | # <tt>tools/tick_foswiki.pl</tt> includes this function. |
|---|
| 201 | # <p /> Session files are stored in the <tt>{WorkingDir}/tmp</tt> directory. |
|---|
| 202 | $Foswiki::cfg{Sessions}{ExpireAfter} = 21600; |
|---|
| 203 | |
|---|
| 204 | # **NUMBER EXPERT** |
|---|
| 205 | # TemplateLogin only. |
|---|
| 206 | # Normally the cookie that remembers a user session is set to expire |
|---|
| 207 | # when the browser exits, but using this value you can make the cookie |
|---|
| 208 | # expire after a set number of seconds instead. If you set it then |
|---|
| 209 | # users will be able to tick a 'Remember me' box when logging in, and |
|---|
| 210 | # their session cookie will be remembered even if the browser exits.<p /> |
|---|
| 211 | # This should always be the same as, or longer than, {Sessions}{ExpireAfter}, |
|---|
| 212 | # otherwise Foswiki may delete the session from its memory even though the |
|---|
| 213 | # cookie is still active.<p /> |
|---|
| 214 | # A value of 0 will cause the cookie to expire when the browser exits. |
|---|
| 215 | # One month is roughly equal to 2600000 seconds. |
|---|
| 216 | $Foswiki::cfg{Sessions}{ExpireCookiesAfter} = 0; |
|---|
| 217 | |
|---|
| 218 | # **BOOLEAN EXPERT** |
|---|
| 219 | # If you have persistent sessions enabled, then Foswiki will use a cookie in |
|---|
| 220 | # the browser to store the session ID. If the client has cookies disabled, |
|---|
| 221 | # then Foswiki will not be able to record the session. As a fallback, Foswiki |
|---|
| 222 | # can rewrite local URLs to pass the session ID as a parameter to the URL. |
|---|
| 223 | # This is a potential security risk, because it increases the chance of a |
|---|
| 224 | # session ID being stolen (accidentally or intentionally) by another user. |
|---|
| 225 | # If this is turned off, users with cookies disabled will have to |
|---|
| 226 | # re-authenticate for every secure page access (unless you are using |
|---|
| 227 | # {Sessions}{MapIP2SID}). |
|---|
| 228 | $Foswiki::cfg{Sessions}{IDsInURLs} = 0; |
|---|
| 229 | |
|---|
| 230 | # **BOOLEAN EXPERT** |
|---|
| 231 | # It is possible to enable a check that the user trying to use a session |
|---|
| 232 | # is on the same IP address that was used when the session was created. |
|---|
| 233 | # This gives a small increase in security. Public web sites can easily be |
|---|
| 234 | # accessed by different users from the same IP address when they access |
|---|
| 235 | # through the same proxy gateway, meaning that the protection is limited. |
|---|
| 236 | # Additionally, people get more and more mobile using a mix of LAN, WLAN, |
|---|
| 237 | # and 3G modems and they will often change IP address several times per day. |
|---|
| 238 | # For these users IP matching causes the need to re-authenticate all the time. |
|---|
| 239 | # IP matching is therefore disabled by default and should only be enabled if |
|---|
| 240 | # you are sure the users IP address never changes during the lifetime of a |
|---|
| 241 | # session. |
|---|
| 242 | $Foswiki::cfg{Sessions}{UseIPMatching} = 0; |
|---|
| 243 | |
|---|
| 244 | # **BOOLEAN EXPERT** |
|---|
| 245 | # For compatibility with older versions, Foswiki supports the mapping of the |
|---|
| 246 | # clients IP address to a session ID. You can only use this if all |
|---|
| 247 | # client IP addresses are known to be unique. |
|---|
| 248 | # If this option is enabled, Foswiki will <b>not</b> store cookies in the |
|---|
| 249 | # browser. |
|---|
| 250 | # The mapping is held in the file $Foswiki::cfg{WorkingDir}/tmp/ip2sid. |
|---|
| 251 | # If you turn this option on, you can safely turn {Sessions}{IDsInURLs} |
|---|
| 252 | # <i>off</i>. |
|---|
| 253 | $Foswiki::cfg{Sessions}{MapIP2SID} = 0; |
|---|
| 254 | |
|---|
| 255 | # **STRING 20 EXPERT** |
|---|
| 256 | # By default the Foswiki session cookie is only accessible by the host which |
|---|
| 257 | # sets it. To change the scope of this cookie you can set this to any other |
|---|
| 258 | # value (ie. company.com). Make sure, Foswiki can access its own cookie. <br /> |
|---|
| 259 | # If empty, this defaults to the current host. |
|---|
| 260 | $Foswiki::cfg{Sessions}{CookieRealm} = ''; |
|---|
| 261 | |
|---|
| 262 | # **SELECT strikeone,embedded,none ** |
|---|
| 263 | # <p>By default Foswiki uses Javascript to perform "double submission" validation |
|---|
| 264 | # of browser requests. This technique, called "strikeone", is highly |
|---|
| 265 | # recommended for the prevention of cross-site request forgery (CSRF). See also |
|---|
| 266 | # <a href="http://foswiki.org/Support/WhyYouAreAskedToConfirm" target="_new"> |
|---|
| 267 | # Why am I being asked to confirm?</a>.</p> |
|---|
| 268 | # <p>If Javascript is known not to be available in browsers that use the site, |
|---|
| 269 | # or cookies are disabled, but you still want validation of submissions, |
|---|
| 270 | # then you can fall back on a embedded-key validation technique that |
|---|
| 271 | # is less secure, but still offers some protection against CSRF. Both |
|---|
| 272 | # validation techniques rely on user verification of "suspicious" |
|---|
| 273 | # transactions.</p> |
|---|
| 274 | # <p>This option allows you to select which validation technique will be |
|---|
| 275 | # used.<br /> |
|---|
| 276 | # If it is set to "strikeone", or is undefined, 0, or the empty string, then |
|---|
| 277 | # double-submission using Javascript will be used.<br /> |
|---|
| 278 | # If it is set to "embedded", then embedded validation keys will be used.<br/> |
|---|
| 279 | # If it is set to "none", then no validation of posted requests will |
|---|
| 280 | # be performed.</p> |
|---|
| 281 | $Foswiki::cfg{Validation}{Method} = 'strikeone'; |
|---|
| 282 | |
|---|
| 283 | # **NUMBER EXPERT** |
|---|
| 284 | # Validation keys are stored for a maximum of this amount of time before |
|---|
| 285 | # they are invalidated. Time in seconds. |
|---|
| 286 | $Foswiki::cfg{Validation}{ValidForTime} = 3600; |
|---|
| 287 | |
|---|
| 288 | # **NUMBER EXPERT** |
|---|
| 289 | # The maximum number of validation keys to store in a session. There is one |
|---|
| 290 | # key stored for each page rendered. If the number of keys exceeds this |
|---|
| 291 | # number, the oldest keys will be force-expired to bring the number down. |
|---|
| 292 | $Foswiki::cfg{Validation}{MaxKeysPerSession} = 1000; |
|---|
| 293 | |
|---|
| 294 | # **BOOLEAN EXPERT** |
|---|
| 295 | # Expire a validation key immediately when it is used to validate the saving |
|---|
| 296 | # of a page. This protects against an attacker evesdropping the communication |
|---|
| 297 | # between browser and server and exploiting the keys sent from browser to |
|---|
| 298 | # server. If this is enabled and a user edits and saves a page, and then goes |
|---|
| 299 | # back to the edit screen using the browser back button and saves again, they |
|---|
| 300 | # will be met by a warning screen against "Suspicious request from |
|---|
| 301 | # browser". The same warning will be displayed if you build an application with |
|---|
| 302 | # pages containing multiple forms and users try to submit from these |
|---|
| 303 | # forms more than once. If this warning screen is a problem for your users, you |
|---|
| 304 | # can disable this setting which enables reuse of validation keys. |
|---|
| 305 | # However this will lower the level of security against cross-site request |
|---|
| 306 | # forgery. |
|---|
| 307 | $Foswiki::cfg{Validation}{ExpireKeyOnUse} = 1; |
|---|
| 308 | |
|---|
| 309 | #---++ Login |
|---|
| 310 | # <p>Foswiki supports different ways of handling how a user asks, or is asked, |
|---|
| 311 | # to log in.</p> |
|---|
| 312 | # **SELECTCLASS none,Foswiki::LoginManager::*Login** |
|---|
| 313 | # <ol><li> |
|---|
| 314 | # none - Don't support logging in, all users have access to everything. |
|---|
| 315 | # </li><li> |
|---|
| 316 | # Foswiki::LoginManager::TemplateLogin - Redirect to the login template, which |
|---|
| 317 | # asks for a username and password in a form. Does not cache the ID in |
|---|
| 318 | # the browser, so requires client sessions to work. |
|---|
| 319 | # </li><li> |
|---|
| 320 | # Foswiki::LoginManager::ApacheLogin - Redirect to an '...auth' script for which |
|---|
| 321 | # Apache can be configured to ask for authorization information. Does |
|---|
| 322 | # not require client sessions, but works best with them enabled. |
|---|
| 323 | # </li></ol> |
|---|
| 324 | $Foswiki::cfg{LoginManager} = 'Foswiki::LoginManager::TemplateLogin'; |
|---|
| 325 | |
|---|
| 326 | # **STRING 100** |
|---|
| 327 | # Comma-separated list of scripts in the bin directory that require the user to |
|---|
| 328 | # authenticate. This setting is used with TemplateLogin; any time an |
|---|
| 329 | # unauthenticated user attempts to access one of these scripts, they will be |
|---|
| 330 | # required to authenticate. With ApacheLogin, the web server must be configured |
|---|
| 331 | # to require a valid user for access to these scripts. |
|---|
| 332 | $Foswiki::cfg{AuthScripts} = 'attach,edit,manage,rename,save,upload,viewauth,rdiffauth,rest'; |
|---|
| 333 | |
|---|
| 334 | # **BOOLEAN EXPERT** |
|---|
| 335 | # Browsers typically remember your login and passwords to make authentication |
|---|
| 336 | # more convenient for users. If your Foswiki is used on public terminals, |
|---|
| 337 | # you can prevent this, forcing the user to enter the login and password |
|---|
| 338 | # every time. |
|---|
| 339 | $Foswiki::cfg{TemplateLogin}{PreventBrowserRememberingPassword} = 0; |
|---|
| 340 | |
|---|
| 341 | # **REGEX EXPERT** |
|---|
| 342 | # The perl regular expression used to constrain user login names. Some |
|---|
| 343 | # environments may require funny characters in login names, such as \. |
|---|
| 344 | # This is a filter <b>in</b> expression i.e. a login name must match this |
|---|
| 345 | # expression or an error will be thrown and the login denied. |
|---|
| 346 | $Foswiki::cfg{LoginNameFilterIn} = qr/^[^\s\*?~^\$@%`"'&;|<>\x00-\x1f]+$/; |
|---|
| 347 | |
|---|
| 348 | # **STRING 20 EXPERT** |
|---|
| 349 | # Guest user's login name. You are recommended not to change this. |
|---|
| 350 | $Foswiki::cfg{DefaultUserLogin} = 'guest'; |
|---|
| 351 | |
|---|
| 352 | # **STRING 20 EXPERT** |
|---|
| 353 | # Guest user's wiki name. You are recommended not to change this. |
|---|
| 354 | $Foswiki::cfg{DefaultUserWikiName} = 'WikiGuest'; |
|---|
| 355 | |
|---|
| 356 | # **STRING 20 EXPERT** |
|---|
| 357 | # An internal admin user login name (matched with the configure password, if set) |
|---|
| 358 | # which can be used as a temporary Admin login (see: Main.AdminUser). |
|---|
| 359 | # This login name is additionally required by the install script for some addons |
|---|
| 360 | # and plugins, usually to gain write access to the Foswiki web. |
|---|
| 361 | # If you change this you risk making topics uneditable. |
|---|
| 362 | $Foswiki::cfg{AdminUserLogin} = 'admin'; |
|---|
| 363 | |
|---|
| 364 | # **STRING 20 EXPERT** |
|---|
| 365 | # An admin user WikiName what is displayed for actions done by the AdminUserLogin |
|---|
| 366 | # You should normally not need to change this. (You will need to move the |
|---|
| 367 | # %USERSWEB%.AdminUser topic to match.) |
|---|
| 368 | $Foswiki::cfg{AdminUserWikiName} = 'AdminUser'; |
|---|
| 369 | |
|---|
| 370 | # **STRING 20 EXPERT** |
|---|
| 371 | # Group of users that can use special action=repRev and action=delRev |
|---|
| 372 | # on <code>save</code> and ALWAYS have edit powers. See %SYSTEMWEB%.CompleteDocumentation |
|---|
| 373 | # for an explanation of wiki groups. This user will also run all the |
|---|
| 374 | # standard cron jobs, such as statistics and mail notification. |
|---|
| 375 | # The default value "AdminGroup" is used everywhere in Foswiki to |
|---|
| 376 | # protect important settings so you would need a really special reason to |
|---|
| 377 | # change this setting. |
|---|
| 378 | $Foswiki::cfg{SuperAdminGroup} = 'AdminGroup'; |
|---|
| 379 | |
|---|
| 380 | # **STRING 20 EXPERT** |
|---|
| 381 | # Name of topic in the {UsersWebName} web where registered users |
|---|
| 382 | # are listed. Automatically maintained by the standard |
|---|
| 383 | # registration scripts. <b>If you change this setting you will have to |
|---|
| 384 | # use Foswiki to manually rename the existing topic</b> |
|---|
| 385 | $Foswiki::cfg{UsersTopicName} = 'WikiUsers'; |
|---|
| 386 | |
|---|
| 387 | # **STRING 80 EXPERT** |
|---|
| 388 | # Authentication realm. This is |
|---|
| 389 | # normally only used in md5 password encoding. You may need to change it |
|---|
| 390 | # if you are sharing a password file with another application. |
|---|
| 391 | $Foswiki::cfg{AuthRealm} = 'Enter your WikiName. (First name and last name, no space, no dots, capitalized, e.g. JohnSmith). Cancel to register if you do not have one.'; |
|---|
| 392 | |
|---|
| 393 | # **SELECTCLASS Foswiki::Users::*UserMapping** |
|---|
| 394 | # The user mapping is used to equate login names, used with external |
|---|
| 395 | # authentication systems, with Foswiki user identities. |
|---|
| 396 | # By default only |
|---|
| 397 | # two mappings are available, though other mappings *may* be installed to |
|---|
| 398 | # support authentication providers. |
|---|
| 399 | # <ol><li> |
|---|
| 400 | # Foswiki::Users::TopicUserMapping - uses Foswiki user and group topics to |
|---|
| 401 | # determine user information, and group memberships. |
|---|
| 402 | # </li><li> |
|---|
| 403 | # Foswiki::Users::BaseUserMapping - has only pseudo users such as {AdminUser} and |
|---|
| 404 | # {DefaultUserWikiName}, with the Admins login and password being set from this |
|---|
| 405 | # configure script. <b>Does not support User registration</b>, and |
|---|
| 406 | # only works with TemplateLogin. |
|---|
| 407 | # </li></ol> |
|---|
| 408 | $Foswiki::cfg{UserMappingManager} = 'Foswiki::Users::TopicUserMapping'; |
|---|
| 409 | |
|---|
| 410 | #---++ Passwords |
|---|
| 411 | # <p>The password manager handles the passwords database, and provides |
|---|
| 412 | # password lookup, and optionally password change, services to the rest of |
|---|
| 413 | # Foswiki.</p> |
|---|
| 414 | # **SELECTCLASS none,Foswiki::Users::*User** |
|---|
| 415 | # Name of the password handler implementation. Foswiki ships with two alternative implementations: |
|---|
| 416 | # <ol><li> |
|---|
| 417 | # Foswiki::Users::HtPasswdUser - handles 'htpasswd' format files, with |
|---|
| 418 | # passwords encoded as per the HtpasswdEncoding |
|---|
| 419 | # </li><li> |
|---|
| 420 | # Foswiki::Users::ApacheHtpasswdUser - should behave identically to |
|---|
| 421 | # HtpasswdUser, but uses the CPAN:Apache::Htpasswd package to interact |
|---|
| 422 | # with Apache. It is shipped mainly as a demonstration of how to write |
|---|
| 423 | # a new password manager. |
|---|
| 424 | # </li></ol> |
|---|
| 425 | # You can provide your own alternative by implementing a new subclass of |
|---|
| 426 | # Foswiki::Users::Password, and pointing {PasswordManager} at it in |
|---|
| 427 | # lib/LocalSite.cfg.<p /> |
|---|
| 428 | # If 'none' is selected, users will not be able to change passwords |
|---|
| 429 | # and TemplateLogin manager then will always succeed, regardless of |
|---|
| 430 | # what username or password they enter. This may be useful when you want to |
|---|
| 431 | # enable logins so Foswiki can identify contributors, but you don't care about |
|---|
| 432 | # passwords. Using ApacheLogin and PassordManager set to 'none' (and |
|---|
| 433 | # AllowLoginName = true) is a common Enterprise SSO configuration, in which |
|---|
| 434 | # any logged in user can then register to create their Foswiki Based identity. |
|---|
| 435 | $Foswiki::cfg{PasswordManager} = 'Foswiki::Users::HtPasswdUser'; |
|---|
| 436 | |
|---|
| 437 | # **NUMBER** |
|---|
| 438 | # Minimum length for a password, for new registrations and password changes. |
|---|
| 439 | # If you want to allow null passwords, set this to 0. |
|---|
| 440 | $Foswiki::cfg{MinPasswordLength} = 7; |
|---|
| 441 | |
|---|
| 442 | # **PATH** |
|---|
| 443 | # Path to the file that stores passwords, for the Foswiki::Users::HtPasswdUser |
|---|
| 444 | # password manager. You can use the <tt>htpasswd</tt> Apache program to create a new |
|---|
| 445 | # password file with the right encoding. |
|---|
| 446 | $Foswiki::cfg{Htpasswd}{FileName} = '$Foswiki::cfg{DataDir}/.htpasswd'; |
|---|
| 447 | |
|---|
| 448 | # **SELECT crypt,sha1,md5,plain,crypt-md5** |
|---|
| 449 | # Password encryption, for the Foswiki::Users::HtPasswdUser password manager. |
|---|
| 450 | # You can use the <tt>htpasswd</tt> Apache program to create a new |
|---|
| 451 | # password file with the right encoding. |
|---|
| 452 | # <dl> |
|---|
| 453 | # <dt>crypt</dt><dd>is the default, and should be used on Linux/Unix.</dd> |
|---|
| 454 | # <dt>sha1</dt><dd> is recommended for use on Windows.</dd> |
|---|
| 455 | # <dt>md5</dt><dd> htdigest format - useful on sites where password files are required |
|---|
| 456 | # to be portable. In this case, the {AuthRealm} is used with the username |
|---|
| 457 | # and password to generate the encrypted form of the password, thus: |
|---|
| 458 | # <tt>user:{AuthRealm}:password</tt>. Take note of this, because it means that |
|---|
| 459 | # if the {AuthRealm} changes, any existing MD5 encoded passwords will be |
|---|
| 460 | # invalidated by the change!</dd> |
|---|
| 461 | # <dt>plain</dt><dd> stores passwords as plain text (no encryption).</dd> |
|---|
| 462 | # <dt>crypt-md5</dt><dd>Enable use of standard libc (/etc/shadow) crypt-md5 password (like $1$saltsalt$hashashhashhashhash...$) which are stronger than the crypt paswords, salted, and the salt is stored in the encrypted password string as in normal crypt passwords. </dd> |
|---|
| 463 | # </dl> |
|---|
| 464 | $Foswiki::cfg{Htpasswd}{Encoding} = 'crypt'; |
|---|
| 465 | |
|---|
| 466 | #---++ Registration |
|---|
| 467 | # <p>Registration is the process by which new users register themselves with |
|---|
| 468 | # Foswiki.</p> |
|---|
| 469 | # **BOOLEAN** |
|---|
| 470 | # If you want users to be able to use a login ID other than their |
|---|
| 471 | # wikiname, you need to turn this on. It controls whether the 'LoginName' |
|---|
| 472 | # box appears during the user registration process, and is used to tell |
|---|
| 473 | # the User Mapping module whether to map login names to wikinames or not |
|---|
| 474 | # (if it supports mappings, that is). |
|---|
| 475 | $Foswiki::cfg{Register}{AllowLoginName} = $FALSE; |
|---|
| 476 | |
|---|
| 477 | # **BOOLEAN** |
|---|
| 478 | # Controls whether new user registration is available. |
|---|
| 479 | # It will have no effect on existing users. |
|---|
| 480 | $Foswiki::cfg{Register}{EnableNewUserRegistration} = $TRUE; |
|---|
| 481 | |
|---|
| 482 | # **BOOLEAN** |
|---|
| 483 | # Whether registrations must be verified by the user, by following |
|---|
| 484 | # a link sent in an email to the user's registered email address |
|---|
| 485 | $Foswiki::cfg{Register}{NeedVerification} = $FALSE; |
|---|
| 486 | |
|---|
| 487 | # **BOOLEAN EXPERT** |
|---|
| 488 | # Controls whether the user password has to be entered twice on the |
|---|
| 489 | # registration page or not. The default is to require confirmation, in which |
|---|
| 490 | # case the same password must be provided in the Twk1Password and |
|---|
| 491 | # Twk1Confirm inputs. |
|---|
| 492 | $Foswiki::cfg{Register}{DisablePasswordConfirmation} = $FALSE; |
|---|
| 493 | |
|---|
| 494 | # **BOOLEAN EXPERT** |
|---|
| 495 | # Hide password in registration email to the <em>user</em> |
|---|
| 496 | # Note that Foswiki sends administrators a separate confirmation. |
|---|
| 497 | $Foswiki::cfg{Register}{HidePasswd} = $TRUE; |
|---|
| 498 | |
|---|
| 499 | # **STRING 20 EXPERT** |
|---|
| 500 | # The internal user that creates user topics on new registrations. |
|---|
| 501 | # You are recommended not to change this. |
|---|
| 502 | $Foswiki::cfg{Register}{RegistrationAgentWikiName} = 'RegistrationAgent'; |
|---|
| 503 | |
|---|
| 504 | # **STRING H** |
|---|
| 505 | # Configuration password (not prompted) |
|---|
| 506 | $Foswiki::cfg{Password} = ''; |
|---|
| 507 | |
|---|
| 508 | #---++ Environment |
|---|
| 509 | # **PATH M** |
|---|
| 510 | # You can override the default PATH setting to control |
|---|
| 511 | # where Foswiki looks for external programs, such as grep and rcs. |
|---|
| 512 | # By restricting this path to just a few key |
|---|
| 513 | # directories, you increase the security of your Foswiki. |
|---|
| 514 | # <ol> |
|---|
| 515 | # <li> |
|---|
| 516 | # Unix or Linux |
|---|
| 517 | # <ul> |
|---|
| 518 | # <li> |
|---|
| 519 | # Path separator is : |
|---|
| 520 | # </li> |
|---|
| 521 | # <li> |
|---|
| 522 | # Make sure diff and shell (Bourne or bash type) are found on path. |
|---|
| 523 | # </li> |
|---|
| 524 | # <li> |
|---|
| 525 | # Typical setting is /bin:/usr/bin |
|---|
| 526 | # </li> |
|---|
| 527 | # </ul> |
|---|
| 528 | # </li> |
|---|
| 529 | # <li> |
|---|
| 530 | # Windows ActiveState Perl, using DOS shell |
|---|
| 531 | # <ul> |
|---|
| 532 | # <li> |
|---|
| 533 | # path separator is ; |
|---|
| 534 | # </li> |
|---|
| 535 | # <li> |
|---|
| 536 | # The Windows system directory is required. |
|---|
| 537 | # </li> |
|---|
| 538 | # <li> |
|---|
| 539 | # Use '\' not '/' in pathnames. |
|---|
| 540 | # </li> |
|---|
| 541 | # <li> |
|---|
| 542 | # Typical setting is C:\windows\system32 |
|---|
| 543 | # </li> |
|---|
| 544 | # </ul> |
|---|
| 545 | # </li> |
|---|
| 546 | # <li> |
|---|
| 547 | # Windows Cygwin Perl |
|---|
| 548 | # <ul> |
|---|
| 549 | # <li> |
|---|
| 550 | # path separator is : |
|---|
| 551 | # </li> |
|---|
| 552 | # <li> |
|---|
| 553 | # The Windows system directory is required. |
|---|
| 554 | # </li> |
|---|
| 555 | # <li> |
|---|
| 556 | # Use '/' not '\' in pathnames. |
|---|
| 557 | # </li> |
|---|
| 558 | # <li> |
|---|
| 559 | # Typical setting is /cygdrive/c/windows/system32 |
|---|
| 560 | # </li> |
|---|
| 561 | # </ul> |
|---|
| 562 | # </li> |
|---|
| 563 | # </ol> |
|---|
| 564 | $Foswiki::cfg{SafeEnvPath} = ''; |
|---|
| 565 | |
|---|
| 566 | # **PERL** |
|---|
| 567 | # Array of the names of configuration items that are available when using %IF, %SEARCH |
|---|
| 568 | # and %QUERY{}%. Extensions can push into this array to extend the set. This is done as |
|---|
| 569 | # a filter in because while the bulk of configuration items are quite innocent, |
|---|
| 570 | # it's better to be a bit paranoid. |
|---|
| 571 | $Foswiki::cfg{AccessibleCFG} = [ '{ScriptSuffix}', '{LoginManager}', '{AuthScripts}', '{LoginNameFilterIn}', '{AdminUserLogin}', '{AdminUserWikiName}', '{SuperAdminGroup}', '{UsersTopicName}', '{AuthRealm}', '{MinPasswordLength}', '{Register}{AllowLoginName}', '{Register}{EnableNewUserRegistration}', '{Register}{NeedVerification}', '{Register}{RegistrationAgentWikiName}', '{AllowInlineScript}', '{DenyDotDotInclude}', '{UploadFilter}', '{NameFilter}', '{AccessibleCFG}', '{AntiSpam}{EmailPadding}', '{AntiSpam}{HideUserDetails}', '{AntiSpam}{RobotsAreWelcome}', '{Stats}{TopViews}', '{Stats}{TopContrib}', '{Stats}{TopicName}', '{UserInterfaceInternationalisation}', '{UseLocale}', '{Site}{Locale}', '{Site}{CharSet}', '{DisplayTimeValues}', '{DefaultDateFormat}', '{Site}{LocaleRegexes}', '{UpperNational}', '{LowerNational}', '{PluralToSingular}', '{EnableHierarchicalWebs}', '{WebMasterEmail}', '{WebMasterName}', '{NotifyTopicName}', '{SystemWebName}', '{TrashWebName}', '{SitePrefsTopicName}', '{LocalSitePreferences}', '{HomeTopicName}', '{WebPrefsTopicName}', '{UsersWebName}', '{TemplatePath}', '{LinkProtocolPattern}', '{NumberOfRevisions}', '{MaxRevisionsInADiff}', '{ReplaceIfEditedAgainWithin}', '{LeaseLength}', '{LeaseLengthLessForceful}', '{Plugins}{WebSearchPath}', '{PluginsOrder}', '{Cache}{Enabled}', '{Validation}{Method}', '{Register}{DisablePasswordConfirmation}' ]; |
|---|
| 572 | |
|---|
| 573 | # **BOOLEAN** |
|---|
| 574 | # Allow %INCLUDE of URLs. This is disabled by default, because it is possible |
|---|
| 575 | # to mount a denial-of-service (DoS) attack on a Foswiki site using INCLUDE and |
|---|
| 576 | # URLs. Only enable it if you are in an environment where a DoS attack is not |
|---|
| 577 | # a high risk. |
|---|
| 578 | # <p /> You may also need to configure the proxy settings ({PROXY}{HOST} and |
|---|
| 579 | # {PROXY}{PORT}) if your server is behind a firewall and you allow %INCLUDE of |
|---|
| 580 | # external webpages (see Mail and Proxies). |
|---|
| 581 | $Foswiki::cfg{INCLUDE}{AllowURLs} = $FALSE; |
|---|
| 582 | |
|---|
| 583 | # **BOOLEAN** |
|---|
| 584 | # Used to disallow the use of SCRIPT and LITERAL tags in topics by removing |
|---|
| 585 | # them from the body of topics during rendering. |
|---|
| 586 | # <font color="red">This setting is fundamentally unsafe and is now |
|---|
| 587 | # DEPRECATED</font> - use <a href="http://foswiki.org/Extensions/SafeWikiPlugin">SafeWikiPlugin</a> instead. |
|---|
| 588 | $Foswiki::cfg{AllowInlineScript} = $TRUE; |
|---|
| 589 | |
|---|
| 590 | # **BOOLEAN EXPERT** |
|---|
| 591 | # If a login name (or an internal user id) cannot be mapped to a wikiname, |
|---|
| 592 | # then the user is unknown. By default the user will be displayed using |
|---|
| 593 | # whatever identity is stored for them. For security reasons you may want |
|---|
| 594 | # to obscure this stored id by setting this option to true. |
|---|
| 595 | $Foswiki::cfg{RenderLoggedInButUnknownUsers} = $FALSE; |
|---|
| 596 | |
|---|
| 597 | # **BOOLEAN EXPERT** |
|---|
| 598 | # Remove .. from %INCLUDE{filename}%, to stop includes |
|---|
| 599 | # of relative paths. |
|---|
| 600 | $Foswiki::cfg{DenyDotDotInclude} = $TRUE; |
|---|
| 601 | |
|---|
| 602 | # **REGEX EXPERT** |
|---|
| 603 | # Filter-in regex for uploaded (attached) file names. This is a filter |
|---|
| 604 | # <b>in</b>, so any files that match this filter will be renamed on upload |
|---|
| 605 | # to prevent upload of files with the same file extensions as executables. |
|---|
| 606 | # <p /> NOTE: Be sure to update |
|---|
| 607 | # this list with any configuration or script filetypes that are |
|---|
| 608 | # automatically run by your web server. |
|---|
| 609 | $Foswiki::cfg{UploadFilter} = qr/^(\.htaccess|.*\.(?i)(?:php[0-9s]?(\..*)?|[sp]htm[l]?(\..*)?|pl|py|cgi))$/; |
|---|
| 610 | |
|---|
| 611 | # **REGEX EXPERT** |
|---|
| 612 | # Filter-out regex for webnames, topic names, usernames, include paths |
|---|
| 613 | # and skin names. This is a filter <b>out</b>, so if any of the |
|---|
| 614 | # characters matched by this expression are seen in names, they will be |
|---|
| 615 | # removed. |
|---|
| 616 | $Foswiki::cfg{NameFilter} = qr/[\s\*?~^\$@%`"'&;|<>\[\]#\x00-\x1f]/; |
|---|
| 617 | |
|---|
| 618 | # **BOOLEAN EXPERT** |
|---|
| 619 | # If this is set, then the search module will use more relaxed |
|---|
| 620 | # rules governing regular expressions searches. |
|---|
| 621 | $Foswiki::cfg{ForceUnsafeRegexes} = $FALSE; |
|---|
| 622 | |
|---|
| 623 | # **BOOLEAN EXPERT** |
|---|
| 624 | # Build the path to /foswiki/bin from the URL that was used to get this |
|---|
| 625 | # far. This can be useful when rewriting rules or redirection are used |
|---|
| 626 | # to shorten URLs. Note that displayed links are incorrect after failed |
|---|
| 627 | # authentication if this is set, so unless you really know what you are |
|---|
| 628 | # doing, leave it alone. |
|---|
| 629 | $Foswiki::cfg{GetScriptUrlFromCgi} = $FALSE; |
|---|
| 630 | |
|---|
| 631 | # **BOOLEAN EXPERT** |
|---|
| 632 | # Draining STDIN may be necessary if the script is called due to a |
|---|
| 633 | # redirect and the original query was a POST. In this case the web |
|---|
| 634 | # server is waiting to write the POST data to this script's STDIN, |
|---|
| 635 | # but CGI.pm won't drain STDIN as it is seeing a GET because of the |
|---|
| 636 | # redirect, not a POST. Enable this <b>only</b> in case a Foswiki script |
|---|
| 637 | # hangs. |
|---|
| 638 | $Foswiki::cfg{DrainStdin} = $FALSE; |
|---|
| 639 | |
|---|
| 640 | # **BOOLEAN EXPERT** |
|---|
| 641 | # Remove port number from URL. If set, and a URL is given with a port |
|---|
| 642 | # number e.g. http://my.server.com:8080/foswiki/bin/view, this will strip |
|---|
| 643 | # off the port number before using the url in links. |
|---|
| 644 | $Foswiki::cfg{RemovePortNumber} = $FALSE; |
|---|
| 645 | |
|---|
| 646 | # **BOOLEAN EXPERT** |
|---|
| 647 | # Allow the use of URLs in the <tt>redirectto</tt> parameter to the |
|---|
| 648 | # <tt>save</tt> script, and in <tt>topic</tt> parameter to the |
|---|
| 649 | # <tt>view</tt> script. <b>WARNING:</b> Enabling this feature makes it |
|---|
| 650 | # very easy to build phishing pages using the wiki, so in general, |
|---|
| 651 | # public sites should <b>not</b> enable it. Note: It is possible to |
|---|
| 652 | # redirect to a topic regardless of this setting, such as |
|---|
| 653 | # <tt>topic=OtherTopic</tt> or <tt>redirectto=Web.OtherTopic</tt>. |
|---|
| 654 | # To enable redirection to a list of trusted URLs, keep this setting |
|---|
| 655 | # disabled and set the {PermittedRedirectHostUrls}. |
|---|
| 656 | $Foswiki::cfg{AllowRedirectUrl} = $FALSE; |
|---|
| 657 | |
|---|
| 658 | # **BOOLEAN EXPERT** |
|---|
| 659 | # Some authentication systems do not allow parameters to be passed in |
|---|
| 660 | # the target URL to be redirected to after authentication. In this case, |
|---|
| 661 | # Foswiki can be configured to encode the address of the parameter cache |
|---|
| 662 | # in the path information of the URL. Note that if you are using Apache |
|---|
| 663 | # rewriting rules, this may not work. |
|---|
| 664 | $Foswiki::cfg{UsePathForRedirectCache} = $FALSE; |
|---|
| 665 | |
|---|
| 666 | # **REGEX EXPERT** |
|---|
| 667 | # Defines the filter-in regexp that must match the names of environment |
|---|
| 668 | # variables that can be seen using the %ENV{}% macro. Set it to |
|---|
| 669 | # '^.*$' to allow all environment variables to be seen (not recommended). |
|---|
| 670 | $Foswiki::cfg{AccessibleENV} = '^(HTTP_\w+|REMOTE_\w+|SERVER_\w+|REQUEST_\w+|MOD_PERL|FOSWIKI_ACTION|PATH_INFO)$'; |
|---|
| 671 | |
|---|
| 672 | #---++ Anti-Spam |
|---|
| 673 | # <p>Foswiki incorporates some simple anti-spam measures to protect |
|---|
| 674 | # e-mail addresses and control the activities of benign robots. These |
|---|
| 675 | # should be enough to handle intranet requirements. Administrators of |
|---|
| 676 | # public (internet) sites are strongly recommended to install |
|---|
| 677 | # <a href="http://foswiki.org/Extensions/AntiWikiSpamPlugin" target="_new"> |
|---|
| 678 | # AntiWikiSpamPlugin</a></p> |
|---|
| 679 | |
|---|
| 680 | # **STRING 50** |
|---|
| 681 | # Text added to email addresses to prevent spambots from grabbing |
|---|
| 682 | # addresses e.g. set to 'NOSPAM' to get fred@user.co.ru |
|---|
| 683 | # rendered as fred@user.co.NOSPAM.ru |
|---|
| 684 | $Foswiki::cfg{AntiSpam}{EmailPadding} = ''; |
|---|
| 685 | |
|---|
| 686 | # **BOOLEAN** |
|---|
| 687 | # Normally Foswiki stores the user's sensitive information (such as their e-mail |
|---|
| 688 | # address) in a database out of public view. It also obfuscates e-mail |
|---|
| 689 | # addresses displayed in the browser. This is to help prevent e-mail |
|---|
| 690 | # spam and identity fraud.<br /> |
|---|
| 691 | # If that is not a risk for you (e.g. you are behind a firewall) and you |
|---|
| 692 | # are happy for e-mails to be made public to all Foswiki users, |
|---|
| 693 | # then you can set this option.<br /> |
|---|
| 694 | # Note that if this option is set, then the <code>user</code> parameter to |
|---|
| 695 | # <code>%USERINFO</code> is ignored. |
|---|
| 696 | $Foswiki::cfg{AntiSpam}{HideUserDetails} = $TRUE; |
|---|
| 697 | |
|---|
| 698 | # **BOOLEAN** |
|---|
| 699 | # By default, Foswiki doesn't do anything to stop robots, such as those used |
|---|
| 700 | # by search engines, from visiting "normal view" pages. |
|---|
| 701 | # If you disable this option, Foswiki will generate a META tag to tell robots |
|---|
| 702 | # not to index pages.<br /> |
|---|
| 703 | # Inappropriate pages (like the raw and edit views) are always protected from |
|---|
| 704 | # being indexed.<br /> |
|---|
| 705 | # Note that for full protection from robots you should also use robots.txt |
|---|
| 706 | # (there is an example in the root of your Foswiki installation). |
|---|
| 707 | $Foswiki::cfg{AntiSpam}{RobotsAreWelcome} = $TRUE; |
|---|
| 708 | |
|---|
| 709 | #---+ Logging and Statistics |
|---|
| 710 | |
|---|
| 711 | # **PATH** |
|---|
| 712 | # Directory where log files will be written. Log files are automatically |
|---|
| 713 | # cycled once a month. |
|---|
| 714 | $Foswiki::cfg{Log}{Dir} = '$Foswiki::cfg{WorkingDir}/logs'; |
|---|
| 715 | |
|---|
| 716 | # **SELECTCLASS none,Foswiki::Logger::* ** |
|---|
| 717 | # Foswiki supports different implementations of log files. It can be |
|---|
| 718 | # useful to be able to plug in a database implementation, for example, |
|---|
| 719 | # for a large site, or even provide your own custom logger. Select the |
|---|
| 720 | # implementation to be used here. Most sites should be OK with the |
|---|
| 721 | # PlainFile logger, which automatically rotates the logs every month.<p /> |
|---|
| 722 | # Note: the Foswiki 1.0 implementation of logfiles is still supported, |
|---|
| 723 | # through use of the <tt>Foswiki::Logger::Compatibility</tt> logger. |
|---|
| 724 | # Foswiki will automatically select the Compatibility logger if it detects |
|---|
| 725 | # a setting for <tt>{WarningFileName}</tt> in your LocalSite.cfg. |
|---|
| 726 | # You are recommended to change to the PlainFile logger at your earliest |
|---|
| 727 | # convenience by removing <tt>{WarningFileName}</tt>, |
|---|
| 728 | # <tt>{LogFileName}</tt> and <tt>{DebugFileName}</tt> |
|---|
| 729 | # from LocalSite.cfg and re-running configure. |
|---|
| 730 | $Foswiki::cfg{Log}{Implementation} = 'Foswiki::Logger::PlainFile'; |
|---|
| 731 | |
|---|
| 732 | # **PERL EXPERT** |
|---|
| 733 | # Whether or not to log different actions in the events log. |
|---|
| 734 | # Information in the events log is used in gathering web statistics, |
|---|
| 735 | # and is useful as an audit trail of Foswiki activity. |
|---|
| 736 | $Foswiki::cfg{Log}{Action} = { |
|---|
| 737 | view => 1, |
|---|
| 738 | search => 1, |
|---|
| 739 | changes => 1, |
|---|
| 740 | rdiff => 1, |
|---|
| 741 | edit => 1, |
|---|
| 742 | save => 1, |
|---|
| 743 | upload => 1, |
|---|
| 744 | attach => 1, |
|---|
| 745 | rename => 1, |
|---|
| 746 | register => 1, |
|---|
| 747 | rest => 1, |
|---|
| 748 | viewfile => 1, |
|---|
| 749 | }; |
|---|
| 750 | |
|---|
| 751 | # **NUMBER** |
|---|
| 752 | # Number of top viewed topics to show in statistics topic |
|---|
| 753 | $Foswiki::cfg{Stats}{TopViews} = 10; |
|---|
| 754 | |
|---|
| 755 | # **NUMBER** |
|---|
| 756 | # Number of top contributors to show in statistics topic |
|---|
| 757 | $Foswiki::cfg{Stats}{TopContrib} = 10; |
|---|
| 758 | |
|---|
| 759 | # **STRING 20 EXPERT** |
|---|
| 760 | # Name of statistics topic |
|---|
| 761 | $Foswiki::cfg{Stats}{TopicName} = 'WebStatistics'; |
|---|
| 762 | |
|---|
| 763 | #---+ Internationalisation -- TABS |
|---|
| 764 | #---++ Languages |
|---|
| 765 | # **BOOLEAN** |
|---|
| 766 | # <p>Enable user interface internationalisation, i.e. presenting the user |
|---|
| 767 | # interface in the users own language(s). Some languages require the |
|---|
| 768 | # <code>Locale::Maketext::Lexicon</code> and <code>Encode/MapUTF8</code> Perl |
|---|
| 769 | # modules to be installed.</p> |
|---|
| 770 | $Foswiki::cfg{UserInterfaceInternationalisation} = $FALSE; |
|---|
| 771 | |
|---|
| 772 | # *LANGUAGES* Marker used by bin/configure script - do not remove! |
|---|
| 773 | # <p>These settings control the languages that are available for the |
|---|
| 774 | # user interface. Check every language that you want your site to support.</p> |
|---|
| 775 | # <p>Allowing all languages is the best for <strong>really</Strong> international |
|---|
| 776 | # sites, but for best performance you should enable only the languages you |
|---|
| 777 | # really need. English is the default language, and is always enabled.</p> |
|---|
| 778 | # <p><code>{LocalesDir}</code> is used to find the languages supported in your installation, |
|---|
| 779 | # so if the list of available languages below is empty, it's probably because |
|---|
| 780 | # <code>{LocalesDir}</code> is pointing to the wrong place.</p> |
|---|
| 781 | |
|---|
| 782 | $Foswiki::cfg{Languages}{bg}{Enabled} = 1; |
|---|
| 783 | $Foswiki::cfg{Languages}{cs}{Enabled} = 1; |
|---|
| 784 | $Foswiki::cfg{Languages}{da}{Enabled} = 1; |
|---|
| 785 | $Foswiki::cfg{Languages}{nl}{Enabled} = 1; |
|---|
| 786 | $Foswiki::cfg{Languages}{fi}{Enabled} = 1; |
|---|
| 787 | $Foswiki::cfg{Languages}{fr}{Enabled} = 1; |
|---|
| 788 | $Foswiki::cfg{Languages}{de}{Enabled} = 1; |
|---|
| 789 | $Foswiki::cfg{Languages}{it}{Enabled} = 1; |
|---|
| 790 | $Foswiki::cfg{Languages}{ja}{Enabled} = 1; |
|---|
| 791 | $Foswiki::cfg{Languages}{ko}{Enabled} = 1; |
|---|
| 792 | $Foswiki::cfg{Languages}{no}{Enabled} = 1; |
|---|
| 793 | $Foswiki::cfg{Languages}{pl}{Enabled} = 1; |
|---|
| 794 | $Foswiki::cfg{Languages}{pt}{Enabled} = 1; |
|---|
| 795 | $Foswiki::cfg{Languages}{'pt-br'}{Enabled} = 1; |
|---|
| 796 | $Foswiki::cfg{Languages}{ru}{Enabled} = 1; |
|---|
| 797 | $Foswiki::cfg{Languages}{es}{Enabled} = 1; |
|---|
| 798 | $Foswiki::cfg{Languages}{sv}{Enabled} = 1; |
|---|
| 799 | $Foswiki::cfg{Languages}{tr}{Enabled} = 1; |
|---|
| 800 | $Foswiki::cfg{Languages}{'zh-cn'}{Enabled} = 1; |
|---|
| 801 | $Foswiki::cfg{Languages}{'zh-tw'}{Enabled} = 1; |
|---|
| 802 | |
|---|
| 803 | #---++ Locale |
|---|
| 804 | # <p>Enable operating system level locales and internationalisation support |
|---|
| 805 | # for 8-bit character sets. This may be required for correct functioning |
|---|
| 806 | # of the programs that Foswiki calls when your wiki content uses |
|---|
| 807 | # international character sets.</p> |
|---|
| 808 | |
|---|
| 809 | # **BOOLEAN** |
|---|
| 810 | # Enable the used of {Site}{Locale} |
|---|
| 811 | $Foswiki::cfg{UseLocale} = $FALSE; |
|---|
| 812 | |
|---|
| 813 | # **STRING 50** |
|---|
| 814 | # Site-wide locale - used by Foswiki and external programs such as grep, and to |
|---|
| 815 | # specify the character set in which content must be presented for the user's |
|---|
| 816 | # web browser. |
|---|
| 817 | # <br/> |
|---|
| 818 | # Note that {Site}{Locale} is ignored unless {UseLocale} is set. |
|---|
| 819 | # <br /> |
|---|
| 820 | # Locale names are not standardised. On Unix/Linux check 'locale -a' on |
|---|
| 821 | # your system to see which locales are supported by your system. |
|---|
| 822 | # You may also need to check what charsets your browsers accept - the |
|---|
| 823 | # 'preferred MIME names' at http://www.iana.org/assignments/character-sets |
|---|
| 824 | # are a good starting point. |
|---|
| 825 | # <br /> |
|---|
| 826 | # WARNING: Topics are stored in site character set format, so data |
|---|
| 827 | # conversion of file names and contents will be needed if you change |
|---|
| 828 | # locales after creating topics whose names or contents include 8-bit |
|---|
| 829 | # characters. |
|---|
| 830 | # <br /> |
|---|
| 831 | # Examples:<br /> |
|---|
| 832 | # <code>en_US.ISO-8859-1</code> - Standard US ISO-8859-1 (default)<br /> |
|---|
| 833 | # <code>de_AT.ISO-8859-15</code> - Austria with ISO-8859-15 for Euro<br /> |
|---|
| 834 | # <code>ru_RU.KOI8-R</code> - Russia<br /> |
|---|
| 835 | # <code>ja_JP.eucjp</code> - Japan <br /> |
|---|
| 836 | # <code>C</code> - English only; no I18N features regarding character |
|---|
| 837 | # encodings and external programs.<br /> |
|---|
| 838 | # UTF-8 locale like en_US.utf8 is still considered experimental |
|---|
| 839 | $Foswiki::cfg{Site}{Locale} = 'en_US.ISO-8859-1'; |
|---|
| 840 | |
|---|
| 841 | # **STRING 50 ** |
|---|
| 842 | # Set this to match your chosen {Site}{Locale} (from 'locale -a') |
|---|
| 843 | # whose character set is not supported by your available perl conversion module |
|---|
| 844 | # (i.e. Encode for Perl 5.8 or higher, or Unicode::MapUTF8 for other Perl |
|---|
| 845 | # versions). For example, if the locale 'ja_JP.eucjp' exists on your system |
|---|
| 846 | # but only 'euc-jp' is supported by Unicode::MapUTF8, set this to 'euc-jp'. |
|---|
| 847 | # If you don't define it, it will automatically be defaulted to iso-8859-1<br /> |
|---|
| 848 | # UTF-8 support is still considered experimental. Use the value 'utf-8' to try it. |
|---|
| 849 | $Foswiki::cfg{Site}{CharSet} = undef; |
|---|
| 850 | |
|---|
| 851 | # **SELECT gmtime,servertime** |
|---|
| 852 | # Set the timezone (this only effects the display of times, |
|---|
| 853 | # all internal storage is still in GMT). May be gmtime or servertime |
|---|
| 854 | $Foswiki::cfg{DisplayTimeValues} = 'gmtime'; |
|---|
| 855 | |
|---|
| 856 | # **SELECT $day $month $year, $year-$mo-$day, $year/$mo/$day, $year.$mo.$day** |
|---|
| 857 | # Set the default format for dates. The traditional Foswiki format is |
|---|
| 858 | # '$day $month $year' (31 Dec 2007). The ISO format '$year-$mo-$day' |
|---|
| 859 | # (2007-12-31) is recommended for non English language Foswikis. Note that $mo |
|---|
| 860 | # is the month as a two digit number. $month is the three first letters of |
|---|
| 861 | # English name of the month |
|---|
| 862 | $Foswiki::cfg{DefaultDateFormat} = '$day $month $year'; |
|---|
| 863 | |
|---|
| 864 | # **BOOLEAN EXPERT** |
|---|
| 865 | # Disable to force explicit listing of national chars in |
|---|
| 866 | # regexes, rather than relying on locale-based regexes. Intended |
|---|
| 867 | # for Perl 5.6 or higher on platforms with broken locales: should |
|---|
| 868 | # only be disabled if you have locale problems. |
|---|
| 869 | $Foswiki::cfg{Site}{LocaleRegexes} = $TRUE; |
|---|
| 870 | |
|---|
| 871 | # **STRING EXPERT** |
|---|
| 872 | # If a suitable working locale is not available (i.e. {UseLocale} |
|---|
| 873 | # is disabled), OR you are using Perl 5.005 (with or without working |
|---|
| 874 | # locales), OR {Site}{LocaleRegexes} is disabled, you can use WikiWords with |
|---|
| 875 | # accented national characters by putting any '8-bit' accented |
|---|
| 876 | # national characters within these strings - i.e. {UpperNational} |
|---|
| 877 | # should contain upper case non-ASCII letters. This is termed |
|---|
| 878 | # 'non-locale regexes' mode. |
|---|
| 879 | # If 'non-locale regexes' is in effect, WikiWord linking will work, |
|---|
| 880 | # but some features such as sorting of WikiWords in search results |
|---|
| 881 | # may not. These features depend on {UseLocale}, which can be set |
|---|
| 882 | # independently of {Site}{{LocaleRegexes}, so they will work with Perl |
|---|
| 883 | # 5.005 as long as {UseLocale} is set and you have working |
|---|
| 884 | # locales. |
|---|
| 885 | $Foswiki::cfg{UpperNational} = ''; |
|---|
| 886 | # **STRING EXPERT** |
|---|
| 887 | # |
|---|
| 888 | $Foswiki::cfg{LowerNational} = ''; |
|---|
| 889 | |
|---|
| 890 | # **BOOLEAN EXPERT** |
|---|
| 891 | # Change non-existent plural topic name to singular, |
|---|
| 892 | # e.g. TestPolicies to TestPolicy. Only works in English. |
|---|
| 893 | $Foswiki::cfg{PluralToSingular} = $TRUE; |
|---|
| 894 | |
|---|
| 895 | #---+ Store |
|---|
| 896 | # <p>Foswiki supports different back-end store implementations.</p> |
|---|
| 897 | # **SELECTCLASS Foswiki::Store::* ** |
|---|
| 898 | # Store implementation. |
|---|
| 899 | # <ul> |
|---|
| 900 | # <li>RcsWrap uses normal RCS executables.</li> |
|---|
| 901 | # <li>RcsLite uses a 100% Perl simplified implementation of RCS. |
|---|
| 902 | # RcsLite is useful if you don't have, and can't install, RCS - for |
|---|
| 903 | # example, on a hosted platform. It will work, and is compatible with |
|---|
| 904 | # RCS, but is not quite as fast.</li> |
|---|
| 905 | # </ul> |
|---|
| 906 | $Foswiki::cfg{Store}{Implementation} = 'Foswiki::Store::RcsWrap'; |
|---|
| 907 | $Foswiki::cfg{Store}{Implementation} = 'Foswiki::Store::RcsLite' if ($^O eq 'MSWin32'); |
|---|
| 908 | |
|---|
| 909 | # **BOOLEAN** |
|---|
| 910 | # Set to enable hierarchical webs. Without this setting, Foswiki will only |
|---|
| 911 | # allow a single level of webs. If you set this, you can use |
|---|
| 912 | # multiple levels, like a directory tree, i.e. webs within webs. |
|---|
| 913 | $Foswiki::cfg{EnableHierarchicalWebs} = 1; |
|---|
| 914 | |
|---|
| 915 | # **NUMBER EXPERT** |
|---|
| 916 | # Number of seconds to remember changes for. This doesn't affect revision |
|---|
| 917 | # histories, which always remember when a file changed. It only affects |
|---|
| 918 | # the number of changes that are cached for fast access by the 'changes' and |
|---|
| 919 | # 'statistics' scripts, and for use by extensions such as the change |
|---|
| 920 | # notification mailer. It should be no shorter than the interval between runs |
|---|
| 921 | # of these scripts. |
|---|
| 922 | $Foswiki::cfg{Store}{RememberChangesFor} = 31 * 24 * 60 * 60; |
|---|
| 923 | |
|---|
| 924 | # **SELECTCLASS Foswiki::Store::SearchAlgorithms::*** |
|---|
| 925 | # Foswiki RCS has two built-in search algorithms |
|---|
| 926 | # <ol><li> The default 'Forking' algorithm, which forks a subprocess that |
|---|
| 927 | # runs a 'grep' command and is recommended for Linux/Unix, |
|---|
| 928 | # </li><li> The 'PurePerl' implementation, which is written in Perl and |
|---|
| 929 | # usually only used for native Windows installations where forking |
|---|
| 930 | # does not work stable because of limitations in length of command line</li></ol> |
|---|
| 931 | # On Linux/Unix you will be just fine with the 'Forking' implementation. |
|---|
| 932 | # However if you find searches run very slowly, you may want to try a |
|---|
| 933 | # different algorithm, which may work better on your configuration. |
|---|
| 934 | # Forking may work OK also on Windows if you keep the directory path to |
|---|
| 935 | # Foswiki very short. |
|---|
| 936 | # Note that there is an alternative algorithm available from |
|---|
| 937 | # <a href="http://foswiki.org/Extensions/NativeSearchContrib"> |
|---|
| 938 | # http://foswiki.org/Extensions/NativeSearchContrib </a>, that often |
|---|
| 939 | # gives better performance with mod_perl and Speedy CGI. |
|---|
| 940 | $Foswiki::cfg{Store}{SearchAlgorithm} = 'Foswiki::Store::SearchAlgorithms::Forking'; |
|---|
| 941 | $Foswiki::cfg{Store}{SearchAlgorithm} = 'Foswiki::Store::SearchAlgorithms::PurePerl' if ($^O eq 'MSWin32'); |
|---|
| 942 | |
|---|
| 943 | # bodgey up a default location for grep |
|---|
| 944 | my $grepDefaultPath = '/bin/'; |
|---|
| 945 | $grepDefaultPath = '/usr/bin/' if ($^O eq 'darwin'); |
|---|
| 946 | $grepDefaultPath = 'c:/PROGRA~1/GnuWin32/bin/' if ($^O eq 'MSWin32'); |
|---|
| 947 | |
|---|
| 948 | # **COMMAND EXPERT** |
|---|
| 949 | # Full path to GNU-compatible egrep program. This is used for searching when |
|---|
| 950 | # {SearchAlgorithm} is 'Foswiki::Store::SearchAlgorithms::Forking'. |
|---|
| 951 | # %CS{|-i}% will be expanded |
|---|
| 952 | # to -i for case-sensitive search or to the empty string otherwise. |
|---|
| 953 | # Similarly for %DET, which controls whether matching lines are required. |
|---|
| 954 | # (see the documentation on these options with GNU grep for details). |
|---|
| 955 | $Foswiki::cfg{Store}{EgrepCmd} = $grepDefaultPath.'grep -E %CS{|-i}% %DET{|-l}% -H -- %TOKEN|U% %FILES|F%'; |
|---|
| 956 | |
|---|
| 957 | # **COMMAND EXPERT** |
|---|
| 958 | # Full path to GNU-compatible fgrep program. This is used for searching when |
|---|
| 959 | # {SearchAlgorithm} is 'Foswiki::Store::SearchAlgorithms::Forking'. |
|---|
| 960 | $Foswiki::cfg{Store}{FgrepCmd} = $grepDefaultPath.'grep -F %CS{|-i}% %DET{|-l}% -H -- %TOKEN|U% %FILES|F%'; |
|---|
| 961 | |
|---|
| 962 | # **SELECTCLASS Foswiki::Store::QueryAlgorithms::* EXPERT** |
|---|
| 963 | # The standard Foswiki algorithm for performing queries is not particularly |
|---|
| 964 | # fast (it is based on plain-text searching). You may be able to select |
|---|
| 965 | # a different algorithm here, depending on what alternative implementations |
|---|
| 966 | # may have been installed. |
|---|
| 967 | $Foswiki::cfg{Store}{QueryAlgorithm} = 'Foswiki::Store::QueryAlgorithms::BruteForce'; |
|---|
| 968 | |
|---|
| 969 | # **SELECTCLASS Foswiki::Prefs::*RAM* EXPERT** |
|---|
| 970 | # The algorithm used to store preferences. The default algorithm reads |
|---|
| 971 | # topics each time to access preferences. A caching algorithm that uses |
|---|
| 972 | # BerkeleyDB is also available from the PrefsCachePlugin. This algorithm |
|---|
| 973 | # is faster, but requires BerkeleyDB to be installed. |
|---|
| 974 | $Foswiki::cfg{Store}{PrefsBackend} = 'Foswiki::Prefs::TopicRAM'; |
|---|
| 975 | |
|---|
| 976 | # **OCTAL EXPERT** |
|---|
| 977 | # File security for new directories created by RCS stores. You may have |
|---|
| 978 | # to adjust these |
|---|
| 979 | # permissions to allow (or deny) users other than the webserver user access |
|---|
| 980 | # to directories that Foswiki creates. This is an <strong>octal</strong> number |
|---|
| 981 | # representing the standard UNIX permissions (e.g. 755 == rwxr-xr-x) |
|---|
| 982 | $Foswiki::cfg{RCS}{dirPermission}= 0755; |
|---|
| 983 | |
|---|
| 984 | # **OCTAL EXPERT** |
|---|
| 985 | # File security for new files created by RCS stores. You may have to adjust these |
|---|
| 986 | # permissions to allow (or deny) users other than the webserver user access |
|---|
| 987 | # to files that Foswiki creates. This is an <strong>octal</strong> number |
|---|
| 988 | # representing the standard UNIX permissions (e.g. 644 == rw-r--r--) |
|---|
| 989 | $Foswiki::cfg{RCS}{filePermission}= 0644; |
|---|
| 990 | |
|---|
| 991 | # **BOOLEAN EXPERT** |
|---|
| 992 | # Some file-based Store implementations (RcsWrap and RcsLite) store |
|---|
| 993 | # attachment meta-data separately from the actual attachments. |
|---|
| 994 | # This means that it is possible to have a file in an attachment directory |
|---|
| 995 | # that is not seen as an attachment by Foswiki. Sometimes it is desirable to |
|---|
| 996 | # be able to simply copy files into a directory and have them appear as |
|---|
| 997 | # attachments, and that's what this feature allows you to do. |
|---|
| 998 | # Considered experimental. |
|---|
| 999 | $Foswiki::cfg{RCS}{AutoAttachPubFiles} = $FALSE; |
|---|
| 1000 | |
|---|
| 1001 | # **STRING 20 EXPERT** |
|---|
| 1002 | # Specifies the extension to use on RCS files. Set to -x,v on windows, leave |
|---|
| 1003 | # blank on other platforms. |
|---|
| 1004 | $Foswiki::cfg{RCS}{ExtOption} = ""; |
|---|
| 1005 | |
|---|
| 1006 | # **REGEX EXPERT** |
|---|
| 1007 | # Perl regular expression matching suffixes valid on plain text files |
|---|
| 1008 | # Defines which attachments will be treated as ASCII in RCS. This is a |
|---|
| 1009 | # filter <b>in</b>, so any filenames that match this expression will |
|---|
| 1010 | # be treated as ASCII. |
|---|
| 1011 | $Foswiki::cfg{RCS}{asciiFileSuffixes} = qr/\.(txt|html|xml|pl)$/; |
|---|
| 1012 | |
|---|
| 1013 | # **BOOLEAN EXPERT** |
|---|
| 1014 | # Set this if your RCS cannot check out using the -p option. |
|---|
| 1015 | # May be needed in some windows installations (not required for cygwin) |
|---|
| 1016 | $Foswiki::cfg{RCS}{coMustCopy} = $FALSE; |
|---|
| 1017 | |
|---|
| 1018 | # **COMMAND EXPERT** |
|---|
| 1019 | # RcsWrap initialise a file as binary. |
|---|
| 1020 | # %FILENAME|F% will be expanded to the filename. |
|---|
| 1021 | $Foswiki::cfg{RCS}{initBinaryCmd} = "/usr/bin/rcs $Foswiki::cfg{RCS}{ExtOption} -i -t-none -kb %FILENAME|F%"; |
|---|
| 1022 | # **COMMAND EXPERT** |
|---|
| 1023 | # RcsWrap initialise a topic file. |
|---|
| 1024 | $Foswiki::cfg{RCS}{initTextCmd} = "/usr/bin/rcs $Foswiki::cfg{RCS}{ExtOption} -i -t-none -ko %FILENAME|F%"; |
|---|
| 1025 | # **COMMAND EXPERT** |
|---|
| 1026 | # RcsWrap uses this on Windows to create temporary binary files during upload. |
|---|
| 1027 | $Foswiki::cfg{RCS}{tmpBinaryCmd} = "/usr/bin/rcs $Foswiki::cfg{RCS}{ExtOption} -kb %FILENAME|F%"; |
|---|
| 1028 | # **COMMAND EXPERT** |
|---|
| 1029 | # RcsWrap check-in. |
|---|
| 1030 | # %USERNAME|S% will be expanded to the username. |
|---|
| 1031 | # %COMMENT|U% will be expanded to the comment. |
|---|
| 1032 | $Foswiki::cfg{RCS}{ciCmd} = |
|---|
| 1033 | "/usr/bin/ci $Foswiki::cfg{RCS}{ExtOption} -m%COMMENT|U% -t-none -w%USERNAME|S% -u %FILENAME|F%"; |
|---|
| 1034 | # **COMMAND EXPERT** |
|---|
| 1035 | # RcsWrap check in, forcing the date. |
|---|
| 1036 | # %DATE|D% will be expanded to the date. |
|---|
| 1037 | $Foswiki::cfg{RCS}{ciDateCmd} = |
|---|
| 1038 | "/usr/bin/ci $Foswiki::cfg{RCS}{ExtOption} -m%COMMENT|U% -t-none -d%DATE|D% -u -w%USERNAME|S% %FILENAME|F%"; |
|---|
| 1039 | # **COMMAND EXPERT** |
|---|
| 1040 | # RcsWrap check out. |
|---|
| 1041 | # %REVISION|N% will be expanded to the revision number |
|---|
| 1042 | $Foswiki::cfg{RCS}{coCmd} = |
|---|
| 1043 | "/usr/bin/co $Foswiki::cfg{RCS}{ExtOption} -p%REVISION|N% -ko %FILENAME|F%"; |
|---|
| 1044 | # **COMMAND EXPERT** |
|---|
| 1045 | # RcsWrap file history. |
|---|
| 1046 | $Foswiki::cfg{RCS}{histCmd} = |
|---|
| 1047 | "/usr/bin/rlog $Foswiki::cfg{RCS}{ExtOption} -h %FILENAME|F%"; |
|---|
| 1048 | # **COMMAND EXPERT** |
|---|
| 1049 | # RcsWrap revision info about the file. |
|---|
| 1050 | $Foswiki::cfg{RCS}{infoCmd} = |
|---|
| 1051 | "/usr/bin/rlog $Foswiki::cfg{RCS}{ExtOption} -r%REVISION|N% %FILENAME|F%"; |
|---|
| 1052 | # **COMMAND EXPERT** |
|---|
| 1053 | # RcsWrap revision info about the revision that existed at a given date. |
|---|
| 1054 | # %REVISIONn|N% will be expanded to the revision number. |
|---|
| 1055 | # %CONTEXT|N% will be expanded to the number of lines of context. |
|---|
| 1056 | $Foswiki::cfg{RCS}{rlogDateCmd} = |
|---|
| 1057 | "/usr/bin/rlog $Foswiki::cfg{RCS}{ExtOption} -d%DATE|D% %FILENAME|F%"; |
|---|
| 1058 | # **COMMAND EXPERT** |
|---|
| 1059 | # RcsWrap differences between two revisions. |
|---|
| 1060 | $Foswiki::cfg{RCS}{diffCmd} = |
|---|
| 1061 | "/usr/bin/rcsdiff $Foswiki::cfg{RCS}{ExtOption} -q -w -B -r%REVISION1|N% -r%REVISION2|N% -ko --unified=%CONTEXT|N% %FILENAME|F%"; |
|---|
| 1062 | # **COMMAND EXPERT** |
|---|
| 1063 | # RcsWrap lock a file. |
|---|
| 1064 | $Foswiki::cfg{RCS}{lockCmd} = |
|---|
| 1065 | "/usr/bin/rcs $Foswiki::cfg{RCS}{ExtOption} -l %FILENAME|F%"; |
|---|
| 1066 | # **COMMAND EXPERT** |
|---|
| 1067 | # RcsWrap unlock a file. |
|---|
| 1068 | $Foswiki::cfg{RCS}{unlockCmd} = |
|---|
| 1069 | "/usr/bin/rcs $Foswiki::cfg{RCS}{ExtOption} -u %FILENAME|F%"; |
|---|
| 1070 | # **COMMAND EXPERT** |
|---|
| 1071 | # RcsWrap break a file lock. |
|---|
| 1072 | $Foswiki::cfg{RCS}{breaklockCmd} = |
|---|
| 1073 | "/usr/bin/rcs $Foswiki::cfg{RCS}{ExtOption} -u -M %FILENAME|F%"; |
|---|
| 1074 | # **COMMAND EXPERT** |
|---|
| 1075 | # RcsWrap delete a specific revision. |
|---|
| 1076 | $Foswiki::cfg{RCS}{delRevCmd} = |
|---|
| 1077 | "/usr/bin/rcs $Foswiki::cfg{RCS}{ExtOption} -o%REVISION|N% %FILENAME|F%"; |
|---|
| 1078 | |
|---|
| 1079 | #---+ Tuning |
|---|
| 1080 | |
|---|
| 1081 | #---++ HTTP Compression |
|---|
| 1082 | # **BOOLEAN EXPERT** |
|---|
| 1083 | # Enable gzip/deflate page compression. Modern browsers can uncompress content |
|---|
| 1084 | # encoded using gzip compression. You will save a lot of bandwidth by compressing |
|---|
| 1085 | # pages. This makes most sense when enabling page caching as well as these are |
|---|
| 1086 | # stored in compressed format by default when {HttpCompress} is enabled. |
|---|
| 1087 | # Note that only pages without any 'dirty areas' will be compressed. Any other page |
|---|
| 1088 | # will be transmitted uncompressed. |
|---|
| 1089 | $Foswiki::cfg{HttpCompress} = $FALSE; |
|---|
| 1090 | |
|---|
| 1091 | #---++ HTML Page Layout |
|---|
| 1092 | # **BOOLEAN EXPERT** |
|---|
| 1093 | # <p><code>{MergeHeadAndScriptZones}</code> is provided to maintain compatibility with legacy extensions that use <code>ADDTOHEAD</code> to add <code><script></code> markup and require content that is now in the <code>script</code> zone.</p> |
|---|
| 1094 | # <p>Normally, dependencies between individual <code>ADDTOZONE</code> statements are resolved within each zone. However, if <code>{MergeHeadAndScriptZones}</code> is enabled, then <code>head</code> content which requires an <code>id</code> that only exists in <code>script</code> (and vice-versa) will be re-ordered to satisfy any dependency.</p> |
|---|
| 1095 | # <p><strong><code>{MergeHeadAndScriptZones}</code> will be removed from a future version of Foswiki.</strong></p> |
|---|
| 1096 | $Foswiki::cfg{MergeHeadAndScriptZones} = $FALSE; |
|---|
| 1097 | |
|---|
| 1098 | #---++ Cache |
|---|
| 1099 | # <p>Foswiki includes built-in support for caching HTML pages. This can |
|---|
| 1100 | # dramatically increase performance, especially if there are a lot more page |
|---|
| 1101 | # views than changes.</p> |
|---|
| 1102 | # The cache has a number of setup and tuning parameters. You should read |
|---|
| 1103 | # <a href="http://foswiki.org/System/PageCaching">Page Caching</a> on |
|---|
| 1104 | # foswiki.org (or your local copy of this page in the System web) before |
|---|
| 1105 | # enabling the cache. It is important that you read this topic carefully |
|---|
| 1106 | # as the cache also has some major disadvantages with respect to formatted |
|---|
| 1107 | # searches. |
|---|
| 1108 | |
|---|
| 1109 | # **BOOLEAN** |
|---|
| 1110 | # This setting will switch on/off caching. |
|---|
| 1111 | $Foswiki::cfg{Cache}{Enabled} = $FALSE; |
|---|
| 1112 | |
|---|
| 1113 | # **STRING 80 EXPERT** |
|---|
| 1114 | # List of those topics that have a manual dependency on every topic |
|---|
| 1115 | # in a web. Web dependencies can also be specified using the WEBDEPENDENCIES |
|---|
| 1116 | # preference, which overrides this setting. |
|---|
| 1117 | $Foswiki::cfg{Cache}{WebDependencies} = 'WebRss, WebAtom, WebTopicList, WebIndex, WebSearch, WebSearchAdvanced'; |
|---|
| 1118 | |
|---|
| 1119 | # **REGEX EXPERT** |
|---|
| 1120 | # Exclude topics that match this regular expression from the dependency |
|---|
| 1121 | # tracker. |
|---|
| 1122 | $Foswiki::cfg{Cache}{DependencyFilter} = '$Foswiki::cfg{SystemWebName}\..*|$Foswiki::cfg{TrashWebName}\..*|.*Template$|TWiki\..*'; |
|---|
| 1123 | |
|---|
| 1124 | # **SELECT Foswiki::Cache::FileCache,Foswiki::Cache::BDB,Foswiki::Cache::Memcached,Foswiki::Cache::MemoryLRU EXPERT** |
|---|
| 1125 | # Select the default caching mechanism. Note that individual subsystems might |
|---|
| 1126 | # choose a different backend for their own purposes. |
|---|
| 1127 | $Foswiki::cfg{CacheManager} = 'Foswiki::Cache::FileCache'; |
|---|
| 1128 | |
|---|
| 1129 | # **SELECT Foswiki::Cache::DB_File,Foswiki::Cache::BDB EXPERT** |
|---|
| 1130 | # Select the database backend use to store meta data for the page cache. |
|---|
| 1131 | $Foswiki::cfg{MetaCacheManager} = 'Foswiki::Cache::DB_File'; |
|---|
| 1132 | |
|---|
| 1133 | # **PATH EXPERT** |
|---|
| 1134 | # Specify the root directory for CacheManagers that use file-system based |
|---|
| 1135 | # storage. This is where the database files will be stored. |
|---|
| 1136 | $Foswiki::cfg{Cache}{RootDir} = '$Foswiki::cfg{WorkingDir}/tmp/cache'; |
|---|
| 1137 | |
|---|
| 1138 | # **STRING 30 EXPERT** |
|---|
| 1139 | # Specify the database file for the <code>Foswiki::Cache::DB_File</code> |
|---|
| 1140 | # CacheManager |
|---|
| 1141 | $Foswiki::cfg{Cache}{DBFile} = '$Foswiki::cfg{WorkingDir}/tmp/foswiki_db'; |
|---|
| 1142 | |
|---|
| 1143 | # **STRING EXPERT** |
|---|
| 1144 | # Specify the namespace used by this site in a store shared with other systems. |
|---|
| 1145 | $Foswiki::cfg{Cache}{NameSpace} = '$Foswiki::cfg{DefaultUrlHost}'; |
|---|
| 1146 | |
|---|
| 1147 | # **NUMBER EXPERT** |
|---|
| 1148 | # Specify the maximum number of cache entries for size-aware CacheManagers like |
|---|
| 1149 | # <code>MemoryLRU</code>. This won't have any effect on other CacheManagers. |
|---|
| 1150 | $Foswiki::cfg{Cache}{MaxSize} = 1000; |
|---|
| 1151 | |
|---|
| 1152 | # **STRING 30 EXPERT** |
|---|
| 1153 | # Specify a comma separated list of servers for distributed CacheManagers like |
|---|
| 1154 | # <code>Memcached</code>. This setting won't have any effect on other CacheManagers. |
|---|
| 1155 | $Foswiki::cfg{Cache}{Servers} = '127.0.0.1:11211'; |
|---|
| 1156 | |
|---|
| 1157 | #---+ Mail and Proxies |
|---|
| 1158 | # <p>Settings controlling if and how Foswiki sends email, and the proxies used |
|---|
| 1159 | # to access external web pages.</p> |
|---|
| 1160 | |
|---|
| 1161 | # **BOOLEAN** |
|---|
| 1162 | # Enable email globally. |
|---|
| 1163 | $Foswiki::cfg{EnableEmail} = $TRUE; |
|---|
| 1164 | |
|---|
| 1165 | # **STRING 30** |
|---|
| 1166 | # Wiki administrator's e-mail address e.g. <code>webmaster@example.com</code> |
|---|
| 1167 | # (used in <code>%WIKIWEBMASTER%</code>) |
|---|
| 1168 | # NOTE: must be a single valid email address |
|---|
| 1169 | $Foswiki::cfg{WebMasterEmail} = ''; |
|---|
| 1170 | |
|---|
| 1171 | # **STRING 30** |
|---|
| 1172 | # Wiki administrator's name address, for use in mails (first name and |
|---|
| 1173 | # last name, e.g. <tt>Fred Smith</tt>) (used in %WIKIWEBMASTERNAME%) |
|---|
| 1174 | $Foswiki::cfg{WebMasterName} = 'Wiki Administrator'; |
|---|
| 1175 | |
|---|
| 1176 | # **COMMAND** |
|---|
| 1177 | # Mail program. If Net::SMTP is installed, it will be used in preference. |
|---|
| 1178 | # To force Foswiki to use the {MailProgram}, unset both {SMTP}{MAILHOST} |
|---|
| 1179 | # below and all SMTPMAILHOST settings in your Foswiki's Preferences topics. |
|---|
| 1180 | # This needs to be a command-line program that accepts |
|---|
| 1181 | # MIME format mail messages on standard input, and mails them. |
|---|
| 1182 | # To disable all outgoing email from Foswiki leave both this field and the |
|---|
| 1183 | # MAILHOST field below blank. |
|---|
| 1184 | $Foswiki::cfg{MailProgram} = '/usr/sbin/sendmail -t -oi -oeq'; |
|---|
| 1185 | |
|---|
| 1186 | # **STRING 30** |
|---|
| 1187 | # Mail host for outgoing mail. This is only used if Net::SMTP is installed. |
|---|
| 1188 | # Examples: mail.your.company |
|---|
| 1189 | # <b>CAUTION</b> This setting can be overridden by a setting of SMTPMAILHOST |
|---|
| 1190 | # in SitePreferences. Make sure you delete that setting if you are using a |
|---|
| 1191 | # SitePreferences topic from a previous release of Foswiki. To disable all |
|---|
| 1192 | # outgoing mail from Foswiki leave both this field and the MailProgram field |
|---|
| 1193 | # above blank. If the smtp server uses a different port than the default 25 |
|---|
| 1194 | # use the syntax <tt>mail.your.company:portnumber</tt> |
|---|
| 1195 | $Foswiki::cfg{SMTP}{MAILHOST} = ''; |
|---|
| 1196 | |
|---|
| 1197 | # **STRING 30** |
|---|
| 1198 | # Mail domain sending mail, required if you are using <tt>Net::SMTP</tt>. SMTP |
|---|
| 1199 | # requires that you identify the server sending mail. If not set, |
|---|
| 1200 | # <tt>Net::SMTP</tt> will guess it for you. Example: foswiki.your.company. |
|---|
| 1201 | # <b>CAUTION</b> This setting can be overridden by a setting of %SMTPSENDERHOST% |
|---|
| 1202 | # in SitePreferences. Make sure you delete that setting. |
|---|
| 1203 | $Foswiki::cfg{SMTP}{SENDERHOST} = ''; |
|---|
| 1204 | |
|---|
| 1205 | # **STRING 30** |
|---|
| 1206 | # Username for SMTP. Only required if your server requires authentication. If |
|---|
| 1207 | # this is left blank, Foswiki will not attempt to authenticate the mail sender. |
|---|
| 1208 | $Foswiki::cfg{SMTP}{Username} = ''; |
|---|
| 1209 | |
|---|
| 1210 | # **PASSWORD 30** |
|---|
| 1211 | # Password for your {SMTP}{Username}. |
|---|
| 1212 | $Foswiki::cfg{SMTP}{Password} = ''; |
|---|
| 1213 | |
|---|
| 1214 | # **STRING 30** |
|---|
| 1215 | # Some environments require outbound HTTP traffic to go through a proxy |
|---|
| 1216 | # server. (e.g. http://proxy.your.company). |
|---|
| 1217 | # <b>CAUTION</b> This setting can be overridden by a PROXYHOST setting |
|---|
| 1218 | # in SitePreferences. Make sure you delete the setting from there if |
|---|
| 1219 | # you are using a SitePreferences topic from a previous release of Foswiki. |
|---|
| 1220 | # If your proxy requires authentication, simply put it in the URL, as in: |
|---|
| 1221 | # http://username:password@proxy.your.company. |
|---|
| 1222 | $Foswiki::cfg{PROXY}{HOST} = ''; |
|---|
| 1223 | |
|---|
| 1224 | # **STRING 30** |
|---|
| 1225 | # Some environments require outbound HTTP traffic to go through a proxy |
|---|
| 1226 | # server. Set the port number here (e.g: 8080). |
|---|
| 1227 | # <b>CAUTION</b> This setting can be overridden by a PROXYPORT setting |
|---|
| 1228 | # in SitePreferences. Make sure you delete the setting from there if you |
|---|
| 1229 | # are using a SitePreferences topic from a previous release of Foswiki. |
|---|
| 1230 | $Foswiki::cfg{PROXY}{PORT} = ''; |
|---|
| 1231 | |
|---|
| 1232 | # **BOOLEAN EXPERT** |
|---|
| 1233 | # Remove IMG tags in notification mails. |
|---|
| 1234 | $Foswiki::cfg{RemoveImgInMailnotify} = $TRUE; |
|---|
| 1235 | |
|---|
| 1236 | # **STRING 20 EXPERT** |
|---|
| 1237 | # Name of topic in each web that has notification registrations. |
|---|
| 1238 | # <b>If you change this setting you will have to |
|---|
| 1239 | # use Foswiki to manually rename the topic in all existing webs</b> |
|---|
| 1240 | $Foswiki::cfg{NotifyTopicName} = 'WebNotify'; |
|---|
| 1241 | |
|---|
| 1242 | # **BOOLEAN EXPERT** |
|---|
| 1243 | # Set this option on to enable debug |
|---|
| 1244 | # mode in SMTP. Output will go to the webserver error log. |
|---|
| 1245 | $Foswiki::cfg{SMTP}{Debug} = 0; |
|---|
| 1246 | |
|---|
| 1247 | #---+ Miscellaneous -- EXPERT |
|---|
| 1248 | # <p>Miscellaneous expert options.</p> |
|---|
| 1249 | |
|---|
| 1250 | # **STRING 20 EXPERT** |
|---|
| 1251 | # Name of the web where documentation and default preferences are held. If you |
|---|
| 1252 | # change this setting, you must make sure the web exists and contains |
|---|
| 1253 | # appropriate content, and upgrade scripts may no longer work (i.e. don't |
|---|
| 1254 | # change it unless you are certain that you know what you are doing!) |
|---|
| 1255 | $Foswiki::cfg{SystemWebName} = 'System'; |
|---|
| 1256 | |
|---|
| 1257 | # **STRING 20 EXPERT** |
|---|
| 1258 | # Name of the web used as a trashcan (where deleted topics are moved) |
|---|
| 1259 | # If you change this setting, you must make sure the web exists. |
|---|
| 1260 | $Foswiki::cfg{TrashWebName} = 'Trash'; |
|---|
| 1261 | |
|---|
| 1262 | # **STRING 20 EXPERT** |
|---|
| 1263 | # Name of site-level preferences topic in the {SystemWebName} web. |
|---|
| 1264 | # <b>If you change this setting you will have to |
|---|
| 1265 | # use Foswiki and *manually* rename the existing topic.</b> |
|---|
| 1266 | # (i.e. don't change it unless you are <b>certain</b> that you know what |
|---|
| 1267 | # you are doing!) |
|---|
| 1268 | $Foswiki::cfg{SitePrefsTopicName} = 'DefaultPreferences'; |
|---|
| 1269 | |
|---|
| 1270 | # **STRING 70 EXPERT** |
|---|
| 1271 | # Web.TopicName of the site-level local preferences topic. If this topic |
|---|
| 1272 | # exists, any settings in it will <b>override</b> settings in |
|---|
| 1273 | # {SitePrefsTopicName}.<br /> |
|---|
| 1274 | # You are <b>strongly</b> recommended to keep all your local changes in |
|---|
| 1275 | # a {LocalSitePreferences} topic rather than changing DefaultPreferences, |
|---|
| 1276 | # as it will make upgrading a lot easier. |
|---|
| 1277 | $Foswiki::cfg{LocalSitePreferences} = '$Foswiki::cfg{UsersWebName}.SitePreferences'; |
|---|
| 1278 | |
|---|
| 1279 | # **STRING 20 EXPERT** |
|---|
| 1280 | # Name of main topic in a web. |
|---|
| 1281 | # <b>If you change this setting you will have to |
|---|
| 1282 | # use Foswiki to manually rename the topic in all existing webs</b> |
|---|
| 1283 | # (i.e. don't change it unless you are <b>certain</b> that you know what |
|---|
| 1284 | # you are doing!) |
|---|
| 1285 | $Foswiki::cfg{HomeTopicName} = 'WebHome'; |
|---|
| 1286 | |
|---|
| 1287 | # **STRING 20 EXPERT** |
|---|
| 1288 | # Name of preferences topic in a web. |
|---|
| 1289 | # <b>If you change this setting you will have to |
|---|
| 1290 | # use Foswiki to manually rename the topic in all existing webs</b> |
|---|
| 1291 | # (i.e. don't change it unless you are <b>certain</b> that you know what |
|---|
| 1292 | # you are doing!) |
|---|
| 1293 | $Foswiki::cfg{WebPrefsTopicName} = 'WebPreferences'; |
|---|
| 1294 | |
|---|
| 1295 | # **STRING 20 EXPERT** |
|---|
| 1296 | # Name of the web where usertopics are stored. If you |
|---|
| 1297 | # change this setting, you must make sure the web exists and contains |
|---|
| 1298 | # appropriate content, and upgrade scripts may no longer work |
|---|
| 1299 | # (i.e. don't change it unless you are <b>certain</b> that you know what |
|---|
| 1300 | # you are doing!) |
|---|
| 1301 | $Foswiki::cfg{UsersWebName} = 'Main'; |
|---|
| 1302 | |
|---|
| 1303 | # **STRING 70x10 EXPERT** |
|---|
| 1304 | # A comma-separated list of generic file name templates, containing |
|---|
| 1305 | # placeholders <code>$name</code> (the template name), <code>$web</code> |
|---|
| 1306 | # (the web), and <code>$skin</code> (the skin(s)) |
|---|
| 1307 | # standing in for part of the file name. This path is expanded to a sequence |
|---|
| 1308 | # of file names. The first file on this list that is found is taken to be the |
|---|
| 1309 | # requested template file. The file names can either be absolute file names |
|---|
| 1310 | # ending in ".tmpl" or a topic name in a Foswiki web. |
|---|
| 1311 | # See 'Security and usability' in System.SkinTemplates for advice on |
|---|
| 1312 | # setting this path for increased security. |
|---|
| 1313 | $Foswiki::cfg{TemplatePath} = '$Foswiki::cfg{TemplateDir}/$web/$name.$skin.tmpl, $Foswiki::cfg{TemplateDir}/$name.$skin.tmpl, $web.$skinSkin$nameTemplate, $Foswiki::cfg{SystemWebName}.$skinSkin$nameTemplate, $Foswiki::cfg{TemplateDir}/$web/$name.tmpl, $Foswiki::cfg{TemplateDir}/$name.tmpl, $web.$nameTemplate, $Foswiki::cfg{SystemWebName}.$nameTemplate'; |
|---|
| 1314 | |
|---|
| 1315 | # **STRING 120 EXPERT** |
|---|
| 1316 | # List of protocols (URI schemes) that Foswiki will |
|---|
| 1317 | # automatically recognize in absolute links. |
|---|
| 1318 | # Add any extra protocols specific to your environment (for example, you might |
|---|
| 1319 | # add 'imap' or 'pop' if you are using shared mailboxes accessible through |
|---|
| 1320 | # your browser, or 'tel' if you have a softphone setup that supports links |
|---|
| 1321 | # using this URI scheme). A list of popular URI schemes can be |
|---|
| 1322 | # found at <a href="http://en.wikipedia.org/wiki/URI_scheme">http://en.wikipedia.org/wiki/URI_scheme</a>. |
|---|
| 1323 | $Foswiki::cfg{LinkProtocolPattern} = '(file|ftp|gopher|https|http|irc|mailto|news|nntp|telnet)'; |
|---|
| 1324 | |
|---|
| 1325 | # **BOOLEAN EXPERT** |
|---|
| 1326 | # 'Anchors' are positions within a Foswiki page that can be targeted in |
|---|
| 1327 | # a URL using the <tt>#anchor</tt> syntax. The format of these anchors has |
|---|
| 1328 | # changed several times. If this option is set, Foswiki will generate extra |
|---|
| 1329 | # redundant anchors that are compatible with the old formats. If it is not |
|---|
| 1330 | # set, the links will still work but will go to the head of the target page. |
|---|
| 1331 | # There is a small performance cost for enabling this option. Set it if |
|---|
| 1332 | # your site has been around for a long time, and you want existing external |
|---|
| 1333 | # links to the internals of pages to continue to work. |
|---|
| 1334 | $Foswiki::cfg{RequireCompatibleAnchors} = 0; |
|---|
| 1335 | |
|---|
| 1336 | # **NUMBER EXPERT** |
|---|
| 1337 | # How many links to other revisions to show in the bottom bar. 0 for all |
|---|
| 1338 | $Foswiki::cfg{NumberOfRevisions} = 4; |
|---|
| 1339 | |
|---|
| 1340 | # **NUMBER EXPERT** |
|---|
| 1341 | # Set the upper limit of the maximum number of difference that will be |
|---|
| 1342 | # displayed when viewing the entire history of a page. The compared revisions |
|---|
| 1343 | # will be evenly spaced across the history of the page e.g. if the page has |
|---|
| 1344 | # 100 revisions and we have set this option to 10, we will see differences |
|---|
| 1345 | # between r100 and r90, r90 and r80, r80 and r70 and so on. |
|---|
| 1346 | $Foswiki::cfg{MaxRevisionsInADiff} = 25; |
|---|
| 1347 | |
|---|
| 1348 | # **NUMBER EXPERT** |
|---|
| 1349 | # If this is set to a > 0 value, and the revision control system |
|---|
| 1350 | # supports it (RCS does), then if a second edit of the same topic |
|---|
| 1351 | # is done by the same user within this number of seconds, a new |
|---|
| 1352 | # revision of the topic will NOT be created (the top revision will |
|---|
| 1353 | # be replaced). Set this to 0 if you want <b>all</b> topic changes to create |
|---|
| 1354 | # a new revision (as required by most formal development processes). |
|---|
| 1355 | $Foswiki::cfg{ReplaceIfEditedAgainWithin} = 3600; |
|---|
| 1356 | |
|---|
| 1357 | # **NUMBER EXPERT** |
|---|
| 1358 | # When a topic is edited, the user takes a "lease" on that topic. |
|---|
| 1359 | # If another user tries to also edit the topic while the lease |
|---|
| 1360 | # is still active, they will get a warning. Leases are released |
|---|
| 1361 | # automatically when the topic is saved; otherwise they remain active |
|---|
| 1362 | # for {LeaseLength} seconds from when the edit started (or was checkpointed). |
|---|
| 1363 | # <p />Note: Leases are <b>not</b> locks; they are purely advisory. Leases |
|---|
| 1364 | # can always be broken, but they are valuable if you want to avoid merge |
|---|
| 1365 | # conflicts (e.g. you use highly structured data in your topic text and |
|---|
| 1366 | # want to avoid ever having to deal with conflicts) |
|---|
| 1367 | # <p />Since Foswiki 1.0.6, Foswiki pages that can be used to POST to the |
|---|
| 1368 | # server have a validation key, that must be sent to the server for the |
|---|
| 1369 | # post to succeed. These validation keys can only be used once, and expire |
|---|
| 1370 | # at the same time as the lease expires. |
|---|
| 1371 | $Foswiki::cfg{LeaseLength} = 3600; |
|---|
| 1372 | |
|---|
| 1373 | # **NUMBER EXPERT** |
|---|
| 1374 | # Even if the other users' lease has expired, then you can specify that |
|---|
| 1375 | # they should still get a (less forceful) warning about the old lease for |
|---|
| 1376 | # some additional time after the lease expired. You can set this to 0 to |
|---|
| 1377 | # suppress these extra warnings completely, or to -1 so they are always |
|---|
| 1378 | # issued, or to a number of seconds since the old lease expired. |
|---|
| 1379 | $Foswiki::cfg{LeaseLengthLessForceful} = 3600; |
|---|
| 1380 | |
|---|
| 1381 | # **PATH EXPERT** |
|---|
| 1382 | # Pathname to file that maps file suffixes to MIME types : |
|---|
| 1383 | # For Apache server set this to Apache's mime.types file pathname, |
|---|
| 1384 | # for example /etc/httpd/mime.types, or use the default shipped in |
|---|
| 1385 | # the Foswiki data directory. |
|---|
| 1386 | $Foswiki::cfg{MimeTypesFileName} = '$Foswiki::cfg{DataDir}/mime.types'; |
|---|
| 1387 | |
|---|
| 1388 | # **BOOLEAN EXPERT** |
|---|
| 1389 | # If set, this will cause Foswiki to treat warnings as errors that will |
|---|
| 1390 | # cause Foswiki to die. Provided for use by Plugin and Skin developers, |
|---|
| 1391 | # who should develop with it switched on. |
|---|
| 1392 | $Foswiki::cfg{WarningsAreErrors} = $FALSE; |
|---|
| 1393 | |
|---|
| 1394 | # **PERL H** |
|---|
| 1395 | # List of operators permitted in structured search queries. |
|---|
| 1396 | # Each operator is implemented by a class. Not visible in the |
|---|
| 1397 | # configure UI. |
|---|
| 1398 | $Foswiki::cfg{Operators}{Query} = [ 'Foswiki::Query::OP_match', 'Foswiki::Query::OP_and', 'Foswiki::Query::OP_eq', 'Foswiki::Query::OP_lc', 'Foswiki::Query::OP_lte', 'Foswiki::Query::OP_not', 'Foswiki::Query::OP_ref', 'Foswiki::Query::OP_d2n', 'Foswiki::Query::OP_gte', 'Foswiki::Query::OP_length', 'Foswiki::Query::OP_lt', 'Foswiki::Query::OP_ob', 'Foswiki::Query::OP_uc', 'Foswiki::Query::OP_dot', 'Foswiki::Query::OP_gt', 'Foswiki::Query::OP_like', 'Foswiki::Query::OP_ne', 'Foswiki::Query::OP_or', 'Foswiki::Query::OP_where' ]; |
|---|
| 1399 | |
|---|
| 1400 | # **PERL H** |
|---|
| 1401 | # List of operators permitted in %IF statements. |
|---|
| 1402 | # Each operator is implemented by a class. Not visible in the |
|---|
| 1403 | # configure UI. |
|---|
| 1404 | $Foswiki::cfg{Operators}{If} = [ 'Foswiki::If::OP_allows', 'Foswiki::If::OP_defined', 'Foswiki::If::OP_isempty','Foswiki::If::OP_ingroup', 'Foswiki::If::OP_isweb', 'Foswiki::If::OP_context', 'Foswiki::If::OP_dollar', 'Foswiki::If::OP_istopic' ]; |
|---|
| 1405 | |
|---|
| 1406 | #---+ Extensions -- TABS |
|---|
| 1407 | |
|---|
| 1408 | #---++ Install and update extensions |
|---|
| 1409 | # <p>Consult online extensions repositories for new extensions, or check and manage updates.</p> |
|---|
| 1410 | # |
|---|
| 1411 | # **STRING 80 EXPERT** |
|---|
| 1412 | # <b>Extensions Repositories Search List</b><br /> |
|---|
| 1413 | # Foswiki extension repositories are just Foswiki webs that are organised in the |
|---|
| 1414 | # same way as the Extensions web on Foswiki.org. The 'Find more extensions' link |
|---|
| 1415 | # above searches these repositories for installable extensions. To set up an |
|---|
| 1416 | # extensions repository: |
|---|
| 1417 | # <ol> |
|---|
| 1418 | # <li>Create a Foswiki web to contain the repository</li> |
|---|
| 1419 | # <li>Copy the <tt>FastReport</tt> page from <a href="http://foswiki.org/Extensions/FastReport?raw=on" target="_new">Foswiki:Extensions.FastReport</a> to your new web</li> |
|---|
| 1420 | # <li> Set the <tt>WEBFORMS</tt> preference in WebPreferences to <tt>PackageForm</tt></li> |
|---|
| 1421 | # </ol> |
|---|
| 1422 | # The page for each extension must have the <tt>PackageForm</tt> (copy from Foswiki.org), |
|---|
| 1423 | # and should have the packaged extension attached as a <tt>zip</tt> and/or |
|---|
| 1424 | # <tt>tgz</tt> file. |
|---|
| 1425 | # <p /> |
|---|
| 1426 | # The search list is a semicolon-separated list of repository specifications, each in the format: <i>name=(listurl,puburl,username,password)</i> |
|---|
| 1427 | # where: |
|---|
| 1428 | # <ul> |
|---|
| 1429 | # <li><code>name</code> is the symbolic name of the repository e.g. Foswiki.org</li> |
|---|
| 1430 | # <li><code>listurl</code> is the root of a view URL</li> |
|---|
| 1431 | # <li><code>puburl</code> is the root of a download URL</li> |
|---|
| 1432 | # <li><code>username</code> is the username if TemplateAuth is required on the repository (optional)</li> |
|---|
| 1433 | # <li><code>password</code> is the password if TemplateAuth is required on the repository (optional)</li> |
|---|
| 1434 | # </ul> |
|---|
| 1435 | # Note: if your Repository uses ApacheAuth, embed the username and password into the listurl as <code>?username=x;password=y</code> |
|---|
| 1436 | # <p /> |
|---|
| 1437 | # For example,<code> |
|---|
| 1438 | # twiki.org=(http://twiki.org/cgi-bin/view/Plugins/,http://twiki.org/p/pub/Plugins/); foswiki.org=(http://foswiki.org/Extensions/,http://foswiki.org/pub/Extensions/);</code><p /> |
|---|
| 1439 | # For Extensions with the same name in more than one repository, the <strong>last</strong> matching repository in the list will be chosen, so Foswiki.org should always be last in the list for maximum compatibility. |
|---|
| 1440 | $Foswiki::cfg{ExtensionsRepositories} = 'Foswiki.org=(http://foswiki.org/Extensions/,http://foswiki.org/pub/Extensions/)'; |
|---|
| 1441 | |
|---|
| 1442 | # *FINDEXTENSIONS* Marker used by bin/configure script - do not remove! |
|---|
| 1443 | |
|---|
| 1444 | |
|---|
| 1445 | #---++ Enabled plugins |
|---|
| 1446 | # *PLUGINS* Marker used by bin/configure script - do not remove! |
|---|
| 1447 | # <p>The plugins listed below were discovered by searching the <code>@INC</code> |
|---|
| 1448 | # path for modules that match the Foswiki standard e.g. |
|---|
| 1449 | # <code>Foswiki/Plugins/MyPlugin.pm</code> or the TWiki standard i.e. |
|---|
| 1450 | # <code>TWiki/Plugins/YourPlugin.pm</code></p> |
|---|
| 1451 | # <p>Any plugins enabled in the configuration but not found in the <code>@INC</code> |
|---|
| 1452 | # path are listed at the end and are flagged as errors in the PluginsOrder check.</p> |
|---|
| 1453 | # **STRING 80** |
|---|
| 1454 | # Plugins evaluation order. If set to a comma-separated list of plugin names, |
|---|
| 1455 | # will change the execution order of plugins so the listed subset of plugins |
|---|
| 1456 | # are executed first. The default execution order is alphabetical on plugin |
|---|
| 1457 | # name. <br/><br/> |
|---|
| 1458 | # |
|---|
| 1459 | # If TWiki compatibility is required, TWikiCompatibilityPlugin should be the first |
|---|
| 1460 | # Plugin in the list. SpreadSheetPlugin should typically be next in the list for proper operation.<br/><br/> |
|---|
| 1461 | # |
|---|
| 1462 | # Note that some other general extension environment checks are made and reported here. Plugins |
|---|
| 1463 | # that are enabled but not installed and duplicate plugins in the TWiki and Foswiki libraries |
|---|
| 1464 | # are reported here. Also if a TWiki plugin is enabled and the Foswik version is installed, this |
|---|
| 1465 | # will also be reported here. Expand the "Expert" options to find these issues. |
|---|
| 1466 | # |
|---|
| 1467 | $Foswiki::cfg{PluginsOrder} = 'TWikiCompatibilityPlugin,SpreadSheetPlugin'; |
|---|
| 1468 | |
|---|
| 1469 | $Foswiki::cfg{Plugins}{PreferencesPlugin}{Enabled} = 1; |
|---|
| 1470 | $Foswiki::cfg{Plugins}{PreferencesPlugin}{Module} = 'Foswiki::Plugins::PreferencesPlugin'; |
|---|
| 1471 | $Foswiki::cfg{Plugins}{SmiliesPlugin}{Enabled} = 1; |
|---|
| 1472 | $Foswiki::cfg{Plugins}{SmiliesPlugin}{Module} = 'Foswiki::Plugins::SmiliesPlugin'; |
|---|
| 1473 | $Foswiki::cfg{Plugins}{CommentPlugin}{Enabled} = 1; |
|---|
| 1474 | $Foswiki::cfg{Plugins}{CommentPlugin}{Module} = 'Foswiki::Plugins::CommentPlugin'; |
|---|
| 1475 | $Foswiki::cfg{Plugins}{SpreadSheetPlugin}{Enabled} = 1; |
|---|
| 1476 | $Foswiki::cfg{Plugins}{SpreadSheetPlugin}{Module} = 'Foswiki::Plugins::SpreadSheetPlugin'; |
|---|
| 1477 | $Foswiki::cfg{Plugins}{InterwikiPlugin}{Enabled} = 1; |
|---|
| 1478 | $Foswiki::cfg{Plugins}{InterwikiPlugin}{Module} = 'Foswiki::Plugins::InterwikiPlugin'; |
|---|
| 1479 | $Foswiki::cfg{Plugins}{TablePlugin}{Enabled} = 1; |
|---|
| 1480 | $Foswiki::cfg{Plugins}{TablePlugin}{Module} = 'Foswiki::Plugins::TablePlugin'; |
|---|
| 1481 | $Foswiki::cfg{Plugins}{EditTablePlugin}{Enabled} = 1; |
|---|
| 1482 | $Foswiki::cfg{Plugins}{EditTablePlugin}{Module} = 'Foswiki::Plugins::EditTablePlugin'; |
|---|
| 1483 | $Foswiki::cfg{Plugins}{SlideShowPlugin}{Enabled} = 1; |
|---|
| 1484 | $Foswiki::cfg{Plugins}{SlideShowPlugin}{Module} = 'Foswiki::Plugins::SlideShowPlugin'; |
|---|
| 1485 | $Foswiki::cfg{Plugins}{TwistyPlugin}{Enabled} = 1; |
|---|
| 1486 | $Foswiki::cfg{Plugins}{TwistyPlugin}{Module} = 'Foswiki::Plugins::TwistyPlugin'; |
|---|
| 1487 | $Foswiki::cfg{Plugins}{TinyMCEPlugin}{Enabled} = 1; |
|---|
| 1488 | $Foswiki::cfg{Plugins}{TinyMCEPlugin}{Module} = 'Foswiki::Plugins::TinyMCEPlugin'; |
|---|
| 1489 | $Foswiki::cfg{Plugins}{WysiwygPlugin}{Enabled} = 1; |
|---|
| 1490 | $Foswiki::cfg{Plugins}{WysiwygPlugin}{Module} = 'Foswiki::Plugins::WysiwygPlugin'; |
|---|
| 1491 | $Foswiki::cfg{Plugins}{TWikiCompatibilityPlugin}{Enabled} = 0; |
|---|
| 1492 | $Foswiki::cfg{Plugins}{TWikiCompatibilityPlugin}{Module} = 'Foswiki::Plugins::TWikiCompatibilityPlugin'; |
|---|
| 1493 | $Foswiki::cfg{Plugins}{AutoViewTemplatePlugin}{Enabled} = 1; |
|---|
| 1494 | $Foswiki::cfg{Plugins}{AutoViewTemplatePlugin}{Module} = 'Foswiki::Plugins::AutoViewTemplatePlugin'; |
|---|
| 1495 | $Foswiki::cfg{Plugins}{CompareRevisionsAddonPlugin}{Enabled} = 1; |
|---|
| 1496 | $Foswiki::cfg{Plugins}{CompareRevisionsAddonPlugin}{Module} = 'Foswiki::Plugins::CompareRevisionsAddonPlugin'; |
|---|
| 1497 | $Foswiki::cfg{Plugins}{HistoryPlugin}{Enabled} = 1; |
|---|
| 1498 | $Foswiki::cfg{Plugins}{HistoryPlugin}{Module} = 'Foswiki::Plugins::HistoryPlugin'; |
|---|
| 1499 | $Foswiki::cfg{Plugins}{JQueryPlugin}{Enabled} = 1; |
|---|
| 1500 | $Foswiki::cfg{Plugins}{JQueryPlugin}{Module} = 'Foswiki::Plugins::JQueryPlugin'; |
|---|
| 1501 | $Foswiki::cfg{Plugins}{RenderListPlugin}{Enabled} = 1; |
|---|
| 1502 | $Foswiki::cfg{Plugins}{RenderListPlugin}{Module} = 'Foswiki::Plugins::RenderListPlugin'; |
|---|
| 1503 | $Foswiki::cfg{Plugins}{MailerContribPlugin}{Enabled} = 1; |
|---|
| 1504 | $Foswiki::cfg{Plugins}{MailerContribPlugin}{Module} = 'Foswiki::Plugins::MailerContribPlugin'; |
|---|
| 1505 | |
|---|
| 1506 | #---++ Plugin settings |
|---|
| 1507 | # **STRING 80 EXPERT** |
|---|
| 1508 | # Search path (web names) for plugin topics. Note that the session web |
|---|
| 1509 | # is searched last, after this list. |
|---|
| 1510 | $Foswiki::cfg{Plugins}{WebSearchPath} = '$Foswiki::cfg{SystemWebName},TWiki'; |
|---|
| 1511 | |
|---|
| 1512 | 1; |
|---|
| 1513 | __END__ |
|---|
| 1514 | # |
|---|
| 1515 | # Copyright (C) 2008-2009 Foswiki Contributors. Foswiki Contributors |
|---|
| 1516 | # are listed in the AUTHORS file in the root of this distribution. |
|---|
| 1517 | # NOTE: Please extend that file, not this notice. |
|---|
| 1518 | # |
|---|
| 1519 | # Additional copyrights apply to some or all of the code in this module |
|---|
| 1520 | # as follows: |
|---|
| 1521 | # Copyright (C) 1999-2007 Peter Thoeny, peter@thoeny.org and |
|---|
| 1522 | # TWiki Contributors.# All Rights Reserved. |
|---|
| 1523 | # |
|---|
| 1524 | # This program is free software; you can redistribute it and/or |
|---|
| 1525 | # modify it under the terms of the GNU General Public License |
|---|
| 1526 | # as published by the Free Software Foundation; either version 2 |
|---|
| 1527 | # of the License, or (at your option) any later version. For |
|---|
| 1528 | # more details read LICENSE in the root of this distribution. |
|---|
| 1529 | # |
|---|
| 1530 | # As per the GPL, removal of this notice is prohibited. |
|---|