Wiki source code of Configuration

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