Wiki source code of Configuration

Version 57.2 by Vincent Massol on 2010/05/03

Show last authors
1 One you have XWiki [[installed>>Installation]] you'll want to configure it. Configuration can be done in 2 ways:
2
3 * by stopping the XWiki instance and editing the ##xwiki/WEB-INF/xwiki.cfg## file, and then restarting XWiki
4 * by logging in as a user with admin rights and going to the Administration page (when using the XWiki 1.0 skin, there's a an "Administration" link in the top right corner of the screen - You can also go directly to ##[[http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences]]##). This allows to keep the Server running while making the changes.
5
6 Note that some configurations are only accessible from the ##xwiki.cfg## file and have no equivalent on the Administration page.
7
8 You can verify some basic settings of your XWiki install (on Tomcat, MySQL) using the [[check Config and Indexes application>>code:Applications.CheckConfigAndIndexesApplication]].
9
10 There are various things you can configure:
11
12 {{toc/}}
13
14 = Enable superadmin account =
15
16 Edit the ##xwiki.cfg## file and enable the ##xwiki.superadminpassword## property. For example:
17
18 {{code language="none"}}
19 # Enable to allow superadmin. It is disabled by default as this could be a security breach if
20 # it were set and you forgot about it.
21 xwiki.superadminpassword=system
22 {{/code}}
23
24 When logging in, the username will be "superadmin" and the password will be the one you set in the ##xwiki.superadminpassword## property.
25
26 = Language settings =
27
28 To define the default language for your wiki go to the Administration page and in the Preferences tag locate the "Default Language" field and enter the language code for the language you wish to use. For example: "en" for English, "fr" for French, "de" for German, etc.
29
30 In addition you can configure you wiki to be multilingual. See the [[I18 user page>>Features.I18N]] for more information.
31
32 Last, you can also force your wiki to display only in one of the languages specified in the settings, by editing your ##WEB-INF/xwiki.cfg## file. Search for the "Internationalization" section, and you should see two commented settings that you can uncomment and set to 1:
33
34 {{code language="none"}}
35 #-# By default, XWiki chooses the language specified by the client (browser) in the Accept-Language HTTP header. This
36 #-# allows to use the default language of the wiki when the user didn't manually choose a language.
37 # xwiki.language.preferDefault=0
38
39 #-# Force only one of the supported languages to be accepted.
40 # xwiki.language.forceSupported=0
41 {{/code}}
42
43 = Date format =
44
45 To define the date format used in the interfaces, go to //Administration// / //General//, locate the "Date format" field and enter the date format you wish to use. Examples:
46
47 |=Format|=Result
48 |MMMM dd, HH:mm|January 27, 12:27
49 |yyyy/MM/dd, HH:mm|2009/01/27, 12:27
50 |dd/MM/yyyy, HH:mm|27/01/2009, 12:27
51
52 [[More information about date formatting>>http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html]].
53
54 = Wiki Access Configuration =
55
56 The first thing you will want to do is configure a policy access for your wiki. Depending on what you intend to use your wiki for, you have several options:
57
58 * [[Open Wiki>>#HOpenWiki]]: anyone can edit pages (including non registered users)
59 * [[Public Wiki>>#HPublicWiki]]: only registered users can edit pages but registration is open to anyone. This is the default configuration of the default wiki (the wiki provided as a XAR on the [[download page>>xwiki:Main.Download]]).
60 * [[Private Wiki with password>>#HPrivateWikiwithpassword]]: registration is closed
61 * [[Private Wiki with token for registering>>#HPrivateWikiwithtoken]]: registration is closed but users knowing the token can register
62
63 == Open Wiki ==
64
65 TODO
66
67 == Public Wiki ==
68
69 Nothing to do. This is the default Way. If you want that only people with a verified Email Address can edit pages, you have to set "Use email verification" AND "Check Active fields for user authentication" to "Yes" in Administration/Registration.
70
71 === Requiring guests to fill out a captcha in order to comment (Since: [[Enterprise 2.3M1>>xwiki:Main.ReleaseNotesXWikiEnterprise23M1]]) ===
72 It is nice to allow guests to comment on a page, often the most helpful people are unwilling to go to the bother of registration and it creates a more open atmosphere. Unfortunately comments can contain links which can be used as a vector for search engine spam. To keep your site open while preventing automated commenting, you can require guests to fill out a captcha before commenting. The captcha will not be displayed or even loaded until they click on the comment window to type their message so you need not worry about guests' idle surfing causing the [[captcha module>>code:Modules.CaptchaModule]] to use too much of your server's CPU power.
73
74 You can require guests to fill out a captcha for posting comments on a wiki or space level. You can require it on the wiki level but remove that requirement for a single space, or you can require it only for one or more spaces but not the entire wiki.
75 To turn on comment captcha requirement, go to wiki or space administration, click on the "Rights" section and notice the checkbox toward the bottom labeled "Require unregistered users to solve a captcha when posting a comment on a page". Check that box and guests will be required to solve a captcha to comment.
76 **Note:** This setting does not allow guests to comment, it only denies them permission to comment without a captcha on pages where they already had it. To allow commenting, you will have to check the normal "allow comment" checkbox for unregistered users.
77
78 Result:
79 image:CommentCaptcha.png
80
81 == Private Wiki with password ==
82
83 === Global rights ===
84
85 In [[Global rights>>http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences?editor=globalrights&global=1]] set **User:XWikiGuest, Groups:, Level:register, Allow-Deny:Allow**.
86
87 === Registration ===
88
89 In [[Preferences>>http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences]] under **Registration** set **Use email verification:yes**. fill the other fields appropriately.
90
91 == Private Wiki with token ==
92
93 TODO
94
95 * **[[Find out more about XWiki access rights here>>Access Rights]]**
96
97 = Enabling/Disabling Statistics =
98
99 To disable [[the Statistics feature>>code:Applications.StatisticsApplication]], edit your //xwiki.cfg// file and replace the following properties as shown here:
100 {{code language="xml"}}
101 xwiki.stats=0
102 xwiki.stats.default=0
103 {{/code}}
104
105 where:
106
107 * //xwiki.stats// controls whether Statistics are on or off
108 * //xwiki.stats.default// controls whether Statistics are on or off by default for the current Wiki. This is useful in [[Virtual Wiki mode>>AdminGuide.Virtualization]]. A wiki can decide whether Statistics is on/off by setting the "statistics" field in XWiki.XWikiPreferences. If no such field is defined the the default value //xwiki.stats.default// is used.
109
110 To enable Statistics, change "0" to "1".
111
112 = Optional Store Features =
113
114 == Document versioning ==
115
116 One of the key features of a wiki engine is the ability to keep all the history of a document, giving users the ability to see the evolution of a document, but also to revert changes. However, the history of an active wiki continuously grows and is usually much larger than the current version of the data. It is possible to disable the versioning feature in XWiki, which means that less storage space will be used, although it will not be possible to revert the document in case of vandalism.
117
118 To disable the versioning store, edit //xwiki.cfg// and add:
119 {{code}}
120 xwiki.store.versioning=0
121 {{/code}}
122
123 == Attachment versioning ==
124
125 XWiki stores all document attachment versions by default. This is very memory consuming (both RAM and HDD). If you need only latest versions of attachments, you can disable attachment version control by editing your //xwiki.cfg// and adding:
126 {{code}}
127 xwiki.store.attachment.versioning=0
128 {{/code}}
129
130 == Document recycle bin ==
131
132 By default deleted documents are not permanently removed, but are placed in a //recycle bin//, from which they can later be removed or restored. To disable it, edit //xwiki.cfg// and add:
133
134 {{code}}
135 xwiki.recyclebin=0
136 {{/code}}
137
138 Note that disabling it will make it impossible to restore a deleted document, unless a database backup is available.
139
140 By default, a deleted document can be permanently deleted right away by administrators, and after 7 days by regular users. To change these limits, edit //xwiki.cfg// and add:
141
142 {{code}}
143 # Admins must wait 3 days before being allowed to permanently delete
144 xwiki.store.recyclebin.adminWaitDays=3
145 # Normal users must also wait 3 days
146 xwiki.store.recyclebin.waitDays=3
147 {{/code}}
148
149 == Attachment recycle bin ==
150
151 Deleted attachments are also stored in a recycle bin, so that they can be restored along with the document when rolling back or previewing an earlier version in which the attachment should be visible. To disable this feature, edit //xwiki.cfg// and add:
152
153 {{code}}
154 storage.attachment.recyclebin=0
155 {{/code}}
156
157 = Customizing the Skin =
158
159 See the [[Skin Guide>>AdminGuide.Skins]].
160
161 = Security configuration =
162
163 See the [[Security Guide>>AdminGuide.Security]].
164
165 = Customizing Menus =
166
167 The first thing to understand is that menus depend on the skin you're using. If you're using the 1.0 skin it's likely you're using the [[Panels Application>>code:Applications.PanelsApplication]] to provide the different menu panels you see on the left or right of your wikis. Check the [[Panels Application>>code:Applications.PanelsApplication]] to know more on how to configure/modify them.
168
169 = Encoding =
170
171 See the [[Encoding Guide>>AdminGuide.Encoding]].
172
173 = User Authentication =
174
175 See the [[Authentication Guide>>AdminGuide.Authentication]].
176
177 = Customizing the registration page (2.1 and older) =
178
179 The default registration page is defined as a template on the file system (named ##registerinline.vm##). However it's possible to easily override it by creating a page named ##XWiki.Registration##.
180
181 See [[more details about configuring the registration page>>AdminGuide.User Management#HCustomizingtheRegistrationpage]].
182
183 == Customizing the Verified Registration Page (Since 2.2M2) ==
184
185 The Verified Registration Page is part of the [[Administration Application>>code:Applications.AdministrationApplication]] and allows you to require users to fill in a captcha and validates user input on both the server side and the client side using Javascript. The configuration allows you to add fields and add validation constraints to the fields which are there.
186
187 (Since 2.3M1)
188 To turn on captcha you simply go to the administration page, click Registration and you will find a checkbox for turning on captcha along with other registation page related settings.
189
190 To turn on captcha support in version 2.2 you have to edit your [[xwiki.properties>>#HSamplexwikiproperties]] file. You will find this in xwiki/WEB-INF/xwiki.properties you need to add a line which says:
191
192 {{code}}
193 captcha.enabled=true
194 {{/code}}
195
196 Then the registration page will require captchas.
197
198 For more information about configuring the registration page you can visit the page on the [[Administration Application>>code:Applications.AdministrationApplication]].
199
200 = Initial Groups =
201 You can set the default groups which new users will automatically be added to by changing the ##xwiki.users.initialGroups## parameter in your [[xwiki.cfg>>#HSamplexwikicfg]] file. To make all new users be added to the groups **XWiki.CoolPeople** and **XWiki.CommunityMembers** you would set the ##initialGroups## parameter like this:
202
203 {{code language=none}}
204 xwiki.users.initialGroups=XWiki.CoolPeople, XWiki.CommunityMembers
205 {{/code}}
206
207 * Current members will not be automatically be added to these groups, only new members.
208 * The groups have to be created before being specified as initial groups.
209
210 = Logging =
211
212 See the [[Logging page>>Logging]].
213
214 = Configuring Interwiki links =
215
216 [[Interwiki linking>>http://en.wikipedia.org/wiki/InterWiki]] is a short hand syntax for linking to pages on other websites. For example, you could link to http://en.wikipedia.org/wiki/InterWiki just by typing [InterWiki@WikiPedia].
217
218 Since XWiki renders wiki syntax using the [[Radeox>>http://radeox.org]] engine, it supports Interwiki links in [[much the same way as SnipSnap>>http://snipsnap.org/space/InterWiki+HowTo]].
219
220 To configure Interwiki links on your wiki:
221
222 * Create a file named ##[location from where you start your container]/conf/**intermap.txt**##
223 * Fill ##intermap.txt## with content like:
224 {{code}}
225 IMDB http://us.imdb.com/Title?
226 OpenWiki http://openwiki.com/?
227 SourceForge http://sourceforge.net/
228 TWiki http://twiki.org/cgi-bin/view/
229 Why http://clublet.com/c/c/why?
230 Wiki http://c2.com/cgi/wiki?
231 WikiPedia http://www.wikipedia.com/wiki/
232 {{/code}}
233
234 You can of course add your own entries.
235
236 * Note that Radeox's parser for intermap.txt is [[very fragile>>http://snipforge.org/jira/browse/RADEOX-49]]. A blank line at the bottom of the file is enough to make it fall over.
237 * Restart XWiki (you'll need to restart XWiki every time you change ##intermap.txt##) and try out an Interwiki link.
238 * If it does not work, check your ##xwiki.log## file. You'll see if ##conf/intermap.txt## could not be found, or if there was an error parsing it.
239
240 = Setting the default editor to use (Wiki or WYSIWYG) =
241
242 Go the Administration screen, then click on the "General" icon and select the default editor to use, as shown on the following screenshot:
243
244 image:defaulteditor.png
245
246 = Configure the WYSIWYG editor =
247
248 See [[WYSIWYG Editor Configuration>>WysiwygEditor]] page to find out how you can enable or disable editing features.
249
250 = Short URLs =
251
252 It's possible to [[configure XWiki so that is uses shorter URLs>>Main.ShortURLs]].
253
254 = Configure the names of database schemas (since 1.6M1) =
255
256 Sometimes, especially in enterprise environment, we need control names of database schemes, other than default.
257
258 * xwiki.db ~-~- name of database scheme of main wiki (including the name of the wiki in a non-virtual environment, otherwise the database name comes from hibernate configuration file).
259 * xwiki.db.prefix ~-~- usefull mainly for [[virtual wikies>>Virtualization]], where we have database scheme for each virtual wiki. This prefix is added to database scheme name after usual mapping between wiki names and schemes. Note that this is also applying to main wiki database name.
260
261 = Turning off comments or attachments =
262
263 You need to change the XWiki.XWikiPreferences class like this:
264
265 * Go to ##<server>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class##
266 * Add a new property called ##showcomments## (or ##showattachments## for turning off attachments) of type String Class
267 * Go to ##<server>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences## and write no in the ##showcomments## (or ##showattachments##) field
268
269 That's it, the comments (or attachments) are gone. If you want to re-enable them, replace the "no" value with "yes".
270
271 = Configure edit comment behavior =
272
273 When page editing you can add a comment of changes in special comment field by default (Look at [[Features.PageEditing#HCommoneditactions]]). You can disable this feature by set //xwiki.editcomment=0// in //xwiki.cfg//.
274
275 When edit comment feature is enabled, you also can set edit comment mandatory by set //xwiki.editcomment.mandatory=1// in //xwiki.cfg//. This will show popup window with the request to set edit comment if there is no comment entered. It doesn't allow to set empty comment. If you want a popup, but want to be able to set empty edit comment, set //xwiki.editcomment.suggested=1// in //xwiki.cfg//
276
277 If you set edit comment as mandatory or suggested, you can also remove comment field from page editing form and use only popup window for set edit comment. Set //xwiki.editcomment.hidden=0// in //xwiki.cfg// to do this.
278
279 You can use the special fields in //XWikiPreferences// object instead of edit //xwiki.cfg//. These fields are: //editcomment//, //editcomment_mandatory//, //editcomment_suggested// and //editcomment_hidden//.
280
281 = Configuring the SMTP server =
282
283 If you're planning to use XWiki's feature that send emails you'll need to configure the SMTP server used and the email address under which XWiki will send emails.
284
285 To configure these go to the Administration page (##[[http://<server>/xwiki/bin/admin/XWiki/XWikiPreferences]]##), click on the "general" icon and modify the ##Admin email## field to set the email under which XWiki emails will be sent and modify the ##Outgoing SMTP Server## field to set the SMTP server to use, as shown on the figure below.
286
287 image:emailconfiguration.png
288
289 == Configuring authentication for SMTP ==
290
291 {{warning}}These instructions are now obsolete{{/warning}}
292
293 By default, the username/password fields are not available in the preferences. In order to configure the SMTP authentication, you must:
294
295 * Edit the ##XWiki.XWikiPreferences## class (##/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class##) and add two ##String## fields, named ##smtp_server_username## and ##smtp_server_password##.
296 * Edit the ##XWiki.XWikiPreferences## object (##/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences&nb=0&property=smtp_server_username,smtp_server_password##) and enter the required username and password in the newly added fields.
297
298 == Configuring TLS for the connection to the server ==
299
300 {{warning}}These instructions are now obsolete{{/warning}}
301
302 In order to enable TLS, you must:
303
304 * Edit the ##XWiki.XWikiPreferences## class (##/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class##) and add a ##TextArea## field, named ##javamail_extra_props ##.
305 * Edit the ##XWiki.XWikiPreferences## object (##/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences&nb=0&property=javamail_extra_props##) and enter: ##mail.smtp.starttls.enable=true##
306
307 == Using Google SMTP server ==
308
309 |=property|=value
310 |server|smtp.gmail.com
311 |port|587
312 |user|[email protected]
313 |password|xakep
314 |JavaMail properties|mail.smtp.starttls.enable=true
315
316 = Configuring WebDAV (since 1.7) =
317
318 WebDAV support has been added to XWiki beginning from XWiki Enterprise 1.7. It is very important to note that WebDAV is enabled by default.
319
320 == Securing WebDAV Server ==
321
322 XWiki's WebDAV implementation only supports [[Basic Access Authentication>>http://en.wikipedia.org/wiki/Basic_access_authentication]] scheme for authenticating WebDAV clients. Because of this reason it is highly recommended that you employ a transport level security mechanism like SSL to protect your clients. You may consult your web application container's documentation to see how this can be achieved.
323
324 == Disabling WebDAV ==
325
326 To disable WebDAV support in your XWiki server, simply edit your web.xml file and remove the url-mapping element for mapping webdav requests. The url-mapping element for WebDAV looks something like:
327
328 {{code language="xml"}}
329 <servlet-mapping>
330 <servlet-name>webdav</servlet-name>
331 <url-pattern>/webdav/*</url-pattern>
332 </servlet-mapping>
333 {{/code}}
334
335
336
337 = Redirections =
338
339 XWiki supports defining redirections for incoming requests. To activate this feature modify your ##xwiki.cfg## file and set the following property:
340 {{code}}
341 xwiki.preferences.redirect=1
342 {{/code}}
343
344 Then for each redirection you want to add, add a ##XWiki.GlobalRedirect## object to your main wiki's ##XWiki.XWikiPreferences## document. The ##XWiki.GlobalRedirect## object has 2 fields: ##pattern## and ##destination##. The URL received is matched on ##pattern## and if there's a match it's replaced with the value from ##destination##. XWiki then redirects to the new URL.
345
346 = Customizing the PDF export Look & Feel =
347
348 {{info}}In the future we'll want to rewrite the PDF/RTF exports as Renderers in the new [[Rendering Module architecture>>code:Modules.RenderingModule]]. When this happens this section will be upgraded.{{/info}}
349
350 Here's how the PDF and RTF exports currently work:
351 image:XWikiExport200805192259.png
352
353 As shown in the diagram you can customize 3 parts:
354
355 * The CSS used to render the content as PDF/RTF
356 * The XHTML2FO XSL transformation
357 * The FOP XSL transformation
358
359 In order to provide your own customization you need to start by creating a new [[XWiki Class>>platform:DevGuide.DataModel]]. To do that simply create a new page and edit it in Class mode (for ex: ##http:/yourserver.com/xwiki/bin/edit/XWiki/PDFClass?editor=class##). Add the following Text Area properties as needed (they are all optional so you only need to define the ones you need to use):
360
361 * ##style##: contains the CSS information that will be overriding the default ##pdf.css## values.
362 * ##xhtmlxsl##: contains the XHTML to FO XSL overriding the default one.
363 * ##fopxsl##: contains the FOP to PDF/RTF XSL overriding the default one.
364
365 Then create a new page (say ##XWiki.PDFTemplate##) and add the ##XWiki.PDFClass## object to it.
366
367 Last use that page when calling the PDF/RTF export using the ##pdftemplate## parameter as in ##[[http://yourserver/xwiki/bin/export/Space/Page?format=pdf&language=en&pdftemplate=XWiki.PDFTemplate]]##.
368
369 {{warning}}
370 As mentioned the ##style## property stores CSS code. Don't add blank line between the rules. The field is parsed and rendered, so a blank line causes a paragraph to appear there, which breaks the CSS. You must use this...
371 {{code language=css}}
372 h2 {
373 margin-left: 2cm;
374 margin-bottom: 1cm;
375 color: red;
376 }
377 h3 {
378 margin: 3cm;
379 color: yellow;
380 }
381 {{/code}}
382 And not...
383 {{code language=css}}
384 h2 {
385 margin-left: 2cm;
386 margin-bottom: 1cm;
387 color: red;
388 }
389
390 h3 {
391 margin: 3cm;
392 color: yellow;
393 }
394 {{/code}}
395 {{/warning}}
396
397 {{info}}Even though RTF export is expected to work the same way, there are still some isues to be solved affecting how CSS properties control the final layout.{{/info}}
398
399 = Configuring Wiki Syntaxes and default Syntax =
400
401 Starting with XWiki Enterprise 1.6 it's possible to configure the [[Wiki syntaxes>>platform:Main.XWikiSyntax]] that are available to the user. To do so edit the **##WEB-INF/xwiki.cfg##** file and configure the ##xwiki.rendering.syntaxes## property. It's a comma-separated list of syntax ids. For example:
402
403 {{code}}
404 xwiki.rendering.syntaxes = xwiki/1.0, xwiki/2.0, confluence/1.0, jspwiki/1.0, creole/1.0, mediawiki/1.0, xhtml/1.0, twiki/1.0
405 {{/code}}
406
407 In addition starting with XWiki Enterprise 1.8 it's possible to set the default syntax to be used when creating new documents. To do so edit the **##WEB-INF/xwiki.properties##** file and configure the ##core.defaultDocumentSyntax## property. For example to use XWiki Syntax 2.0 by default:
408
409 {{code}}
410 #-# Specifies the default syntax to use when creating new documents.
411 #-# Default value is xwiki/1.0.
412 core.defaultDocumentSyntax = xwiki/2.0
413 {{/code}}
414
415 {{warning}}Hint: If it doesn't work check that you've edited the correct configuration file.{{/warning}}
416
417 = Sample xwiki.cfg =
418
419 {{code language="none"}}
420 #---------------------------------------
421 # Preamble
422 #
423 # This is the main old XWiki configuration file. Commented parameters show the default value, although some features
424 # might be disabled. To customize, uncomment and put your own value instead.
425
426
427 #---------------------------------------
428 # General wiki settings
429 #
430
431 #-# When the wiki is readonly, any updates are forbidden. To mark readonly, use one of: yes, 1, true
432 # xwiki.readonly=no
433
434 #-# [Since 1.6RC1] Defines the list of supported syntaxes
435 #-# Available syntaxes are:
436 #-# xwiki/1.0, xwiki/2.0, confluence/1.0, jspwiki/1.0, creole/1.0, mediawiki/1.0, twiki/1.0, xhtml/1.0, html/4.01, plain/1.0
437 xwiki.rendering.syntaxes = xwiki/1.0, xwiki/2.0
438
439 #-# List of groups that a new user should be added to by default after registering. Comma-separated list of group document
440 #-# names.
441 # xwiki.users.initialGroups=XWiki.XWikiAllGroup
442
443 #-# Should all users be considered members of XWiki.XWikiAllGroup, even if they don't have an associated object in the
444 #-# group's document?
445 # xwiki.authentication.group.allgroupimplicit=0
446
447 #-# Uncomment if you want to ignore requests for unmapped actions, and simply display the document
448 # xwiki.unknownActionResponse=view
449
450 #-# The encoding to use when transformin strings to and from byte arrays. This causes the jvm encoding to be ignored,
451 #-# since we want to be independend of the underlying system.
452 xwiki.encoding=UTF-8
453
454 #-# This parameter will activate the sectional editing.
455 xwiki.section.edit=1
456
457 #-# This parameter controls the depth of sections that have section editing.
458 #-# By default level 1 and level 2 sections have section editing.
459 xwiki.section.depth=2
460
461 #-# Enable backlinks storage, which increases the update time, but allows to keep track of inter document links.
462 xwiki.backlinks=1
463
464 #-# Enable document tags.
465 xwiki.tags=1
466
467
468 #---------------------------------------
469 # Storage
470 #
471
472 #-# Role hints that differentiate implementations of the various storage components. To add a new implementation for one
473 #-# of the storages, implement the appropriate interface and declare it in a components.xml file (using a role-hint other
474 #-# than 'default') and put its hint here.
475 #
476 #-# The main (documents) storage.
477 # xwiki.store.main.hint=default
478 #-# The attachment storage.
479 # xwiki.store.attachment.hint=default
480 #-# The document versioning storage.
481 # xwiki.store.versioning.hint=default
482 #-# The attachment versioning storage. Use 'void' to disable attachment versioning.
483 # xwiki.store.attachment.versioning.hint=default
484 #-# The document recycle bin storage.
485 # xwiki.store.recyclebin.hint=default
486 #-# The attachment recycle bin storage.
487 # xwiki.store.attachment.recyclebin.hint=default
488
489 #-# Whether the document recycle bin feature is activated or not
490 # xwiki.recyclebin=1
491 #-# Whether the attachment recycle bin feature is activated or not
492 # storage.attachment.recyclebin=1
493 #-# Whether the document versioning feature is activated or not
494 # xwiki.store.versioning=1
495 #-# Whether the attachment versioning feature is activated or not
496 # xwiki.store.attachment.versioning=1
497 #-# Whether the attachments should also be rolled back when a document is reverted.
498 # xwiki.store.rollbackattachmentwithdocuments=1
499
500 #-# The path to the hibernate configuration file.
501 # xwiki.store.hibernate.path=/WEB-INF/hibernate.cfg.xml
502
503 #-# Whether to update the database schema on startup. Useful when upgrading XWiki. as the mapping could change between
504 #-# versions, and this allows to automatically update the database. Should be disabled (=0) during normal operation to
505 #-# improve the startup time.
506 # xwiki.store.hibernate.updateschema=1
507
508 #-# Allow or disable custom mapping for particular XClasses. Custom mapping may increase the performance of certain
509 #-# queries when large number of objects from particular classes are used in the wiki.
510 # xwiki.store.hibernate.custommapping=1
511 #-# Dynamic custom mapping.
512 # xwiki.store.hibernate.custommapping.dynamic=0
513
514 #-# Put a cache in front of the document store. This greatly improves performance at the cost of memory consumption.
515 #-# Disable only when memory is critical.
516 # xwiki.store.cache=1
517
518 #-# Maximum number of documents to keep in the cache.
519 # xwiki.store.cache.capacity=100
520
521 #-# [Since 1.6M1]
522 #-# Force the database name for the main wiki in virtual mode and for the wiki itself in non virtual mode.
523 # xwiki.db=xwiki
524
525 #-# [Since 1.6M1]
526 #-# Add a prefix to all databases names of the wikis in virtual mode and to the wiki name in non virtual mode.
527 # xwiki.db.prefix=
528
529
530 #---------------------------------------
531 # Data migrations
532 #
533 # Similar to schema updates, this manipulates the actual data, and not just the layout of the database. Useful for
534 # migrating data to new formats, correct errors introduced in older versions, or even for schema updates that are not
535 # handled by velocity.
536
537 #-# Whether migrations are enabled or not. Should be enabled when upgrading, but for a better startup time it is better to
538 #-# disable them in production.
539 xwiki.store.migration=1
540
541 #-# Migration manager class. The default works with a Hibernate storage.
542 # xwiki.store.migration.manager.class=com.xpn.xwiki.store.migration.hibernate.XWikiHibernateMigrationManager
543
544 #-# Whether to exit after migration. Useful when a server should handle migrations for a large database, without going
545 #-# live afterwards.
546 # xwiki.store.migration.exitAfterEnd=0
547
548 #-# Indicate the list of databases to migrate.
549 #-# to upgrade all wikis database set xwiki.store.migration.databases=all
550 #-# to upgrade just some wikis databases set xwiki.store.migration.databases=xwiki,wiki1,wiki2
551 #-# Note: the main wiki is always migrated whatever the configuration.
552 # xwiki.store.migration.databases=
553
554 #---------------------------------------
555 # Internationalization
556 #
557
558 #-# By default, XWiki chooses the language specified by the client (browser) in the Accept-Language HTTP header. This
559 #-# allows to use the default language of the wiki when the user didn't manually choose a language.
560 # xwiki.language.preferDefault=0
561
562 #-# Force only one of the supported languages to be accepted.
563 # xwiki.language.forceSupported=0
564
565
566 #---------------------------------------
567 # Virtual wikis (farm)
568 #
569
570 #-# This parameter allows XWiki to operate in Hosting mode allowing to create multiple wikis having their own database and
571 #-# responding to different URLs
572 xwiki.virtual=0
573
574 #-# URL to redirect to when a requested wiki does not exist. This should be changed to a real page.
575 xwiki.virtual.redirect=http://127.0.0.1:9080/xwiki/bin/Main/ThisWikiDoesNotExist
576
577 #-# Forbidden names that should not be allowed when creating a new wiki.
578 # xwiki.virtual.reserved_wikis=
579
580 #-# How virtual wikis are mapped to different URLs. If set to 0 (the default), then virtual wikis have different domain
581 #-# names, in the format http://wikiname.myfarm.net/. If set to 1, then the domain is common for the entire farm, but the
582 #-# path contains the wiki name, in the format http://myfarm.net/xwiki/wiki/wikiname/.
583 #-# Note that you can configure the "/wiki/" part with xwiki.virtual.usepath.servletpath property.
584 # xwiki.virtual.usepath=0
585
586 #-# Configure the servlet action identifier for url path based multiwiki. It has also to be modified in web.xml.
587 # xwiki.virtual.usepath.servletpath=wiki
588
589 #---------------------------------------
590 # URLs
591 #
592
593 #-# The domain name to use when creating URLs to the default wiki. If set, the generated URLs will point to this server
594 #-# instead of the requested one. It should contain schema, domain and (optional) port, and the trailing /. For example:
595 #-# xwiki.home=http://www.xwiki.org/
596 #-# xwiki.home=http://wiki.mycompany.net:8080/
597 # xwiki.home=
598
599 #-# The name of the default URL factory that should be used.
600 # xwiki.urlfactory.serviceclass=com.xpn.xwiki.web.XWikiURLFactoryServiceImpl
601
602 #-# Force the protocol to use in the generated URLs. The right value is taken from the request URL, so setting this
603 #-# is not recommended in most cases.
604 #-# For example:
605 #-# xwiki.url.protocol=https
606 # xwiki.url.protocol=
607 #-# The name of the webapp to use in the generated URLs. The right value is taken from the request URL, so setting this
608 #-# is not recommended in most cases. If set, the value should contain a trailing /, but not a leading one. For example:
609 #-# xwiki.webapppath=xwiki/
610 # xwiki.webapppath=
611 #-# The default servlet mapping name to use in the generated URLs. The right value is taken from the request URL,
612 #-# preserving the requested servlet mapping, so setting this is not recommended in most cases. If set, the value should
613 #-# contain a trailing /, but not a leading one. For example:
614 #-# xwiki.servletpath=bin/
615 # xwiki.servletpath=
616 #-# The fallback servlet mapping name to use in the generated URLs. Unlike xwiki.servletpath, this is the value used when
617 #-# the correct setting could not be determined from the request URL. A good way to use this setting is to achieve short
618 #-# URLs, see http://platform.xwiki.org/xwiki/bin/Main/ShortURLs
619 # xwiki.defaultservletpath=bin/
620
621 #-# Whether the /view/ part of the URL should be included if the target action is 'view'.
622 # xwiki.showviewaction=1
623 #-# The name of the default space. This is displayed when the URL specifies a document, but not a space, or neither.
624 # xwiki.defaultweb=Main
625 #-# Hide the /Space/ part of the URL when the space is the default one. Warning: use 1 to hide, 0 to show.
626 # xwiki.usedefaultweb=0
627 #-# The name of the default page of a space. This is displayed when the URL specifies a space, but not a document, or neither.
628 # xwiki.defaultpage=WebHome
629 #-# Hide the /WebHome part of the URL when the document is the default one. Use 0 to hide, 1 to show.
630 # xwiki.usedefaultaction=0
631
632
633 #---------------------------------------
634 # Users
635 #
636
637 xwiki.inactiveuser.allowedpages=
638
639
640 #---------------------------------------
641 # Authentication and authorization
642 #
643
644 #-# Enable to allow superadmin. It is disabled by default as this could be a
645 #-# security breach if it were set and you forgot about it. Should only be enabled
646 #-# for recovering the Wiki when the rights are completely messed.
647 # xwiki.superadminpassword=system
648
649 #-# Authentication type. You can use 'basic' to always use basic authentication.
650 # xwiki.authentication=form
651
652 #-# Indicate if the authentication has do be done for each request
653 #-# 0: the default value, authentication is done only once by session.
654 #-# 1: the authentication is done for each request.
655 # xwiki.authentication.always=0
656
657 #-# Cookie encryption keys. You SHOULD replace these values with any random string,
658 #-# as long as the length is the same.
659 xwiki.authentication.validationKey=totototototototototototototototo
660 xwiki.authentication.encryptionKey=titititititititititititititititi
661
662 #-# Comma separated list of domains for which authentication cookies are set. This
663 #-# concerns mostly wiki farms. The exact meaning is that when a user logs in, if
664 #-# the current domain name corresponding to the wiki ends with one of the entries
665 #-# in this parameter, then the cookie is set for the larger domain. Otherwise, it
666 #-# is set for the exact domain name of the wiki.
667 #-#
668 #-# For example, suppose the cookiedomains is set to "mydomain.net". If I log in
669 #-# on wiki1.xwiki.com, then the cookie will be set for the entire mydomain.net
670 #-# domain, and if I visit wiki2.xwiki.com I will still be authenticated. If I log
671 #-# in on wiki1.otherdomain.net, then I will only be authenticated on
672 #-# wiki1.otherdomain.net, and not on wiki2.otherdomain.net.
673 #-#
674 #-# So you need this parameter set only for global authentication in a
675 #-# farm, there's no need to specify your domain name otherwise.
676 #-#
677 #-# Example: xwiki.authentication.cookiedomains=xwiki.org,myxwiki.org
678 xwiki.authentication.cookiedomains=
679
680 #-# This allows logout to happen for any page going through the /logout/ action, regardless of the document or the servlet.
681 #-# Comment-out if you want to enable logout only for /bin/logout/XWiki/XWikiLogout
682 #-# Currently accepted patterns:
683 #-# - /StrutsServletName/logout/ (this is usually /bin/logout/ and is the default setup)
684 #-# - /logout/ (this works with the short URLs configuration)
685 #-# - /wiki/SomeWikiName/logout/ (this works with path-based virtual wikis)
686 xwiki.authentication.logoutpage=(/|/[^/]+/|/wiki/[^/]+/)logout/*
687
688 #-# The group management class.
689 # xwiki.authentication.groupclass=com.xpn.xwiki.user.impl.xwiki.XWikiGroupServiceImpl
690 #-# Default value for exo:
691 # xwiki.authentication.groupclass=com.xpn.xwiki.user.impl.exo.ExoGroupServiceImpl
692
693 #-# The authentication management class.
694 # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.XWikiAuthServiceImpl
695 #-# Default value for exo:
696 # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.exo.ExoAuthServiceImpl
697 #-# Default value for LDAP:
698 # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
699
700 #-# The authorization management class.
701 # xwiki.authentication.rightsclass=com.xpn.xwiki.user.impl.xwiki.XWikiRightServiceImpl
702
703 #-# If an unauthenticated user (guest) tries to perform a restricted action, by default the wiki redirects to the login
704 #-# page. Enable this to simply display an "unauthorized" message instead, to hide the login form.
705 # xwiki.hidelogin=false
706
707 #-# HTTP status code to sent when the authentication failed.
708 xwiki.authentication.unauthorized_code=200
709
710
711 #---------------------------------------
712 # Rendering
713 #
714
715 #-# Disable particular renderers (in the old rendering engine).
716 #-# Macro mapping
717 # xwiki.render.macromapping=1
718 #-# Velocity interpreter
719 # xwiki.render.velocity=1
720 #-# Groovy interpreter
721 # xwiki.render.groovy=1
722 #-# Plugin rendering
723 # xwiki.render.plugin=1
724 #-# Radeox wiki renderer
725 # xwiki.render.wiki=1
726 #-# Simple wiki syntax rendering
727 # xwiki.render.wikiwiki=0
728
729 #-# Maximum number of documents to keep in the rendered cache
730 # xwiki.render.cache.capacity=100
731
732 #-# Default target for external links. Use _blank to open external links in a new tab/window.
733 # xwiki.render.externallinks.defaulttarget=
734
735
736 #---------------------------------------
737 # Editing
738 #
739
740 #-# Minor edits don't participate in notifications.
741 # xwiki.minoredit=1
742
743 #-# Use edit comments
744 xwiki.editcomment=1
745
746 #-# Hide editcomment field and only use Javascript
747 # xwiki.editcomment.hidden=0
748
749 #-# Make edit comment mandatory
750 xwiki.editcomment.mandatory=0
751
752 #-# Make edit comment suggested (asks 1 time if the comment is empty.
753 #-# 1 shows one popup if comment is empty.
754 #-# 0 means there is no popup.
755 #-# This setting is ignored if mandatory is set
756 # xwiki.editcomment.suggested=0
757
758
759 #-------------------------------------------------------------------------------------
760 # LDAP
761 #-------------------------------------------------------------------------------------
762
763 #-# new LDAP authentication service
764 # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
765
766 #-# Turn LDAP authentication on - otherwise only XWiki authentication
767 #-# 0: disable
768 #-# 1: enable
769 # xwiki.authentication.ldap=1
770
771 #-# LDAP Server (Active Directory, eDirectory, OpenLDAP, etc.)
772 xwiki.authentication.ldap.server=127.0.0.1
773 xwiki.authentication.ldap.port=389
774
775 #-# LDAP login, empty = anonymous access, otherwise specify full dn
776 #-# {0} is replaced with the username, {1} with the password
777 xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP
778 xwiki.authentication.ldap.bind_pass={1}
779
780 #-# Force to check password after LDAP connection
781 #-# 0: disable
782 #-# 1: enable
783 xwiki.authentication.ldap.validate_password=0
784
785 #-# only members of the following group will be verified in the LDAP
786 #-# otherwise only users that are found after searching starting from the base_DN
787 # xwiki.authentication.ldap.user_group=cn=developers,ou=groups,o=MegaNova,c=US
788
789 #-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl]
790 #-# only users not member of the following group can autheticate
791 # xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US
792
793 #-# base DN for searches
794 xwiki.authentication.ldap.base_DN=
795
796 #-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name (default=cn)
797 # xwiki.authentication.ldap.UID_attr=cn
798
799 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
800 #-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password" is set to 1
801 # xwiki.authentication.ldap.password_field=userPassword
802
803 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
804 #-# The potential LDAP groups classes. Separated by commas.
805 # xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList
806
807 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
808 #-# The potential names of the LDAP groups fields containings the members. Separated by commas.
809 # xwiki.authentication.ldap.group_memberfields=member,uniqueMember
810
811 #-# retrieve the following fields from LDAP and store them in the XWiki user object (xwiki-attribute=ldap-attribute)
812 xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,email=mail
813
814 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
815 #-# on every login update the mapped attributes from LDAP to XWiki otherwise this happens only once when the XWiki account is created.
816 xwiki.authentication.ldap.update_user=1
817
818 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
819 #-# mapps XWiki groups to LDAP groups, separator is "|"
820 # xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=AdminRole,ou=groups,o=MegaNova,c=US|\
821 # XWiki.Organisation=cn=testers,ou=groups,o=MegaNova,c=US
822
823 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
824 #-# time in s after which the list of members in a group is refreshed from LDAP (default=3600*6)
825 # xwiki.authentication.ldap.groupcache_expiration=21800
826
827 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
828 #-# - create : synchronize group membership only when the user is first created
829 #-# - always: synchronize on every login
830 # xwiki.authentication.ldap.mode_group_sync=always
831
832 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
833 #-# if ldap authentication fails for any reason, try XWiki DB authentication with the same credentials
834 xwiki.authentication.ldap.trylocal=1
835
836 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
837 #-# SSL connection to LDAP server
838 #-# 0: normal
839 #-# 1: SSL
840 # xwiki.authentication.ldap.ssl=0
841
842 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
843 #-# The keystore file to use in SSL connection
844 # xwiki.authentication.ldap.ssl.keystore=
845
846 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
847 #-# The java secure provider used in SSL connection
848 # xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider
849
850
851 #---------------------------------------
852 # Cache
853 # [DEPRECATED since 1.7M1: this way to configure cache provider is deprecated, you should use xwiki.properties instead.]
854 #---------------------------------------
855
856 #-# [Since 1.5M2]
857 #-# The cache component implementation to use as "normal" (can be local or distributed depending on the implementation)
858 #-# cache component.
859 # xwiki.cache.cachefactory.hint=jbosscache
860
861 #-# [Since 1.5M2]
862 #-# The cache component to use as local cache component.
863 # xwiki.cache.cachefactory.local.hint=jbosscache/local
864
865
866 #---------------------------------------
867 # WYSIWYG Editor configuration
868 #
869
870 #-# You can configure the toolbars you wish to see in the WYSIWYG editor by defining the
871 #-# xwiki.wysiwyg.toolbars property.
872 #-# When not defined it defaults to:
873 # xwiki.wysiwyg.toolbars=texttoolbar, listtoolbar, indenttoolbar, undotoolbar, titletoolbar, \
874 # styletoolbar, horizontaltoolbar, attachmenttoolbar, macrostoolbar, \
875 # tabletoolbar, tablerowtoolbar, tablecoltoolbar, linktoolbar
876 #-# The full list of toolbars includes the one defined above and the following ones:
877 #-# subtoolbar, findtoolbar, symboltoolbar
878
879
880 #---------------------------------------
881 # Skins & Templates configuration
882 #
883
884 #-# The default skin to use when there's no value specified in the wiki preferences document. Note that the default
885 #-# wiki already specifies a skin, so this setting is only valid for empty wikis.
886 xwiki.defaultskin=colibri
887
888 #-# The default base for skins that don't specify a base skin. This is also the last place where a skin file is searched
889 #-# if not found in the more specific skins.
890 xwiki.defaultbaseskin=albatross
891
892 #-# Defines whether title handling should be using the compatibility mode or not. When the compatibility
893 #-# mode is active, if the document's content first header (level 1 or level 2) matches the document's title
894 #-# the first header is stripped.
895 xwiki.title.compatibility=1
896
897 #---------------------------------------
898 # Extensions
899 #
900
901 #-# List of active plugins.
902 xwiki.plugins=\
903 com.xpn.xwiki.monitor.api.MonitorPlugin,\
904 com.xpn.xwiki.plugin.skinx.JsSkinExtensionPlugin,\
905 com.xpn.xwiki.plugin.skinx.JsSkinFileExtensionPlugin,\
906 com.xpn.xwiki.plugin.skinx.CssSkinExtensionPlugin,\
907 com.xpn.xwiki.plugin.skinx.CssSkinFileExtensionPlugin,\
908 com.xpn.xwiki.plugin.feed.FeedPlugin,\
909 com.xpn.xwiki.plugin.ldap.LDAPPlugin,\
910 com.xpn.xwiki.plugin.google.GooglePlugin,\
911 com.xpn.xwiki.plugin.flickr.FlickrPlugin,\
912 com.xpn.xwiki.plugin.mail.MailPlugin,\
913 com.xpn.xwiki.plugin.packaging.PackagePlugin,\
914 com.xpn.xwiki.plugin.query.QueryPlugin,\
915 com.xpn.xwiki.plugin.svg.SVGPlugin,\
916 com.xpn.xwiki.plugin.charts.ChartingPlugin,\
917 com.xpn.xwiki.plugin.fileupload.FileUploadPlugin,\
918 com.xpn.xwiki.plugin.image.ImagePlugin,\
919 com.xpn.xwiki.plugin.userdirectory.UserDirectoryPlugin,\
920 com.xpn.xwiki.plugin.usertools.XWikiUserManagementToolsImpl,\
921 com.xpn.xwiki.plugin.zipexplorer.ZipExplorerPlugin,\
922 com.xpn.xwiki.plugin.autotag.AutoTagPlugin,\
923 com.xpn.xwiki.plugin.lucene.LucenePlugin,\
924 com.xpn.xwiki.plugin.diff.DiffPlugin,\
925 com.xpn.xwiki.plugin.rightsmanager.RightsManagerPlugin,\
926 com.xpn.xwiki.plugin.jodatime.JodaTimePlugin,\
927 com.xpn.xwiki.plugin.scheduler.SchedulerPlugin,\
928 com.xpn.xwiki.plugin.mailsender.MailSenderPlugin,\
929 com.xpn.xwiki.plugin.activitystream.plugin.ActivityStreamPlugin, \
930 com.xpn.xwiki.plugin.watchlist.WatchListPlugin, \
931 com.xpn.xwiki.wysiwyg.server.plugin.WysiwygPlugin, \
932 com.xpn.xwiki.plugin.tag.TagPlugin
933
934 #-# Enable light monitoring of the wiki performance. Records various statistics, like number of requests processed,
935 #-# time spent in rendering or in the database, medium time for a request, etc. Disable for a minor increase of
936 #-# performance and a bit of memory.
937 # xwiki.monitor=1
938
939 #-# Maximum number of last requests to remember.
940 # xwiki.monitor.lastlistsize=20
941
942 #-# Stats configuration allows to globally activate/deactivate stats module (launch storage thread, register events...).
943 #-# Enabled by default.
944 # xwiki.stats=1
945 #-# When statistics are globally enabled, storage can be enabled/disabled by wiki using the XWikiPreference property "statistics".
946 #-# Note: Statistics are disabled by default for improved performances/space.
947 xwiki.stats.default=0
948 #-# It is also possible to choose a different stats service to record statistics separately from XWiki.
949 # xwiki.stats.class=com.xpn.xwiki.stats.impl.XWikiStatsServiceImpl
950
951 #-# This parameter will activate the eXo Platform integration
952 xwiki.exo=0
953
954 #-# GraphViz plugin configuration. The GraphViz plugin is not configured by default.
955 #-# To enable it, add "com.xpn.xwiki.plugin.graphviz.GraphVizPlugin" to the list of plugins
956 #-# in the xwiki.plugins property.
957 #-# Uncomment and set the locations of the Dot and Neato executables
958 # xwiki.plugin.graphviz.dotpath=c:/Program Files/ATT/GraphViz/bin/dot.exe
959 # xwiki.plugin.graphviz.neatopath=c:/Program Files/ATT/GraphViz/bin/neato.exe
960
961 xwiki.plugin.laszlo.baseurl=/openlaszlo/xwiki/
962 xwiki.plugin.laszlo.path=c:/Program Files/Apache Software Foundation/Tomcat 5.0/webapps/openlaszlo/xwiki/
963
964 xwiki.plugin.image.cache.capacity=30
965
966 #-# Calendar Prev/Next Month bounds.
967 #-# The calendar generates links to the previous/next months for a limited range, by default 6 months back and 12 months
968 #-# after. A value of 0 means that there is no limit in that direction.
969 # xwiki.calendar.bound.prev=6
970 # xwiki.calendar.bound.next=12
971
972 #-# Lucene search engine
973 #-# Location where to place the lucene index files. The default is the "lucene" subdirectory in the container's "work"
974 #-# diectory. Change it if you want to store indexes in another place.
975 # xwiki.plugins.lucene.indexdir=/usr/local/xwiki/lucene
976 #-# The text analyzer to use for indexing.
977 # xwiki.plugins.lucene.analyzer=org.apache.lucene.analysis.standard.StandardAnalyzer
978 #-# The number of seconds to wait between reindexes. A smaller value ensures that new documents will be indexed faster,
979 #-# but with a minor performance reduction. Adjust according to your wiki load.
980 # xwiki.plugins.lucene.indexinterval=20
981 #-# The maximum size of the indexing queue. After this limit is reached, the reindex thread will have to wait until the
982 #-# queue is consumed. Note that this does not affect documents submitted through the notification mechanism, only the
983 #-# full reindex option.
984 # xwiki.plugins.lucene.maxQueueSize=1000
985
986 #-# [Since 2.0RC1]
987 #-# Activity Stream plugin.
988 #-# The Activity Stream plugin stores data in a dedicated table in the database. In virtual mode each wiki has it's own
989 #-# database, the plugin can be configured to store its data into the database corresponding to the wiki, into the main
990 #-# database (default: xwiki) or both. If the wiki is not running in virtual mode these options will not have any
991 #-# effect. These options should not be both set to 0 (in this case the local store will be forced).
992 #-# Important note: disabling storage in the main store will prevent the watchlist from retrieving events from subwikis.
993 #-#
994 #-# Default: 1
995 # xwiki.plugin.activitystream.uselocalstore=1
996 #-#
997 #-# Default: 1
998 # xwiki.plugin.activitystream.usemainstore=1
999 #-#
1000 #-# Number of days the events should be kept (0 or any negative value: infinite duration)
1001 #-# Note: if this value is greater than 0 a scheduler job will be created, this job will then be fired every week to
1002 #-# delete events older than the configured value.
1003 #-# Default: 0
1004 # xwiki.plugin.activitystream.daystokeepevents=0
1005
1006 #---------------------------------------
1007 # Misc
1008 #
1009
1010 #-# Temporary directory where XWiki can put files (during exort and upload, for example).
1011 # xwiki.temp.dir=/tmp/xwiki
1012 #-# XWiki work directory
1013 # xwiki.work.dir=/usr/local/xwiki
1014
1015 xwiki.work.dir=work
1016 {{/code}}
1017
1018 = Sample xwiki.properties =
1019
1020 {{code language="none"}}
1021 # This is the new XWiki configuration file. In the future it'll replace the old
1022 # xwiki.cfg file. However right now it's only used by some XWiki components.
1023 # As time progresses more and more component will get their configurations from
1024 # this file.
1025
1026 #-------------------------------------------------------------------------------------
1027 # Core
1028 #-------------------------------------------------------------------------------------
1029
1030 #-# [Since 1.8RC2]
1031 #-# Specifies the default syntax to use when creating new documents.
1032 #-# Default value is xwiki/2.0.
1033 # core.defaultDocumentSyntax = xwiki/1.0
1034
1035 #-------------------------------------------------------------------------------------
1036 # Rendering
1037 #-------------------------------------------------------------------------------------
1038
1039 #-# [Since 1.8RC2]
1040 #-# Specifies how links labels are displayed when the user doesn't specify the label explicitely.
1041 #-# Valid values:
1042 #-# %w: wiki name
1043 #-# %s: space name
1044 #-# %p: page name
1045 #-# %P: page name with spaces between camel case words, i.e. "My Page" iff the page name is "MyPage"
1046 #-# %t: page title
1047 #-#
1048 #-# Note that if the page title is empty or not defined then it defaults to %p. This is also the case
1049 #-# if the title cannot be retrieved for the document.
1050 #-#
1051 #-# The default is "%p". Some examples: "%s.%p", "%w:%s.%p".
1052 # rendering.linkLabelFormat = %p
1053
1054 #-# [Since 2.0M3]
1055 #-# Overrides default macro categories (Each macro has a default category already defined, for example
1056 #-# "presentation" for the Table of Contents Macro).
1057 #-#
1058 #-# Ex: To redefine the macro category for the TOC macro so that it'd be in the "My Category" category +
1059 #-# redefine the category for the Script Macro to be "My Other Category", you'd use:
1060 # rendering.macroCategories = toc:My Category
1061 # rendering.macroCategories = script:My Other Category
1062
1063 #-------------------------------------------------------------------------------------
1064 # Cache
1065 #-------------------------------------------------------------------------------------
1066
1067 #-# [Since 1.7M1]
1068 #-# The standard cache component implementation to use (can be local or distributed depending on the implementation).
1069 #-# The default standard cache implementation is JBoss Cache.
1070 # cache.defaultCache=jbosscache
1071
1072 #-# [Since 1.7M1]
1073 #-# The local cache implementation to use.
1074 #-# The default local cache implementation is JBoss Cache.
1075 # cache.defaultLocalCache=jbosscache/local
1076
1077 #----------------------------------------------------------------------------------
1078 # Settings for the OpenOffice server instance consumed by the OfficeImporter plugin
1079 #----------------------------------------------------------------------------------
1080
1081 #-# [Since 1.9M2]
1082 #-# Type of the openoffice server instance used by officeimporter plugin.
1083 #-# 0 - Internally managed server instance. (Default)
1084 #-# 1 - Externally managed (local) server instance.
1085 # openoffice.serverType=0
1086
1087 #-# [Since 1.9M2]
1088 #-# Port number used for connecting to the openoffice server instance.
1089 #-# Default port is 8100
1090 # openoffice.serverPort=8100
1091
1092 #-# [Since 1.9M2]
1093 #-# If the openoffice server should be started / connected upon XE start.
1094 #-# Default value is false
1095 # openoffice.autoStart=false
1096
1097 #-# [Since 1.8RC3]
1098 #-# Path to openoffice installation (serverType:0 only).
1099 #-# If no path is provided, a default value will be calculated based on the operating environment.
1100 # openoffice.homePath=/opt/openoffice.org3/
1101
1102 #-# [Since 1.8RC3]
1103 #-# Path to openoffice execution profile (serverType:0 only).
1104 #-# If no path is provided, a default value will be calculated based on the operating environment.
1105 # openoffice.profilePath=/home/user/.openoffice.org/3
1106
1107 #-# [Since 1.8RC3]
1108 #-# Maximum number of simultaneous conversion tasks to be handled by a single openoffice process (serverType:0 only).
1109 #-# Default value is 50
1110 # openoffice.maxTasksPerProcess=50
1111
1112 #-# [Since 1.8RC3]
1113 #-# Timeout for conversion tasks (in miliseconds) (serverType:0 only).
1114 #-# Default value is 30 seconds
1115 # openoffice.taskExecutionTimeout=30000
1116
1117 #-------------------------------------------------------------------------------------
1118 # Velocity
1119 #-------------------------------------------------------------------------------------
1120
1121 #-# [Since 2.0M1]
1122 #-# Velocity Tools that will be available from your scripts. The format is
1123 #-# velocity.tools.<name under which it'll be available in the context> = <class name>
1124 #-# Default values (no need to add them)
1125 #-# velocity.tools = listtool = org.apache.velocity.tools.generic.ListTool
1126 #-# velocity.tools = numbertool = org.apache.velocity.tools.generic.NumberTool
1127 #-# velocity.tools = datetool = org.apache.velocity.tools.generic.DateTool
1128 #-# velocity.tools = mathtool = org.apache.velocity.tools.generic.MathTool
1129 #-# velocity.tools = sorttool = org.apache.velocity.tools.generic.SortTool
1130 #-# velocity.tools = escapetool = org.apache.velocity.tools.generic.EscapeTool
1131 #-# velocity.tools = regextool = org.xwiki.velocity.tools.RegexTool
1132
1133 #-# [Since 2.0M1]
1134 #-# Velocity configuration properties. The format is
1135 #-# velocity.property.<Velocity property name> = <value>
1136 #-# Default values (no need to add them)
1137 #-# velocity.properties = resource.loader = webapp
1138 #-# velocity.properties = directive.set.null.allowed = true
1139 #-# velocity.properties = webapp.resource.loader.class = org.apache.velocity.tools.view.servlet.WebappLoader
1140 #-# velocity.properties = velocimacro.messages.on = false
1141 #-# velocity.properties = resource.manager.logwhenfound = false
1142 #-# velocity.properties = velocimacro.permissions.allow.inline.local.scope = true
1143 #-# velocity.properties = runtime.introspector.uberspect = org.xwiki.velocity.introspection.ChainingUberspector
1144 #-# velocity.properties = runtime.introspector.uberspect.chainClasses = org.apache.velocity.util.introspection.SecureUberspector,org.xwiki.velocity.introspection.DeprecatedCheckUberspector
1145
1146 #-------------------------------------------------------------------------------------
1147 # Events distribution
1148 #-------------------------------------------------------------------------------------
1149
1150 #-# [Since 2.0M3]
1151 #-# Indicate if the network distribution module is enabled or not.
1152 #-# By default remote events are disabled.
1153 # observation.remote.enabled = false
1154
1155 #-# [Since 2.0M3]
1156 #-# The list of events communication channels to start when the application starts.
1157 #-# By default no channel is configured.
1158 #-#
1159 #-# The default remote event distribution implementation is using JGroups and you'll need to drop your JGroups channel
1160 #-# xml files in the WEB-INF/observation/remote/jgroups/ directory. There's a README file in that directory with more
1161 #-# information.
1162 #-# Example: observation.remote.channels = public, cluster
1163
1164 #-# [Since 2.0M4]
1165 #-# The implementation of network adapter to use.
1166 #-# The default is jgroups.
1167 #-#
1168 #-# By default obnly jgroups is provided. To add one implements NetworkAdaptor componenet interface. The identifier provided in the configuration is matched with the component role hint.
1169 #-# Example: observation.remote.networkadapter = jgroups
1170
1171 #-------------------------------------------------------------------------------------
1172 # Administration
1173 #-------------------------------------------------------------------------------------
1174
1175 #-# [Since 2.2M2]
1176 #-# Enable captcha: true|false
1177 #-#
1178 #-# Captcha is disabled by default.
1179 #-# Example: captcha.enabled = true
1180 {{/code}}

Get Connected