Wiki source code of Configuration

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

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected