Wiki source code of Configuration

Version 76.1 by Caleb James DeLisle on 2010/10/22

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