source: trunk/core/lib/Foswiki.spec @ 8607

Revision 8607, 73.1 KB checked in by CrawfordCurrie, 3 years ago (diff)

Item9508: control display of extra password confirmation field; not required where the password is only used to verify an existing user for user profile data capture

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