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