Skip to Content

Wiki source code of Configuration

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