Wiki source code of Configuration

Version 127.1 by Silvia Macovei on 2012/03/13

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