Wiki source code of Configuration

Version 51.2 by Caleb James DeLisle on 2010/02/03

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