Wiki source code of Configuration

Version 114.7 by Vincent Massol on 2010/12/10

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