Wiki source code of Configuration

Version 50.1 by Vincent Massol on 2010/02/03

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

Get Connected