Wiki source code of Configuration

Version 60.2 by Sorin Burjan on 2010/06/23

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

Wiki source code of Configuration

Quick Links

Navigation

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected