Wiki source code of Configuration

Version 78.1 by Vincent Massol on 2010/10/26

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

Get Connected