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