Skip to Content

Wiki source code of Configuration

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

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected