Wiki source code of Configuration

Version 53.1 by Thomas Mortagne on 2010/02/16

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