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

Get Connected