Wiki source code of Configuration

Version 55.1 by Caleb James DeLisle on 2010/03/25

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 ===
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 = Logging =
201
202 See the [[Logging page>>Logging]].
203
204 = Configuring Interwiki links =
205
206 [[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].
207
208 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]].
209
210 To configure Interwiki links on your wiki:
211
212 * Create a file named ##[location from where you start your container]/conf/**intermap.txt**##
213 * Fill ##intermap.txt## with content like:
214 {{code}}
215 IMDB http://us.imdb.com/Title?
216 OpenWiki http://openwiki.com/?
217 SourceForge http://sourceforge.net/
218 TWiki http://twiki.org/cgi-bin/view/
219 Why http://clublet.com/c/c/why?
220 Wiki http://c2.com/cgi/wiki?
221 WikiPedia http://www.wikipedia.com/wiki/
222 {{/code}}
223
224 You can of course add your own entries.
225
226 * 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.
227 * Restart XWiki (you'll need to restart XWiki every time you change ##intermap.txt##) and try out an Interwiki link.
228 * 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.
229
230 = Setting the default editor to use (Wiki or WYSIWYG) =
231
232 Go the Administration screen, then click on the "General" icon and select the default editor to use, as shown on the following screenshot:
233
234 image:defaulteditor.png
235
236 = Configure the WYSIWYG editor =
237
238 See [[WYSIWYG Editor Configuration>>WysiwygEditor]] page to find out how you can enable or disable editing features.
239
240 = Short URLs =
241
242 It's possible to [[configure XWiki so that is uses shorter URLs>>Main.ShortURLs]].
243
244 = Configure the names of database schemas (since 1.6M1) =
245
246 Sometimes, especially in enterprise environment, we need control names of database schemes, other than default.
247
248 * 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).
249 * 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.
250
251 = Turning off comments or attachments =
252
253 You need to change the XWiki.XWikiPreferences class like this:
254
255 * Go to ##<server>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class##
256 * Add a new property called ##showcomments## (or ##showattachments## for turning off attachments) of type String Class
257 * Go to ##<server>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences## and write no in the ##showcomments## (or ##showattachments##) field
258
259 That's it, the comments (or attachments) are gone. If you want to re-enable them, replace the "no" value with "yes".
260
261 = Configure edit comment behavior =
262
263 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//.
264
265 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//
266
267 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.
268
269 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//.
270
271 = Configuring the SMTP server =
272
273 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.
274
275 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.
276
277 image:emailconfiguration.png
278
279 == Configuring authentication for SMTP ==
280
281 {{warning}}These instructions are now obsolete{{/warning}}
282
283 By default, the username/password fields are not available in the preferences. In order to configure the SMTP authentication, you must:
284
285 * 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##.
286 * 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.
287
288 == Configuring TLS for the connection to the server ==
289
290 {{warning}}These instructions are now obsolete{{/warning}}
291
292 In order to enable TLS, you must:
293
294 * Edit the ##XWiki.XWikiPreferences## class (##/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class##) and add a ##TextArea## field, named ##javamail_extra_props ##.
295 * 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##
296
297 == Using Google SMTP server ==
298
299 |=property|=value
300 |server|smtp.gmail.com
301 |port|587
302 |user|[email protected]
303 |password|xakep
304 |JavaMail properties|mail.smtp.starttls.enable=true
305
306 = Configuring WebDAV (since 1.7) =
307
308 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.
309
310 == Securing WebDAV Server ==
311
312 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.
313
314 == Disabling WebDAV ==
315
316 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:
317
318 {{code language="xml"}}
319 <servlet-mapping>
320 <servlet-name>webdav</servlet-name>
321 <url-pattern>/webdav/*</url-pattern>
322 </servlet-mapping>
323 {{/code}}
324
325
326
327 = Redirections =
328
329 XWiki supports defining redirections for incoming requests. To activate this feature modify your ##xwiki.cfg## file and set the following property:
330 {{code}}
331 xwiki.preferences.redirect=1
332 {{/code}}
333
334 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.
335
336 = Customizing the PDF export Look & Feel =
337
338 {{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}}
339
340 Here's how the PDF and RTF exports currently work:
341
342 {image:XWikiExport200805192259.png}
343
344 As shown in the diagram you can customize 3 parts:
345
346 * The CSS used to render the content as PDF/RTF
347 * The XHTML2FO XSL transformation
348 * The FOP XSL transformation
349
350 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):
351
352 * ##style##: contains the CSS information that will be overriding the default ##pdf.css## values.
353 * ##xhtmlxsl##: contains the XHTML to FO XSL overriding the default one.
354 * ##fopxsl##: contains the FOP to PDF/RTF XSL overriding the default one.
355
356 Then create a new page (say ##XWiki.PDFTemplate##) and add the ##XWiki.PDFClass## object to it.
357
358 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]]##.
359
360 {{warning}}
361 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...
362 {{code language=css}}
363 h2 {
364 margin-left: 2cm;
365 margin-bottom: 1cm;
366 color: red;
367 }
368 h3 {
369 margin: 3cm;
370 color: yellow;
371 }
372 {{/code}}
373 And not...
374 {{code language=css}}
375 h2 {
376 margin-left: 2cm;
377 margin-bottom: 1cm;
378 color: red;
379 }
380
381 h3 {
382 margin: 3cm;
383 color: yellow;
384 }
385 {{/code}}
386 {{/warning}}
387
388 {{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}}
389
390 = Configuring Wiki Syntaxes and default Syntax =
391
392 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:
393
394 {{code}}
395 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
396 {{/code}}
397
398 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:
399
400 {{code}}
401 #-# Specifies the default syntax to use when creating new documents.
402 #-# Default value is xwiki/1.0.
403 core.defaultDocumentSyntax = xwiki/2.0
404 {{/code}}
405
406 {{warning}}Hint: If it doesn't work check that you've edited the correct configuration file.{{/warning}}
407
408 = Sample xwiki.cfg =
409
410 {{code language="none"}}
411 #---------------------------------------
412 # Preamble
413 #
414 # This is the main old XWiki configuration file. Commented parameters show the default value, although some features
415 # might be disabled. To customize, uncomment and put your own value instead.
416
417
418 #---------------------------------------
419 # General wiki settings
420 #
421
422 #-# When the wiki is readonly, any updates are forbidden. To mark readonly, use one of: yes, 1, true
423 # xwiki.readonly=no
424
425 #-# [Since 1.6RC1] Defines the list of supported syntaxes
426 #-# Available syntaxes are:
427 #-# 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
428 xwiki.rendering.syntaxes = xwiki/1.0, xwiki/2.0
429
430 #-# List of groups that a new user should be added to by default after registering. Comma-separated list of group document
431 #-# names.
432 # xwiki.users.initialGroups=XWiki.XWikiAllGroup
433
434 #-# Should all users be considered members of XWiki.XWikiAllGroup, even if they don't have an associated object in the
435 #-# group's document?
436 # xwiki.authentication.group.allgroupimplicit=0
437
438 #-# Uncomment if you want to ignore requests for unmapped actions, and simply display the document
439 # xwiki.unknownActionResponse=view
440
441 #-# The encoding to use when transformin strings to and from byte arrays. This causes the jvm encoding to be ignored,
442 #-# since we want to be independend of the underlying system.
443 xwiki.encoding=UTF-8
444
445 #-# This parameter will activate the sectional editing.
446 xwiki.section.edit=1
447
448 #-# This parameter controls the depth of sections that have section editing.
449 #-# By default level 1 and level 2 sections have section editing.
450 xwiki.section.depth=2
451
452 #-# Enable backlinks storage, which increases the update time, but allows to keep track of inter document links.
453 xwiki.backlinks=1
454
455 #-# Enable document tags.
456 xwiki.tags=1
457
458
459 #---------------------------------------
460 # Storage
461 #
462
463 #-# Role hints that differentiate implementations of the various storage components. To add a new implementation for one
464 #-# of the storages, implement the appropriate interface and declare it in a components.xml file (using a role-hint other
465 #-# than 'default') and put its hint here.
466 #
467 #-# The main (documents) storage.
468 # xwiki.store.main.hint=default
469 #-# The attachment storage.
470 # xwiki.store.attachment.hint=default
471 #-# The document versioning storage.
472 # xwiki.store.versioning.hint=default
473 #-# The attachment versioning storage. Use 'void' to disable attachment versioning.
474 # xwiki.store.attachment.versioning.hint=default
475 #-# The document recycle bin storage.
476 # xwiki.store.recyclebin.hint=default
477 #-# The attachment recycle bin storage.
478 # xwiki.store.attachment.recyclebin.hint=default
479
480 #-# Whether the document recycle bin feature is activated or not
481 # xwiki.recyclebin=1
482 #-# Whether the attachment recycle bin feature is activated or not
483 # storage.attachment.recyclebin=1
484 #-# Whether the document versioning feature is activated or not
485 # xwiki.store.versioning=1
486 #-# Whether the attachment versioning feature is activated or not
487 # xwiki.store.attachment.versioning=1
488 #-# Whether the attachments should also be rolled back when a document is reverted.
489 # xwiki.store.rollbackattachmentwithdocuments=1
490
491 #-# The path to the hibernate configuration file.
492 # xwiki.store.hibernate.path=/WEB-INF/hibernate.cfg.xml
493
494 #-# Whether to update the database schema on startup. Useful when upgrading XWiki. as the mapping could change between
495 #-# versions, and this allows to automatically update the database. Should be disabled (=0) during normal operation to
496 #-# improve the startup time.
497 # xwiki.store.hibernate.updateschema=1
498
499 #-# Allow or disable custom mapping for particular XClasses. Custom mapping may increase the performance of certain
500 #-# queries when large number of objects from particular classes are used in the wiki.
501 # xwiki.store.hibernate.custommapping=1
502 #-# Dynamic custom mapping.
503 # xwiki.store.hibernate.custommapping.dynamic=0
504
505 #-# Put a cache in front of the document store. This greatly improves performance at the cost of memory consumption.
506 #-# Disable only when memory is critical.
507 # xwiki.store.cache=1
508
509 #-# Maximum number of documents to keep in the cache.
510 # xwiki.store.cache.capacity=100
511
512 #-# [Since 1.6M1]
513 #-# Force the database name for the main wiki in virtual mode and for the wiki itself in non virtual mode.
514 # xwiki.db=xwiki
515
516 #-# [Since 1.6M1]
517 #-# Add a prefix to all databases names of the wikis in virtual mode and to the wiki name in non virtual mode.
518 # xwiki.db.prefix=
519
520
521 #---------------------------------------
522 # Data migrations
523 #
524 # Similar to schema updates, this manipulates the actual data, and not just the layout of the database. Useful for
525 # migrating data to new formats, correct errors introduced in older versions, or even for schema updates that are not
526 # handled by velocity.
527
528 #-# Whether migrations are enabled or not. Should be enabled when upgrading, but for a better startup time it is better to
529 #-# disable them in production.
530 xwiki.store.migration=1
531
532 #-# Migration manager class. The default works with a Hibernate storage.
533 # xwiki.store.migration.manager.class=com.xpn.xwiki.store.migration.hibernate.XWikiHibernateMigrationManager
534
535 #-# Whether to exit after migration. Useful when a server should handle migrations for a large database, without going
536 #-# live afterwards.
537 # xwiki.store.migration.exitAfterEnd=0
538
539 #-# Indicate the list of databases to migrate.
540 #-# to upgrade all wikis database set xwiki.store.migration.databases=all
541 #-# to upgrade just some wikis databases set xwiki.store.migration.databases=xwiki,wiki1,wiki2
542 #-# Note: the main wiki is always migrated whatever the configuration.
543 # xwiki.store.migration.databases=
544
545 #---------------------------------------
546 # Internationalization
547 #
548
549 #-# By default, XWiki chooses the language specified by the client (browser) in the Accept-Language HTTP header. This
550 #-# allows to use the default language of the wiki when the user didn't manually choose a language.
551 # xwiki.language.preferDefault=0
552
553 #-# Force only one of the supported languages to be accepted.
554 # xwiki.language.forceSupported=0
555
556
557 #---------------------------------------
558 # Virtual wikis (farm)
559 #
560
561 #-# This parameter allows XWiki to operate in Hosting mode allowing to create multiple wikis having their own database and
562 #-# responding to different URLs
563 xwiki.virtual=0
564
565 #-# URL to redirect to when a requested wiki does not exist. This should be changed to a real page.
566 xwiki.virtual.redirect=http://127.0.0.1:9080/xwiki/bin/Main/ThisWikiDoesNotExist
567
568 #-# Forbidden names that should not be allowed when creating a new wiki.
569 # xwiki.virtual.reserved_wikis=
570
571 #-# How virtual wikis are mapped to different URLs. If set to 0 (the default), then virtual wikis have different domain
572 #-# names, in the format http://wikiname.myfarm.net/. If set to 1, then the domain is common for the entire farm, but the
573 #-# path contains the wiki name, in the format http://myfarm.net/xwiki/wiki/wikiname/.
574 #-# Note that you can configure the "/wiki/" part with xwiki.virtual.usepath.servletpath property.
575 # xwiki.virtual.usepath=0
576
577 #-# Configure the servlet action identifier for url path based multiwiki. It has also to be modified in web.xml.
578 # xwiki.virtual.usepath.servletpath=wiki
579
580 #---------------------------------------
581 # URLs
582 #
583
584 #-# The domain name to use when creating URLs to the default wiki. If set, the generated URLs will point to this server
585 #-# instead of the requested one. It should contain schema, domain and (optional) port, and the trailing /. For example:
586 #-# xwiki.home=http://www.xwiki.org/
587 #-# xwiki.home=http://wiki.mycompany.net:8080/
588 # xwiki.home=
589
590 #-# The name of the default URL factory that should be used.
591 # xwiki.urlfactory.serviceclass=com.xpn.xwiki.web.XWikiURLFactoryServiceImpl
592
593 #-# Force the protocol to use in the generated URLs. The right value is taken from the request URL, so setting this
594 #-# is not recommended in most cases.
595 #-# For example:
596 #-# xwiki.url.protocol=https
597 # xwiki.url.protocol=
598 #-# The name of the webapp to use in the generated URLs. The right value is taken from the request URL, so setting this
599 #-# is not recommended in most cases. If set, the value should contain a trailing /, but not a leading one. For example:
600 #-# xwiki.webapppath=xwiki/
601 # xwiki.webapppath=
602 #-# The default servlet mapping name to use in the generated URLs. The right value is taken from the request URL,
603 #-# preserving the requested servlet mapping, so setting this is not recommended in most cases. If set, the value should
604 #-# contain a trailing /, but not a leading one. For example:
605 #-# xwiki.servletpath=bin/
606 # xwiki.servletpath=
607 #-# The fallback servlet mapping name to use in the generated URLs. Unlike xwiki.servletpath, this is the value used when
608 #-# the correct setting could not be determined from the request URL. A good way to use this setting is to achieve short
609 #-# URLs, see http://platform.xwiki.org/xwiki/bin/Main/ShortURLs
610 # xwiki.defaultservletpath=bin/
611
612 #-# Whether the /view/ part of the URL should be included if the target action is 'view'.
613 # xwiki.showviewaction=1
614 #-# The name of the default space. This is displayed when the URL specifies a document, but not a space, or neither.
615 # xwiki.defaultweb=Main
616 #-# Hide the /Space/ part of the URL when the space is the default one. Warning: use 1 to hide, 0 to show.
617 # xwiki.usedefaultweb=0
618 #-# The name of the default page of a space. This is displayed when the URL specifies a space, but not a document, or neither.
619 # xwiki.defaultpage=WebHome
620 #-# Hide the /WebHome part of the URL when the document is the default one. Use 0 to hide, 1 to show.
621 # xwiki.usedefaultaction=0
622
623
624 #---------------------------------------
625 # Users
626 #
627
628 xwiki.inactiveuser.allowedpages=
629
630
631 #---------------------------------------
632 # Authentication and authorization
633 #
634
635 #-# Enable to allow superadmin. It is disabled by default as this could be a
636 #-# security breach if it were set and you forgot about it. Should only be enabled
637 #-# for recovering the Wiki when the rights are completely messed.
638 # xwiki.superadminpassword=system
639
640 #-# Authentication type. You can use 'basic' to always use basic authentication.
641 # xwiki.authentication=form
642
643 #-# Indicate if the authentication has do be done for each request
644 #-# 0: the default value, authentication is done only once by session.
645 #-# 1: the authentication is done for each request.
646 # xwiki.authentication.always=0
647
648 #-# Cookie encryption keys. You SHOULD replace these values with any random string,
649 #-# as long as the length is the same.
650 xwiki.authentication.validationKey=totototototototototototototototo
651 xwiki.authentication.encryptionKey=titititititititititititititititi
652
653 #-# Comma separated list of domains for which authentication cookies are set. This
654 #-# concerns mostly wiki farms. The exact meaning is that when a user logs in, if
655 #-# the current domain name corresponding to the wiki ends with one of the entries
656 #-# in this parameter, then the cookie is set for the larger domain. Otherwise, it
657 #-# is set for the exact domain name of the wiki.
658 #-#
659 #-# For example, suppose the cookiedomains is set to "mydomain.net". If I log in
660 #-# on wiki1.xwiki.com, then the cookie will be set for the entire mydomain.net
661 #-# domain, and if I visit wiki2.xwiki.com I will still be authenticated. If I log
662 #-# in on wiki1.otherdomain.net, then I will only be authenticated on
663 #-# wiki1.otherdomain.net, and not on wiki2.otherdomain.net.
664 #-#
665 #-# So you need this parameter set only for global authentication in a
666 #-# farm, there's no need to specify your domain name otherwise.
667 #-#
668 #-# Example: xwiki.authentication.cookiedomains=xwiki.org,myxwiki.org
669 xwiki.authentication.cookiedomains=
670
671 #-# This allows logout to happen for any page going through the /logout/ action, regardless of the document or the servlet.
672 #-# Comment-out if you want to enable logout only for /bin/logout/XWiki/XWikiLogout
673 #-# Currently accepted patterns:
674 #-# - /StrutsServletName/logout/ (this is usually /bin/logout/ and is the default setup)
675 #-# - /logout/ (this works with the short URLs configuration)
676 #-# - /wiki/SomeWikiName/logout/ (this works with path-based virtual wikis)
677 xwiki.authentication.logoutpage=(/|/[^/]+/|/wiki/[^/]+/)logout/*
678
679 #-# The group management class.
680 # xwiki.authentication.groupclass=com.xpn.xwiki.user.impl.xwiki.XWikiGroupServiceImpl
681 #-# Default value for exo:
682 # xwiki.authentication.groupclass=com.xpn.xwiki.user.impl.exo.ExoGroupServiceImpl
683
684 #-# The authentication management class.
685 # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.XWikiAuthServiceImpl
686 #-# Default value for exo:
687 # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.exo.ExoAuthServiceImpl
688 #-# Default value for LDAP:
689 # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
690
691 #-# The authorization management class.
692 # xwiki.authentication.rightsclass=com.xpn.xwiki.user.impl.xwiki.XWikiRightServiceImpl
693
694 #-# If an unauthenticated user (guest) tries to perform a restricted action, by default the wiki redirects to the login
695 #-# page. Enable this to simply display an "unauthorized" message instead, to hide the login form.
696 # xwiki.hidelogin=false
697
698 #-# HTTP status code to sent when the authentication failed.
699 xwiki.authentication.unauthorized_code=200
700
701
702 #---------------------------------------
703 # Rendering
704 #
705
706 #-# Disable particular renderers (in the old rendering engine).
707 #-# Macro mapping
708 # xwiki.render.macromapping=1
709 #-# Velocity interpreter
710 # xwiki.render.velocity=1
711 #-# Groovy interpreter
712 # xwiki.render.groovy=1
713 #-# Plugin rendering
714 # xwiki.render.plugin=1
715 #-# Radeox wiki renderer
716 # xwiki.render.wiki=1
717 #-# Simple wiki syntax rendering
718 # xwiki.render.wikiwiki=0
719
720 #-# Maximum number of documents to keep in the rendered cache
721 # xwiki.render.cache.capacity=100
722
723 #-# Default target for external links. Use _blank to open external links in a new tab/window.
724 # xwiki.render.externallinks.defaulttarget=
725
726
727 #---------------------------------------
728 # Editing
729 #
730
731 #-# Minor edits don't participate in notifications.
732 # xwiki.minoredit=1
733
734 #-# Use edit comments
735 xwiki.editcomment=1
736
737 #-# Hide editcomment field and only use Javascript
738 # xwiki.editcomment.hidden=0
739
740 #-# Make edit comment mandatory
741 xwiki.editcomment.mandatory=0
742
743 #-# Make edit comment suggested (asks 1 time if the comment is empty.
744 #-# 1 shows one popup if comment is empty.
745 #-# 0 means there is no popup.
746 #-# This setting is ignored if mandatory is set
747 # xwiki.editcomment.suggested=0
748
749
750 #-------------------------------------------------------------------------------------
751 # LDAP
752 #-------------------------------------------------------------------------------------
753
754 #-# new LDAP authentication service
755 # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
756
757 #-# Turn LDAP authentication on - otherwise only XWiki authentication
758 #-# 0: disable
759 #-# 1: enable
760 # xwiki.authentication.ldap=1
761
762 #-# LDAP Server (Active Directory, eDirectory, OpenLDAP, etc.)
763 xwiki.authentication.ldap.server=127.0.0.1
764 xwiki.authentication.ldap.port=389
765
766 #-# LDAP login, empty = anonymous access, otherwise specify full dn
767 #-# {0} is replaced with the username, {1} with the password
768 xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP
769 xwiki.authentication.ldap.bind_pass={1}
770
771 #-# Force to check password after LDAP connection
772 #-# 0: disable
773 #-# 1: enable
774 xwiki.authentication.ldap.validate_password=0
775
776 #-# only members of the following group will be verified in the LDAP
777 #-# otherwise only users that are found after searching starting from the base_DN
778 # xwiki.authentication.ldap.user_group=cn=developers,ou=groups,o=MegaNova,c=US
779
780 #-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl]
781 #-# only users not member of the following group can autheticate
782 # xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US
783
784 #-# base DN for searches
785 xwiki.authentication.ldap.base_DN=
786
787 #-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name (default=cn)
788 # xwiki.authentication.ldap.UID_attr=cn
789
790 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
791 #-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password" is set to 1
792 # xwiki.authentication.ldap.password_field=userPassword
793
794 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
795 #-# The potential LDAP groups classes. Separated by commas.
796 # xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList
797
798 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
799 #-# The potential names of the LDAP groups fields containings the members. Separated by commas.
800 # xwiki.authentication.ldap.group_memberfields=member,uniqueMember
801
802 #-# retrieve the following fields from LDAP and store them in the XWiki user object (xwiki-attribute=ldap-attribute)
803 xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,email=mail
804
805 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
806 #-# on every login update the mapped attributes from LDAP to XWiki otherwise this happens only once when the XWiki account is created.
807 xwiki.authentication.ldap.update_user=1
808
809 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
810 #-# mapps XWiki groups to LDAP groups, separator is "|"
811 # xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=AdminRole,ou=groups,o=MegaNova,c=US|\
812 # XWiki.Organisation=cn=testers,ou=groups,o=MegaNova,c=US
813
814 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
815 #-# time in s after which the list of members in a group is refreshed from LDAP (default=3600*6)
816 # xwiki.authentication.ldap.groupcache_expiration=21800
817
818 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
819 #-# - create : synchronize group membership only when the user is first created
820 #-# - always: synchronize on every login
821 # xwiki.authentication.ldap.mode_group_sync=always
822
823 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
824 #-# if ldap authentication fails for any reason, try XWiki DB authentication with the same credentials
825 xwiki.authentication.ldap.trylocal=1
826
827 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
828 #-# SSL connection to LDAP server
829 #-# 0: normal
830 #-# 1: SSL
831 # xwiki.authentication.ldap.ssl=0
832
833 #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
834 #-# The keystore file to use in SSL connection
835 # xwiki.authentication.ldap.ssl.keystore=
836
837 #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
838 #-# The java secure provider used in SSL connection
839 # xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider
840
841
842 #---------------------------------------
843 # Cache
844 # [DEPRECATED since 1.7M1: this way to configure cache provider is deprecated, you should use xwiki.properties instead.]
845 #---------------------------------------
846
847 #-# [Since 1.5M2]
848 #-# The cache component implementation to use as "normal" (can be local or distributed depending on the implementation)
849 #-# cache component.
850 # xwiki.cache.cachefactory.hint=jbosscache
851
852 #-# [Since 1.5M2]
853 #-# The cache component to use as local cache component.
854 # xwiki.cache.cachefactory.local.hint=jbosscache/local
855
856
857 #---------------------------------------
858 # WYSIWYG Editor configuration
859 #
860
861 #-# You can configure the toolbars you wish to see in the WYSIWYG editor by defining the
862 #-# xwiki.wysiwyg.toolbars property.
863 #-# When not defined it defaults to:
864 # xwiki.wysiwyg.toolbars=texttoolbar, listtoolbar, indenttoolbar, undotoolbar, titletoolbar, \
865 # styletoolbar, horizontaltoolbar, attachmenttoolbar, macrostoolbar, \
866 # tabletoolbar, tablerowtoolbar, tablecoltoolbar, linktoolbar
867 #-# The full list of toolbars includes the one defined above and the following ones:
868 #-# subtoolbar, findtoolbar, symboltoolbar
869
870
871 #---------------------------------------
872 # Skins & Templates configuration
873 #
874
875 #-# The default skin to use when there's no value specified in the wiki preferences document. Note that the default
876 #-# wiki already specifies a skin, so this setting is only valid for empty wikis.
877 xwiki.defaultskin=colibri
878
879 #-# The default base for skins that don't specify a base skin. This is also the last place where a skin file is searched
880 #-# if not found in the more specific skins.
881 xwiki.defaultbaseskin=albatross
882
883 #-# Defines whether title handling should be using the compatibility mode or not. When the compatibility
884 #-# mode is active, if the document's content first header (level 1 or level 2) matches the document's title
885 #-# the first header is stripped.
886 xwiki.title.compatibility=1
887
888 #---------------------------------------
889 # Extensions
890 #
891
892 #-# List of active plugins.
893 xwiki.plugins=\
894 com.xpn.xwiki.monitor.api.MonitorPlugin,\
895 com.xpn.xwiki.plugin.skinx.JsSkinExtensionPlugin,\
896 com.xpn.xwiki.plugin.skinx.JsSkinFileExtensionPlugin,\
897 com.xpn.xwiki.plugin.skinx.CssSkinExtensionPlugin,\
898 com.xpn.xwiki.plugin.skinx.CssSkinFileExtensionPlugin,\
899 com.xpn.xwiki.plugin.feed.FeedPlugin,\
900 com.xpn.xwiki.plugin.ldap.LDAPPlugin,\
901 com.xpn.xwiki.plugin.google.GooglePlugin,\
902 com.xpn.xwiki.plugin.flickr.FlickrPlugin,\
903 com.xpn.xwiki.plugin.mail.MailPlugin,\
904 com.xpn.xwiki.plugin.packaging.PackagePlugin,\
905 com.xpn.xwiki.plugin.query.QueryPlugin,\
906 com.xpn.xwiki.plugin.svg.SVGPlugin,\
907 com.xpn.xwiki.plugin.charts.ChartingPlugin,\
908 com.xpn.xwiki.plugin.fileupload.FileUploadPlugin,\
909 com.xpn.xwiki.plugin.image.ImagePlugin,\
910 com.xpn.xwiki.plugin.userdirectory.UserDirectoryPlugin,\
911 com.xpn.xwiki.plugin.usertools.XWikiUserManagementToolsImpl,\
912 com.xpn.xwiki.plugin.zipexplorer.ZipExplorerPlugin,\
913 com.xpn.xwiki.plugin.autotag.AutoTagPlugin,\
914 com.xpn.xwiki.plugin.lucene.LucenePlugin,\
915 com.xpn.xwiki.plugin.diff.DiffPlugin,\
916 com.xpn.xwiki.plugin.rightsmanager.RightsManagerPlugin,\
917 com.xpn.xwiki.plugin.jodatime.JodaTimePlugin,\
918 com.xpn.xwiki.plugin.scheduler.SchedulerPlugin,\
919 com.xpn.xwiki.plugin.mailsender.MailSenderPlugin,\
920 com.xpn.xwiki.plugin.activitystream.plugin.ActivityStreamPlugin, \
921 com.xpn.xwiki.plugin.watchlist.WatchListPlugin, \
922 com.xpn.xwiki.wysiwyg.server.plugin.WysiwygPlugin, \
923 com.xpn.xwiki.plugin.tag.TagPlugin
924
925 #-# Enable light monitoring of the wiki performance. Records various statistics, like number of requests processed,
926 #-# time spent in rendering or in the database, medium time for a request, etc. Disable for a minor increase of
927 #-# performance and a bit of memory.
928 # xwiki.monitor=1
929
930 #-# Maximum number of last requests to remember.
931 # xwiki.monitor.lastlistsize=20
932
933 #-# Stats configuration allows to globally activate/deactivate stats module (launch storage thread, register events...).
934 #-# Enabled by default.
935 # xwiki.stats=1
936 #-# When statistics are globally enabled, storage can be enabled/disabled by wiki using the XWikiPreference property "statistics".
937 #-# Note: Statistics are disabled by default for improved performances/space.
938 xwiki.stats.default=0
939 #-# It is also possible to choose a different stats service to record statistics separately from XWiki.
940 # xwiki.stats.class=com.xpn.xwiki.stats.impl.XWikiStatsServiceImpl
941
942 #-# This parameter will activate the eXo Platform integration
943 xwiki.exo=0
944
945 #-# GraphViz plugin configuration. The GraphViz plugin is not configured by default.
946 #-# To enable it, add "com.xpn.xwiki.plugin.graphviz.GraphVizPlugin" to the list of plugins
947 #-# in the xwiki.plugins property.
948 #-# Uncomment and set the locations of the Dot and Neato executables
949 # xwiki.plugin.graphviz.dotpath=c:/Program Files/ATT/GraphViz/bin/dot.exe
950 # xwiki.plugin.graphviz.neatopath=c:/Program Files/ATT/GraphViz/bin/neato.exe
951
952 xwiki.plugin.laszlo.baseurl=/openlaszlo/xwiki/
953 xwiki.plugin.laszlo.path=c:/Program Files/Apache Software Foundation/Tomcat 5.0/webapps/openlaszlo/xwiki/
954
955 xwiki.plugin.image.cache.capacity=30
956
957 #-# Calendar Prev/Next Month bounds.
958 #-# The calendar generates links to the previous/next months for a limited range, by default 6 months back and 12 months
959 #-# after. A value of 0 means that there is no limit in that direction.
960 # xwiki.calendar.bound.prev=6
961 # xwiki.calendar.bound.next=12
962
963 #-# Lucene search engine
964 #-# Location where to place the lucene index files. The default is the "lucene" subdirectory in the container's "work"
965 #-# diectory. Change it if you want to store indexes in another place.
966 # xwiki.plugins.lucene.indexdir=/usr/local/xwiki/lucene
967 #-# The text analyzer to use for indexing.
968 # xwiki.plugins.lucene.analyzer=org.apache.lucene.analysis.standard.StandardAnalyzer
969 #-# The number of seconds to wait between reindexes. A smaller value ensures that new documents will be indexed faster,
970 #-# but with a minor performance reduction. Adjust according to your wiki load.
971 # xwiki.plugins.lucene.indexinterval=20
972 #-# The maximum size of the indexing queue. After this limit is reached, the reindex thread will have to wait until the
973 #-# queue is consumed. Note that this does not affect documents submitted through the notification mechanism, only the
974 #-# full reindex option.
975 # xwiki.plugins.lucene.maxQueueSize=1000
976
977 #-# [Since 2.0RC1]
978 #-# Activity Stream plugin.
979 #-# The Activity Stream plugin stores data in a dedicated table in the database. In virtual mode each wiki has it's own
980 #-# database, the plugin can be configured to store its data into the database corresponding to the wiki, into the main
981 #-# database (default: xwiki) or both. If the wiki is not running in virtual mode these options will not have any
982 #-# effect. These options should not be both set to 0 (in this case the local store will be forced).
983 #-# Important note: disabling storage in the main store will prevent the watchlist from retrieving events from subwikis.
984 #-#
985 #-# Default: 1
986 # xwiki.plugin.activitystream.uselocalstore=1
987 #-#
988 #-# Default: 1
989 # xwiki.plugin.activitystream.usemainstore=1
990 #-#
991 #-# Number of days the events should be kept (0 or any negative value: infinite duration)
992 #-# Note: if this value is greater than 0 a scheduler job will be created, this job will then be fired every week to
993 #-# delete events older than the configured value.
994 #-# Default: 0
995 # xwiki.plugin.activitystream.daystokeepevents=0
996
997 #---------------------------------------
998 # Misc
999 #
1000
1001 #-# Temporary directory where XWiki can put files (during exort and upload, for example).
1002 # xwiki.temp.dir=/tmp/xwiki
1003 #-# XWiki work directory
1004 # xwiki.work.dir=/usr/local/xwiki
1005
1006 xwiki.work.dir=work
1007 {{/code}}
1008
1009 = Sample xwiki.properties =
1010
1011 {{code language="none"}}
1012 # This is the new XWiki configuration file. In the future it'll replace the old
1013 # xwiki.cfg file. However right now it's only used by some XWiki components.
1014 # As time progresses more and more component will get their configurations from
1015 # this file.
1016
1017 #-------------------------------------------------------------------------------------
1018 # Core
1019 #-------------------------------------------------------------------------------------
1020
1021 #-# [Since 1.8RC2]
1022 #-# Specifies the default syntax to use when creating new documents.
1023 #-# Default value is xwiki/2.0.
1024 # core.defaultDocumentSyntax = xwiki/1.0
1025
1026 #-------------------------------------------------------------------------------------
1027 # Rendering
1028 #-------------------------------------------------------------------------------------
1029
1030 #-# [Since 1.8RC2]
1031 #-# Specifies how links labels are displayed when the user doesn't specify the label explicitely.
1032 #-# Valid values:
1033 #-# %w: wiki name
1034 #-# %s: space name
1035 #-# %p: page name
1036 #-# %P: page name with spaces between camel case words, i.e. "My Page" iff the page name is "MyPage"
1037 #-# %t: page title
1038 #-#
1039 #-# Note that if the page title is empty or not defined then it defaults to %p. This is also the case
1040 #-# if the title cannot be retrieved for the document.
1041 #-#
1042 #-# The default is "%p". Some examples: "%s.%p", "%w:%s.%p".
1043 # rendering.linkLabelFormat = %p
1044
1045 #-# [Since 2.0M3]
1046 #-# Overrides default macro categories (Each macro has a default category already defined, for example
1047 #-# "presentation" for the Table of Contents Macro).
1048 #-#
1049 #-# Ex: To redefine the macro category for the TOC macro so that it'd be in the "My Category" category +
1050 #-# redefine the category for the Script Macro to be "My Other Category", you'd use:
1051 # rendering.macroCategories = toc:My Category
1052 # rendering.macroCategories = script:My Other Category
1053
1054 #-------------------------------------------------------------------------------------
1055 # Cache
1056 #-------------------------------------------------------------------------------------
1057
1058 #-# [Since 1.7M1]
1059 #-# The standard cache component implementation to use (can be local or distributed depending on the implementation).
1060 #-# The default standard cache implementation is JBoss Cache.
1061 # cache.defaultCache=jbosscache
1062
1063 #-# [Since 1.7M1]
1064 #-# The local cache implementation to use.
1065 #-# The default local cache implementation is JBoss Cache.
1066 # cache.defaultLocalCache=jbosscache/local
1067
1068 #----------------------------------------------------------------------------------
1069 # Settings for the OpenOffice server instance consumed by the OfficeImporter plugin
1070 #----------------------------------------------------------------------------------
1071
1072 #-# [Since 1.9M2]
1073 #-# Type of the openoffice server instance used by officeimporter plugin.
1074 #-# 0 - Internally managed server instance. (Default)
1075 #-# 1 - Externally managed (local) server instance.
1076 # openoffice.serverType=0
1077
1078 #-# [Since 1.9M2]
1079 #-# Port number used for connecting to the openoffice server instance.
1080 #-# Default port is 8100
1081 # openoffice.serverPort=8100
1082
1083 #-# [Since 1.9M2]
1084 #-# If the openoffice server should be started / connected upon XE start.
1085 #-# Default value is false
1086 # openoffice.autoStart=false
1087
1088 #-# [Since 1.8RC3]
1089 #-# Path to openoffice installation (serverType:0 only).
1090 #-# If no path is provided, a default value will be calculated based on the operating environment.
1091 # openoffice.homePath=/opt/openoffice.org3/
1092
1093 #-# [Since 1.8RC3]
1094 #-# Path to openoffice execution profile (serverType:0 only).
1095 #-# If no path is provided, a default value will be calculated based on the operating environment.
1096 # openoffice.profilePath=/home/user/.openoffice.org/3
1097
1098 #-# [Since 1.8RC3]
1099 #-# Maximum number of simultaneous conversion tasks to be handled by a single openoffice process (serverType:0 only).
1100 #-# Default value is 50
1101 # openoffice.maxTasksPerProcess=50
1102
1103 #-# [Since 1.8RC3]
1104 #-# Timeout for conversion tasks (in miliseconds) (serverType:0 only).
1105 #-# Default value is 30 seconds
1106 # openoffice.taskExecutionTimeout=30000
1107
1108 #-------------------------------------------------------------------------------------
1109 # Velocity
1110 #-------------------------------------------------------------------------------------
1111
1112 #-# [Since 2.0M1]
1113 #-# Velocity Tools that will be available from your scripts. The format is
1114 #-# velocity.tools.<name under which it'll be available in the context> = <class name>
1115 #-# Default values (no need to add them)
1116 #-# velocity.tools = listtool = org.apache.velocity.tools.generic.ListTool
1117 #-# velocity.tools = numbertool = org.apache.velocity.tools.generic.NumberTool
1118 #-# velocity.tools = datetool = org.apache.velocity.tools.generic.DateTool
1119 #-# velocity.tools = mathtool = org.apache.velocity.tools.generic.MathTool
1120 #-# velocity.tools = sorttool = org.apache.velocity.tools.generic.SortTool
1121 #-# velocity.tools = escapetool = org.apache.velocity.tools.generic.EscapeTool
1122 #-# velocity.tools = regextool = org.xwiki.velocity.tools.RegexTool
1123
1124 #-# [Since 2.0M1]
1125 #-# Velocity configuration properties. The format is
1126 #-# velocity.property.<Velocity property name> = <value>
1127 #-# Default values (no need to add them)
1128 #-# velocity.properties = resource.loader = webapp
1129 #-# velocity.properties = directive.set.null.allowed = true
1130 #-# velocity.properties = webapp.resource.loader.class = org.apache.velocity.tools.view.servlet.WebappLoader
1131 #-# velocity.properties = velocimacro.messages.on = false
1132 #-# velocity.properties = resource.manager.logwhenfound = false
1133 #-# velocity.properties = velocimacro.permissions.allow.inline.local.scope = true
1134 #-# velocity.properties = runtime.introspector.uberspect = org.xwiki.velocity.introspection.ChainingUberspector
1135 #-# velocity.properties = runtime.introspector.uberspect.chainClasses = org.apache.velocity.util.introspection.SecureUberspector,org.xwiki.velocity.introspection.DeprecatedCheckUberspector
1136
1137 #-------------------------------------------------------------------------------------
1138 # Events distribution
1139 #-------------------------------------------------------------------------------------
1140
1141 #-# [Since 2.0M3]
1142 #-# Indicate if the network distribution module is enabled or not.
1143 #-# By default remote events are disabled.
1144 # observation.remote.enabled = false
1145
1146 #-# [Since 2.0M3]
1147 #-# The list of events communication channels to start when the application starts.
1148 #-# By default no channel is configured.
1149 #-#
1150 #-# The default remote event distribution implementation is using JGroups and you'll need to drop your JGroups channel
1151 #-# xml files in the WEB-INF/observation/remote/jgroups/ directory. There's a README file in that directory with more
1152 #-# information.
1153 #-# Example: observation.remote.channels = public, cluster
1154
1155 #-# [Since 2.0M4]
1156 #-# The implementation of network adapter to use.
1157 #-# The default is jgroups.
1158 #-#
1159 #-# 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.
1160 #-# Example: observation.remote.networkadapter = jgroups
1161
1162 #-------------------------------------------------------------------------------------
1163 # Administration
1164 #-------------------------------------------------------------------------------------
1165
1166 #-# [Since 2.2M2]
1167 #-# Enable captcha: true|false
1168 #-#
1169 #-# Captcha is disabled by default.
1170 #-# Example: captcha.enabled = true
1171 {{/code}}

Get Connected