Wiki source code of Configuration

Version 134.4 by Sorin Burjan on 2012/05/15

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
128.3	216	{{image reference="DefaultEditor.png"/}}
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
128.3	220	{{image reference="DefaultEditorStarting30.png"/}}
127.1	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
128.3	279	{{image reference="MailSettings.png"/}}
10.1	280
128.1	281	Starting with XWiki Enterprise 3.0 these changes should be performed from "Configuration > Email" (see below):
	282
128.3	283	{{image reference="MailSettingsStarting30.png"/}}
128.1	284
69.1	285	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	286
	287	\|= Option\|=Description\|=Examples
	288	\|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
	289	\|mail.smtp.auth\|If true, attempt to authenticate the user using the AUTH command. Defaults to false.\|mail.smtp.auth=true
74.2	290	\|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	291
53.1	292	== Using Google SMTP server ==
48.1	293
51.1	294	\|=property\|=value
	295	\|server\|smtp.gmail.com
	296	\|port\|587
	297	\|user\|vovan@gmail.com
	298	\|password\|xakep
	299	\|JavaMail properties\|mail.smtp.starttls.enable=true
48.1	300
53.1	301	= Configuring WebDAV (since 1.7) =
31.1	302
33.1	303	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	304
53.1	305	== Securing WebDAV Server ==
32.1	306
51.1	307	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	308
53.1	309	== Disabling WebDAV ==
33.1	310
35.1	311	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	312
53.1	313	{{code language="xml"}}
33.1	314	<servlet-mapping>
	315	<servlet-name>webdav</servlet-name>
	316	<url-pattern>/webdav/*</url-pattern>
	317	</servlet-mapping>
51.1	318	{{/code}}
33.1	319
53.1	320	= Redirections =
13.1	321
51.1	322	XWiki supports defining redirections for incoming requests. To activate this feature modify your ##xwiki.cfg## file and set the following property:
61.1	323	{{code}}xwiki.preferences.redirect=1{{/code}}
13.1	324
51.1	325	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	326
53.1	327	= Customizing the PDF export Look & Feel =
15.1	328
61.1	329	{{info}}
114.6	330	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	331	{{/info}}
24.1	332
30.2	333	Here's how the PDF and RTF exports currently work:
129.1	334	[[image:XWikiExport201010290119.png\|\|style="border: 1px solid silver;" width="720"]]
28.1	335
58.1	336	As shown in the diagram you can customize 4 parts:
53.1	337
107.1	338	* 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.
	339	* 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.
	340	* The XHTML2FO XSL transformation. The default one, xhtml2fo.xsl, is packed in core jar.
108.1	341	* The FOP XSL transformation. The default one, fop.xsl, is also packed in core jar.
30.2	342
114.1	343	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	344
127.1	345	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	346
109.1	347	* ##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.
130.1	348	* ##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.Note that in versions before 3.0M2 the export engine expects you to fill in this field a name of a file which should be deployed on the classpath (WEB-INF/classes), while after version 3.0M2 (see issue [[XWIKI-5918>>http://jira.xwiki.org/browse/XWIKI-5918\|\|title="Impossible to override XSLT documents used in the PDF export process"]]) this field needs to be the actual content of the customized xhtml2fo.xsl. Note that you can also use velocity in this field (useful to get the content of an attached .xsl file, which comes in very handy when you need to fill in a big file, since the limit of textarea properties is of 60 000 characters).
109.1	349	* ##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	350
119.1	351	{{warning}}
	352	The name of the class must be ##XWiki.PDFClass##
	353	{{/warning}}
114.5	354
106.1	355	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.
	356
51.1	357	Then create a new page (say ##XWiki.PDFTemplate##) and add the ##XWiki.PDFClass## object to it.
30.2	358
129.1	359	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: rgb(204, 0, 0); font-weight: bold;" %)No template is used by default(%%).
30.2	360
79.1	361	{{info}}
114.7	362	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	363	{{code language=css}}
79.1	364	#template('colorThemeInit.vm')
28.1	365	h2 {
79.1	366	color: $theme.titleColor;
28.1	367	}
	368
79.1	369	td {
	370	border-color: $theme.borderColor;
28.1	371	}
51.1	372	{{/code}}
79.1	373	{{/info}}
28.1	374
132.1	375	= Override the PDF Templates =
131.1	376
132.1	377	== Customize the PDF Footer ==
131.1	378
	379	By default, the PDF footer will display the page number, the last author and the date on which the last modification was performed. In order to also display a customized message, the template pdffooter.vm must be overridden. To do that, edit the Skin class (e.g.http://yourserver/xwiki/bin/view/XWiki/XWikiSkins?editor=class) and add a "TextArea" object named pdffooter.vm:
	380
134.1	381	[[image:OverridePDFFooter.png]]
131.1	382
132.1	383	Next, edit the skin page (e.g.http://yourserver/xwiki/bin/edit/XWiki/DefaultSkin?editor=object) and add the following code to the pdffooter.vm property:\\
131.1	384
	385	To see the changes, just export any wiki page:
	386
134.1	387	[[image:OverridePDFFooterFinal.png]]
131.1	388
	389	Customize the PDF Cover
	390
	391	This could be useful when you want for instance to add the company's logo to the PDF cover. In order to do this, the template pdfcover.vm must be overridden. Just like for the PDF header, a "TextArea" property named pdfcover.vm must be added to the XWiki.XWikiSkins class (e.g.http://yourserver/xwiki/bin/view/XWiki/XWikiSkins?editor=class).
	392
134.1	393	[[image:OverridePDFCover.png]]
131.1	394
	395	Next, edit the skin page (e.g.http://yourserver/xwiki/bin/edit/XWiki/DefaultSkin?editor=object) and add the following code to the pdfcover.vm property:
132.1	396
132.2	397	{{code}}<img src="$xwiki.getSkinFile("logo.png")"/>
131.1	398
	399	<div style="text-align: center; width: 100%;">
	400	<h1>
	401	#set($title = "$!pdfdoc.display('title', 'rendered')")
	402	#if($title == '')
	403	$escapetool.xml($!doc.displayTitle)
	404	#else
	405	$escapetool.xml($title)
	406	#end
	407	</h1>
	408	<br />
	409	<br />
	410	$!xwiki.getUserName($tdoc.author, false)
	411	<br />
	412	$!xwiki.formatDate($tdoc.date)
132.2	413	</div>{{/code}}
131.1	414	The last step consists of attaching the image "logo.png" to the skin.
	415
134.1	416	[[image:OverridePDFCoverFinal.png]]
131.1	417
132.2	418	== Override the CSS rules ==
	419
131.1	420	In order to use your own template when exporting a page as PDF, you need to create a class in the XWiki space and name it PDFClass. Next, edit the page in "Class" mode (e.g.http://yourserver/xwiki/bin/edit/XWiki/PDFClass?editor=class) and add the following TextArea properties:
	421
132.1	422	* style which contains the CSS rules that will override the default pdf.css values; by default, there won't be a pdf.css file on your filesystem, but you can create it in the folder \webapps\xwiki\templates\ or specify it in your skin page
	423	* xhtmlxsl which contains the XHTML2FO XSL transformation that will override the default one
	424	* fopxsl which contains the FOP XSL transformation that will override the default one
131.1	425
134.1	426	[[image:CreatePDFClass.png]]
131.1	427
	428	Then, create the wiki page for which your want to customize the PDF export (e.g. XWiki.PDFTemplate), add a "XWiki.PDFClass" object to it.
	429
	430	Supposing your wiki page contains a table, you have to edit it in "Wiki" mode and add a style parameter as shown below:
134.3	431	{{code}}
131.1	432	(% class="mytable" %)
	433	\|=Column 1\|=Column 2
	434	\| data\|data
134.4	435	{{/code}}
131.1	436	Next, edit the page in "Objects" mode and write your own CSS rules in the "style" property:
	437
134.1	438	[[image:CreatePDFTemplate.png]]
131.1	439
134.2	440	Because no template is used by default, you need to specify the ##pdftemplate## parameter in the URL in order to use your own template~://{{{http://yourserver/xwiki/bin/export/XWiki/PDFTemplate?format=pdf&pdftemplate=XWiki.PDFTemplate}}}//.
131.1	441
134.2	442	[[image:CustomizedPDF.png]]
131.1	443
61.1	444	{{info}}
	445	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.
	446	{{/info}}
28.1	447
53.1	448	= Configuring Wiki Syntaxes and default Syntax =
46.1	449
51.1	450	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	451
51.1	452	{{code}}
30.1	453	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	454	{{/code}}
25.1	455
51.1	456	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	457
51.1	458	{{code}}
41.2	459	#-# Specifies the default syntax to use when creating new documents.
	460	#-# Default value is xwiki/1.0.
	461	core.defaultDocumentSyntax = xwiki/2.0
51.1	462	{{/code}}
41.2	463
61.1	464	{{warning}}
	465	Hint: If it doesn't work check that you've edited the correct configuration file.
	466	{{/warning}}
41.5	467
115.1	468	= Title behavior =
	469
	470	The following configuration parameters (in ##xwiki.cfg## can be used to control title behavior):
	471
	472	{{code language="none"}}
	473	#-# Defines whether title handling should be using the compatibility mode or not. When the compatibility
	474	#-# mode is active, if the document's content first header (level 1 or level 2) matches the document's title
	475	#-# the first header is stripped.
	476	xwiki.title.compatibility=1
	477
	478	#-# Defines the maximum header depth to look for when computing a document's title from its content. If no header
	479	#-# equal or lower to the specified depth is found then the computed title falls back to the document name.
	480	#-# The default value is 2.
	481	# xwiki.title.headerdepth=2
	482
	483	#-# Defines if setting the title field must be mandatory in the WYSIWYG and Wiki editors. It is mandatory when this
	484	#-# property is set to 1. The default value is 0 (not mandatory).
	485	# xwiki.title.mandatory=0
	486	{{/code}}
	487
117.1	488	= Link Label Generation =
	489
	490	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]]##)
	491
	492	Her's an extract from the ##xwiki.properties## file which is where this feature is configurable:
	493
	494	{{code language="none"}}
	495	#-# [Since 1.8RC2]
	496	#-# Specifies how links labels are displayed when the user doesn't specify the label explicitely.
	497	#-# Valid values:
	498	#-# %w: wiki name
	499	#-# %s: space name
	500	#-# %p: page name
	501	#-# %P: page name with spaces between camel case words, i.e. "My Page" iff the page name is "MyPage"
	502	#-# %t: page title
	503	#-#
	504	#-# Note that if the page title is empty or not defined then it defaults to %p. This is also the case
	505	#-# if the title cannot be retrieved for the document.
	506	#-#
	507	#-# The default is "%p". Some examples: "%s.%p", "%w:%s.%p".
	508	# rendering.linkLabelFormat = %p
	509	{{/code}}
	510
121.1	511	= Rendering Cache =
	512
122.1	513	See the [[Performance page>>platform:AdminGuide.Performances#HRenderingcache]]
121.1	514
125.1	515	= Allowed Pages for Inactive Users =
	516
125.2	517	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	518
125.2	519	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	520
125.2	521	Note: inactive users are always allowed to see the //XWiki.AccountValidation// page in order to validate their account.
125.1	522
125.8	523	= Rendering Transformations =
	524
	525	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##:
	526
	527	{{code language="none"}}
	528	#-# [Since 2.6RC1]
	529	#-# Controls what transformations will be executed when rendering content.
	530	#-# A transformation modifies the parsed content. For example the Icon transformation replaces some characters with
	531	#-# icons, a WikiWord transformation will automatically create links when it finds wiki words, etc.
	532	#-# Note that the Macro transformation is a special transformation that replaces macro markers by the result of the
	533	#-# macro execution. If you don't list it, macros won't get executed.
	534	#-# The default value is: rendering.transformations = macro, icon
	535	{{/code}}
	536
	537	For example if you wish to turn off the Icon Transformation to not render emoticons, you'd define the following property:
	538
	539	{{code language="none"}}
	540	rendering.transformations = macro
	541	{{/code}}
	542
53.1	543	= Sample xwiki.cfg =
1.18	544
54.2	545	{{code language="none"}}
50.1	546	#---------------------------------------
	547	# Preamble
	548	#
	549	# This is the main old XWiki configuration file. Commented parameters show the default value, although some features
	550	# might be disabled. To customize, uncomment and put your own value instead.
30.1	551
50.1	552
	553	#---------------------------------------
	554	# General wiki settings
	555	#
	556
	557	#-# When the wiki is readonly, any updates are forbidden. To mark readonly, use one of: yes, 1, true
	558	# xwiki.readonly=no
	559
	560	#-# [Since 1.6RC1] Defines the list of supported syntaxes
	561	#-# Available syntaxes are:
	562	#-# 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
	563	xwiki.rendering.syntaxes = xwiki/1.0, xwiki/2.0
	564
	565	#-# List of groups that a new user should be added to by default after registering. Comma-separated list of group document
	566	#-# names.
	567	# xwiki.users.initialGroups=XWiki.XWikiAllGroup
	568
	569	#-# Should all users be considered members of XWiki.XWikiAllGroup, even if they don't have an associated object in the
	570	#-# group's document?
	571	# xwiki.authentication.group.allgroupimplicit=0
	572
	573	#-# Uncomment if you want to ignore requests for unmapped actions, and simply display the document
	574	# xwiki.unknownActionResponse=view
	575
	576	#-# The encoding to use when transformin strings to and from byte arrays. This causes the jvm encoding to be ignored,
	577	#-# since we want to be independend of the underlying system.
	578	xwiki.encoding=UTF-8
	579
	580	#-# This parameter will activate the sectional editing.
	581	xwiki.section.edit=1
	582
	583	#-# This parameter controls the depth of sections that have section editing.
	584	#-# By default level 1 and level 2 sections have section editing.
	585	xwiki.section.depth=2
	586
	587	#-# Enable backlinks storage, which increases the update time, but allows to keep track of inter document links.
	588	xwiki.backlinks=1
	589
	590	#-# Enable document tags.
	591	xwiki.tags=1
	592
	593
	594	#---------------------------------------
	595	# Storage
	596	#
	597
	598	#-# Role hints that differentiate implementations of the various storage components. To add a new implementation for one
	599	#-# of the storages, implement the appropriate interface and declare it in a components.xml file (using a role-hint other
	600	#-# than 'default') and put its hint here.
	601	#
	602	#-# The main (documents) storage.
	603	# xwiki.store.main.hint=default
	604	#-# The attachment storage.
	605	# xwiki.store.attachment.hint=default
	606	#-# The document versioning storage.
	607	# xwiki.store.versioning.hint=default
	608	#-# The attachment versioning storage. Use 'void' to disable attachment versioning.
	609	# xwiki.store.attachment.versioning.hint=default
	610	#-# The document recycle bin storage.
	611	# xwiki.store.recyclebin.hint=default
	612	#-# The attachment recycle bin storage.
	613	# xwiki.store.attachment.recyclebin.hint=default
	614
	615	#-# Whether the document recycle bin feature is activated or not
	616	# xwiki.recyclebin=1
	617	#-# Whether the attachment recycle bin feature is activated or not
	618	# storage.attachment.recyclebin=1
	619	#-# Whether the document versioning feature is activated or not
	620	# xwiki.store.versioning=1
	621	#-# Whether the attachment versioning feature is activated or not
	622	# xwiki.store.attachment.versioning=1
	623	#-# Whether the attachments should also be rolled back when a document is reverted.
	624	# xwiki.store.rollbackattachmentwithdocuments=1
	625
	626	#-# The path to the hibernate configuration file.
	627	# xwiki.store.hibernate.path=/WEB-INF/hibernate.cfg.xml
	628
	629	#-# Whether to update the database schema on startup. Useful when upgrading XWiki. as the mapping could change between
	630	#-# versions, and this allows to automatically update the database. Should be disabled (=0) during normal operation to
	631	#-# improve the startup time.
	632	# xwiki.store.hibernate.updateschema=1
	633
	634	#-# Allow or disable custom mapping for particular XClasses. Custom mapping may increase the performance of certain
	635	#-# queries when large number of objects from particular classes are used in the wiki.
	636	# xwiki.store.hibernate.custommapping=1
	637	#-# Dynamic custom mapping.
	638	# xwiki.store.hibernate.custommapping.dynamic=0
	639
	640	#-# Put a cache in front of the document store. This greatly improves performance at the cost of memory consumption.
	641	#-# Disable only when memory is critical.
	642	# xwiki.store.cache=1
	643
	644	#-# Maximum number of documents to keep in the cache.
	645	# xwiki.store.cache.capacity=100
	646
	647	#-# [Since 1.6M1]
	648	#-# Force the database name for the main wiki in virtual mode and for the wiki itself in non virtual mode.
	649	# xwiki.db=xwiki
	650
	651	#-# [Since 1.6M1]
	652	#-# Add a prefix to all databases names of the wikis in virtual mode and to the wiki name in non virtual mode.
	653	# xwiki.db.prefix=
	654
	655
	656	#---------------------------------------
	657	# Data migrations
	658	#
	659	# Similar to schema updates, this manipulates the actual data, and not just the layout of the database. Useful for
	660	# migrating data to new formats, correct errors introduced in older versions, or even for schema updates that are not
	661	# handled by velocity.
	662
	663	#-# Whether migrations are enabled or not. Should be enabled when upgrading, but for a better startup time it is better to
	664	#-# disable them in production.
30.1	665	xwiki.store.migration=1
	666
50.1	667	#-# Migration manager class. The default works with a Hibernate storage.
	668	# xwiki.store.migration.manager.class=com.xpn.xwiki.store.migration.hibernate.XWikiHibernateMigrationManager
1.22	669
50.1	670	#-# Whether to exit after migration. Useful when a server should handle migrations for a large database, without going
	671	#-# live afterwards.
	672	# xwiki.store.migration.exitAfterEnd=0
1.22	673
50.1	674	#-# Indicate the list of databases to migrate.
	675	#-# to upgrade all wikis database set xwiki.store.migration.databases=all
	676	#-# to upgrade just some wikis databases set xwiki.store.migration.databases=xwiki,wiki1,wiki2
	677	#-# Note: the main wiki is always migrated whatever the configuration.
	678	# xwiki.store.migration.databases=
30.1	679
50.1	680	#---------------------------------------
	681	# Internationalization
	682	#
	683
	684	#-# By default, XWiki chooses the language specified by the client (browser) in the Accept-Language HTTP header. This
	685	#-# allows to use the default language of the wiki when the user didn't manually choose a language.
	686	# xwiki.language.preferDefault=0
	687
	688	#-# Force only one of the supported languages to be accepted.
	689	# xwiki.language.forceSupported=0
	690
	691
	692	#---------------------------------------
	693	# Virtual wikis (farm)
	694	#
	695
	696	#-# This parameter allows XWiki to operate in Hosting mode allowing to create multiple wikis having their own database and
	697	#-# responding to different URLs
1.22	698	xwiki.virtual=0
30.1	699
50.1	700	#-# URL to redirect to when a requested wiki does not exist. This should be changed to a real page.
1.22	701	xwiki.virtual.redirect=http://127.0.0.1:9080/xwiki/bin/Main/ThisWikiDoesNotExist
	702
50.1	703	#-# Forbidden names that should not be allowed when creating a new wiki.
	704	# xwiki.virtual.reserved_wikis=
1.22	705
50.1	706	#-# How virtual wikis are mapped to different URLs. If set to 0 (the default), then virtual wikis have different domain
	707	#-# names, in the format http://wikiname.myfarm.net/. If set to 1, then the domain is common for the entire farm, but the
	708	#-# path contains the wiki name, in the format http://myfarm.net/xwiki/wiki/wikiname/.
	709	#-# Note that you can configure the "/wiki/" part with xwiki.virtual.usepath.servletpath property.
	710	# xwiki.virtual.usepath=0
	711
	712	#-# Configure the servlet action identifier for url path based multiwiki. It has also to be modified in web.xml.
	713	# xwiki.virtual.usepath.servletpath=wiki
	714
	715	#---------------------------------------
	716	# URLs
	717	#
	718
	719	#-# The domain name to use when creating URLs to the default wiki. If set, the generated URLs will point to this server
	720	#-# instead of the requested one. It should contain schema, domain and (optional) port, and the trailing /. For example:
	721	#-# xwiki.home=http://www.xwiki.org/
	722	#-# xwiki.home=http://wiki.mycompany.net:8080/
	723	# xwiki.home=
	724
	725	#-# The name of the default URL factory that should be used.
	726	# xwiki.urlfactory.serviceclass=com.xpn.xwiki.web.XWikiURLFactoryServiceImpl
	727
	728	#-# Force the protocol to use in the generated URLs. The right value is taken from the request URL, so setting this
	729	#-# is not recommended in most cases.
	730	#-# For example:
	731	#-# xwiki.url.protocol=https
	732	# xwiki.url.protocol=
	733	#-# The name of the webapp to use in the generated URLs. The right value is taken from the request URL, so setting this
	734	#-# is not recommended in most cases. If set, the value should contain a trailing /, but not a leading one. For example:
	735	#-# xwiki.webapppath=xwiki/
	736	# xwiki.webapppath=
	737	#-# The default servlet mapping name to use in the generated URLs. The right value is taken from the request URL,
	738	#-# preserving the requested servlet mapping, so setting this is not recommended in most cases. If set, the value should
	739	#-# contain a trailing /, but not a leading one. For example:
	740	#-# xwiki.servletpath=bin/
	741	# xwiki.servletpath=
	742	#-# The fallback servlet mapping name to use in the generated URLs. Unlike xwiki.servletpath, this is the value used when
	743	#-# the correct setting could not be determined from the request URL. A good way to use this setting is to achieve short
	744	#-# URLs, see http://platform.xwiki.org/xwiki/bin/Main/ShortURLs
	745	# xwiki.defaultservletpath=bin/
	746
	747	#-# Whether the /view/ part of the URL should be included if the target action is 'view'.
	748	# xwiki.showviewaction=1
	749	#-# The name of the default space. This is displayed when the URL specifies a document, but not a space, or neither.
	750	# xwiki.defaultweb=Main
	751	#-# Hide the /Space/ part of the URL when the space is the default one. Warning: use 1 to hide, 0 to show.
	752	# xwiki.usedefaultweb=0
	753	#-# The name of the default page of a space. This is displayed when the URL specifies a space, but not a document, or neither.
	754	# xwiki.defaultpage=WebHome
	755	#-# Hide the /WebHome part of the URL when the document is the default one. Use 0 to hide, 1 to show.
	756	# xwiki.usedefaultaction=0
	757
	758
	759	#---------------------------------------
	760	# Users
	761	#
	762
	763	xwiki.inactiveuser.allowedpages=
	764
	765
	766	#---------------------------------------
	767	# Authentication and authorization
	768	#
	769
	770	#-# Enable to allow superadmin. It is disabled by default as this could be a
	771	#-# security breach if it were set and you forgot about it. Should only be enabled
	772	#-# for recovering the Wiki when the rights are completely messed.
	773	# xwiki.superadminpassword=system
	774
	775	#-# Authentication type. You can use 'basic' to always use basic authentication.
	776	# xwiki.authentication=form
	777
	778	#-# Indicate if the authentication has do be done for each request
	779	#-# 0: the default value, authentication is done only once by session.
	780	#-# 1: the authentication is done for each request.
	781	# xwiki.authentication.always=0
	782
	783	#-# Cookie encryption keys. You SHOULD replace these values with any random string,
	784	#-# as long as the length is the same.
1.22	785	xwiki.authentication.validationKey=totototototototototototototototo
	786	xwiki.authentication.encryptionKey=titititititititititititititititi
	787
50.1	788	#-# Comma separated list of domains for which authentication cookies are set. This
	789	#-# concerns mostly wiki farms. The exact meaning is that when a user logs in, if
	790	#-# the current domain name corresponding to the wiki ends with one of the entries
	791	#-# in this parameter, then the cookie is set for the larger domain. Otherwise, it
	792	#-# is set for the exact domain name of the wiki.
	793	#-#
	794	#-# For example, suppose the cookiedomains is set to "mydomain.net". If I log in
	795	#-# on wiki1.xwiki.com, then the cookie will be set for the entire mydomain.net
	796	#-# domain, and if I visit wiki2.xwiki.com I will still be authenticated. If I log
	797	#-# in on wiki1.otherdomain.net, then I will only be authenticated on
	798	#-# wiki1.otherdomain.net, and not on wiki2.otherdomain.net.
	799	#-#
	800	#-# So you need this parameter set only for global authentication in a
	801	#-# farm, there's no need to specify your domain name otherwise.
	802	#-#
	803	#-# Example: xwiki.authentication.cookiedomains=xwiki.org,myxwiki.org
	804	xwiki.authentication.cookiedomains=
30.1	805
50.1	806	#-# This allows logout to happen for any page going through the /logout/ action, regardless of the document or the servlet.
	807	#-# Comment-out if you want to enable logout only for /bin/logout/XWiki/XWikiLogout
	808	#-# Currently accepted patterns:
	809	#-# - /StrutsServletName/logout/ (this is usually /bin/logout/ and is the default setup)
	810	#-# - /logout/ (this works with the short URLs configuration)
	811	#-# - /wiki/SomeWikiName/logout/ (this works with path-based virtual wikis)
	812	xwiki.authentication.logoutpage=(/\|/[^/]+/\|/wiki/[^/]+/)logout/*
1.22	813
50.1	814	#-# The group management class.
	815	# xwiki.authentication.groupclass=com.xpn.xwiki.user.impl.xwiki.XWikiGroupServiceImpl
	816	#-# Default value for exo:
	817	# xwiki.authentication.groupclass=com.xpn.xwiki.user.impl.exo.ExoGroupServiceImpl
30.1	818
50.1	819	#-# The authentication management class.
	820	# xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.XWikiAuthServiceImpl
	821	#-# Default value for exo:
	822	# xwiki.authentication.authclass=com.xpn.xwiki.user.impl.exo.ExoAuthServiceImpl
	823	#-# Default value for LDAP:
	824	# xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
30.1	825
50.1	826	#-# The authorization management class.
	827	# xwiki.authentication.rightsclass=com.xpn.xwiki.user.impl.xwiki.XWikiRightServiceImpl
1.22	828
50.1	829	#-# If an unauthenticated user (guest) tries to perform a restricted action, by default the wiki redirects to the login
	830	#-# page. Enable this to simply display an "unauthorized" message instead, to hide the login form.
	831	# xwiki.hidelogin=false
30.1	832
50.1	833	#-# HTTP status code to sent when the authentication failed.
	834	xwiki.authentication.unauthorized_code=200
30.1	835
	836
50.1	837	#---------------------------------------
	838	# Rendering
	839	#
1.22	840
50.1	841	#-# Disable particular renderers (in the old rendering engine).
	842	#-# Macro mapping
	843	# xwiki.render.macromapping=1
	844	#-# Velocity interpreter
	845	# xwiki.render.velocity=1
	846	#-# Groovy interpreter
	847	# xwiki.render.groovy=1
	848	#-# Plugin rendering
	849	# xwiki.render.plugin=1
	850	#-# Radeox wiki renderer
	851	# xwiki.render.wiki=1
	852	#-# Simple wiki syntax rendering
	853	# xwiki.render.wikiwiki=0
1.22	854
50.1	855	#-# Maximum number of documents to keep in the rendered cache
	856	# xwiki.render.cache.capacity=100
1.22	857
50.1	858	#-# Default target for external links. Use _blank to open external links in a new tab/window.
	859	# xwiki.render.externallinks.defaulttarget=
1.22	860
	861
50.1	862	#---------------------------------------
	863	# Editing
	864	#
1.22	865
50.1	866	#-# Minor edits don't participate in notifications.
	867	# xwiki.minoredit=1
1.22	868
50.1	869	#-# Use edit comments
	870	xwiki.editcomment=1
	871
	872	#-# Hide editcomment field and only use Javascript
	873	# xwiki.editcomment.hidden=0
	874
	875	#-# Make edit comment mandatory
	876	xwiki.editcomment.mandatory=0
	877
	878	#-# Make edit comment suggested (asks 1 time if the comment is empty.
	879	#-# 1 shows one popup if comment is empty.
	880	#-# 0 means there is no popup.
	881	#-# This setting is ignored if mandatory is set
	882	# xwiki.editcomment.suggested=0
	883
	884
30.1	885	#-------------------------------------------------------------------------------------
	886	# LDAP
	887	#-------------------------------------------------------------------------------------
	888
	889	#-# new LDAP authentication service
	890	# xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
	891
	892	#-# Turn LDAP authentication on - otherwise only XWiki authentication
	893	#-# 0: disable
	894	#-# 1: enable
	895	# xwiki.authentication.ldap=1
	896
	897	#-# LDAP Server (Active Directory, eDirectory, OpenLDAP, etc.)
	898	xwiki.authentication.ldap.server=127.0.0.1
1.22	899	xwiki.authentication.ldap.port=389
30.1	900
50.1	901	#-# LDAP login, empty = anonymous access, otherwise specify full dn
30.1	902	#-# {0} is replaced with the username, {1} with the password
	903	xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP
1.22	904	xwiki.authentication.ldap.bind_pass={1}
	905
30.1	906	#-# Force to check password after LDAP connection
	907	#-# 0: disable
	908	#-# 1: enable
	909	xwiki.authentication.ldap.validate_password=0
	910
	911	#-# only members of the following group will be verified in the LDAP
	912	#-# otherwise only users that are found after searching starting from the base_DN
	913	# xwiki.authentication.ldap.user_group=cn=developers,ou=groups,o=MegaNova,c=US
	914
	915	#-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl]
	916	#-# only users not member of the following group can autheticate
	917	# xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US
	918
	919	#-# base DN for searches
	920	xwiki.authentication.ldap.base_DN=
	921
	922	#-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name (default=cn)
	923	# xwiki.authentication.ldap.UID_attr=cn
	924
	925	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
	926	#-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password" is set to 1
	927	# xwiki.authentication.ldap.password_field=userPassword
	928
	929	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
	930	#-# The potential LDAP groups classes. Separated by commas.
	931	# xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList
	932
	933	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
	934	#-# The potential names of the LDAP groups fields containings the members. Separated by commas.
	935	# xwiki.authentication.ldap.group_memberfields=member,uniqueMember
	936
	937	#-# retrieve the following fields from LDAP and store them in the XWiki user object (xwiki-attribute=ldap-attribute)
50.1	938	xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,email=mail
30.1	939
	940	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	941	#-# on every login update the mapped attributes from LDAP to XWiki otherwise this happens only once when the XWiki account is created.
	942	xwiki.authentication.ldap.update_user=1
	943
	944	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	945	#-# mapps XWiki groups to LDAP groups, separator is "\|"
	946	# xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=AdminRole,ou=groups,o=MegaNova,c=US\|\
	947	# XWiki.Organisation=cn=testers,ou=groups,o=MegaNova,c=US
	948
	949	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	950	#-# time in s after which the list of members in a group is refreshed from LDAP (default=3600*6)
	951	# xwiki.authentication.ldap.groupcache_expiration=21800
	952
	953	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	954	#-# - create : synchronize group membership only when the user is first created
	955	#-# - always: synchronize on every login
	956	# xwiki.authentication.ldap.mode_group_sync=always
	957
	958	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	959	#-# if ldap authentication fails for any reason, try XWiki DB authentication with the same credentials
	960	xwiki.authentication.ldap.trylocal=1
	961
	962	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	963	#-# SSL connection to LDAP server
	964	#-# 0: normal
	965	#-# 1: SSL
	966	# xwiki.authentication.ldap.ssl=0
	967
	968	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	969	#-# The keystore file to use in SSL connection
	970	# xwiki.authentication.ldap.ssl.keystore=
	971
	972	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
	973	#-# The java secure provider used in SSL connection
	974	# xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider
	975
50.1	976
	977	#---------------------------------------
30.1	978	# Cache
50.1	979	# [DEPRECATED since 1.7M1: this way to configure cache provider is deprecated, you should use xwiki.properties instead.]
	980	#---------------------------------------
30.1	981
	982	#-# [Since 1.5M2]
	983	#-# The cache component implementation to use as "normal" (can be local or distributed depending on the implementation)
	984	#-# cache component.
	985	# xwiki.cache.cachefactory.hint=jbosscache
	986
	987	#-# [Since 1.5M2]
	988	#-# The cache component to use as local cache component.
	989	# xwiki.cache.cachefactory.local.hint=jbosscache/local
	990
	991
50.1	992	#---------------------------------------
	993	# WYSIWYG Editor configuration
	994	#
30.1	995
50.1	996	#-# You can configure the toolbars you wish to see in the WYSIWYG editor by defining the
	997	#-# xwiki.wysiwyg.toolbars property.
	998	#-# When not defined it defaults to:
30.1	999	# xwiki.wysiwyg.toolbars=texttoolbar, listtoolbar, indenttoolbar, undotoolbar, titletoolbar, \
	1000	# styletoolbar, horizontaltoolbar, attachmenttoolbar, macrostoolbar, \
	1001	# tabletoolbar, tablerowtoolbar, tablecoltoolbar, linktoolbar
50.1	1002	#-# The full list of toolbars includes the one defined above and the following ones:
	1003	#-# subtoolbar, findtoolbar, symboltoolbar
1.22	1004
	1005
50.1	1006	#---------------------------------------
	1007	# Skins & Templates configuration
	1008	#
	1009
	1010	#-# The default skin to use when there's no value specified in the wiki preferences document. Note that the default
	1011	#-# wiki already specifies a skin, so this setting is only valid for empty wikis.
	1012	xwiki.defaultskin=colibri
	1013
	1014	#-# The default base for skins that don't specify a base skin. This is also the last place where a skin file is searched
	1015	#-# if not found in the more specific skins.
1.22	1016	xwiki.defaultbaseskin=albatross
	1017
50.1	1018	#-# Defines whether title handling should be using the compatibility mode or not. When the compatibility
	1019	#-# mode is active, if the document's content first header (level 1 or level 2) matches the document's title
	1020	#-# the first header is stripped.
	1021	xwiki.title.compatibility=1
	1022
	1023	#---------------------------------------
	1024	# Extensions
	1025	#
	1026
	1027	#-# List of active plugins.
	1028	xwiki.plugins=\
	1029	com.xpn.xwiki.monitor.api.MonitorPlugin,\
	1030	com.xpn.xwiki.plugin.skinx.JsSkinExtensionPlugin,\
	1031	com.xpn.xwiki.plugin.skinx.JsSkinFileExtensionPlugin,\
	1032	com.xpn.xwiki.plugin.skinx.CssSkinExtensionPlugin,\
	1033	com.xpn.xwiki.plugin.skinx.CssSkinFileExtensionPlugin,\
	1034	com.xpn.xwiki.plugin.feed.FeedPlugin,\
	1035	com.xpn.xwiki.plugin.ldap.LDAPPlugin,\
	1036	com.xpn.xwiki.plugin.google.GooglePlugin,\
	1037	com.xpn.xwiki.plugin.flickr.FlickrPlugin,\
	1038	com.xpn.xwiki.plugin.mail.MailPlugin,\
	1039	com.xpn.xwiki.plugin.packaging.PackagePlugin,\
	1040	com.xpn.xwiki.plugin.query.QueryPlugin,\
	1041	com.xpn.xwiki.plugin.svg.SVGPlugin,\
	1042	com.xpn.xwiki.plugin.charts.ChartingPlugin,\
	1043	com.xpn.xwiki.plugin.fileupload.FileUploadPlugin,\
	1044	com.xpn.xwiki.plugin.image.ImagePlugin,\
	1045	com.xpn.xwiki.plugin.userdirectory.UserDirectoryPlugin,\
	1046	com.xpn.xwiki.plugin.usertools.XWikiUserManagementToolsImpl,\
	1047	com.xpn.xwiki.plugin.zipexplorer.ZipExplorerPlugin,\
	1048	com.xpn.xwiki.plugin.autotag.AutoTagPlugin,\
	1049	com.xpn.xwiki.plugin.lucene.LucenePlugin,\
	1050	com.xpn.xwiki.plugin.diff.DiffPlugin,\
	1051	com.xpn.xwiki.plugin.rightsmanager.RightsManagerPlugin,\
	1052	com.xpn.xwiki.plugin.jodatime.JodaTimePlugin,\
	1053	com.xpn.xwiki.plugin.scheduler.SchedulerPlugin,\
	1054	com.xpn.xwiki.plugin.mailsender.MailSenderPlugin,\
	1055	com.xpn.xwiki.plugin.activitystream.plugin.ActivityStreamPlugin, \
	1056	com.xpn.xwiki.plugin.watchlist.WatchListPlugin, \
	1057	com.xpn.xwiki.wysiwyg.server.plugin.WysiwygPlugin, \
	1058	com.xpn.xwiki.plugin.tag.TagPlugin
	1059
	1060	#-# Enable light monitoring of the wiki performance. Records various statistics, like number of requests processed,
	1061	#-# time spent in rendering or in the database, medium time for a request, etc. Disable for a minor increase of
	1062	#-# performance and a bit of memory.
	1063	# xwiki.monitor=1
	1064
	1065	#-# Maximum number of last requests to remember.
	1066	# xwiki.monitor.lastlistsize=20
	1067
	1068	#-# Stats configuration allows to globally activate/deactivate stats module (launch storage thread, register events...).
	1069	#-# Enabled by default.
	1070	# xwiki.stats=1
	1071	#-# When statistics are globally enabled, storage can be enabled/disabled by wiki using the XWikiPreference property "statistics".
	1072	#-# Note: Statistics are disabled by default for improved performances/space.
	1073	xwiki.stats.default=0
	1074	#-# It is also possible to choose a different stats service to record statistics separately from XWiki.
	1075	# xwiki.stats.class=com.xpn.xwiki.stats.impl.XWikiStatsServiceImpl
	1076
	1077	#-# This parameter will activate the eXo Platform integration
	1078	xwiki.exo=0
	1079
	1080	#-# GraphViz plugin configuration. The GraphViz plugin is not configured by default.
	1081	#-# To enable it, add "com.xpn.xwiki.plugin.graphviz.GraphVizPlugin" to the list of plugins
	1082	#-# in the xwiki.plugins property.
	1083	#-# Uncomment and set the locations of the Dot and Neato executables
	1084	# xwiki.plugin.graphviz.dotpath=c:/Program Files/ATT/GraphViz/bin/dot.exe
	1085	# xwiki.plugin.graphviz.neatopath=c:/Program Files/ATT/GraphViz/bin/neato.exe
	1086
	1087	xwiki.plugin.laszlo.baseurl=/openlaszlo/xwiki/
	1088	xwiki.plugin.laszlo.path=c:/Program Files/Apache Software Foundation/Tomcat 5.0/webapps/openlaszlo/xwiki/
	1089
	1090	xwiki.plugin.image.cache.capacity=30
	1091
	1092	#-# Calendar Prev/Next Month bounds.
	1093	#-# The calendar generates links to the previous/next months for a limited range, by default 6 months back and 12 months
	1094	#-# after. A value of 0 means that there is no limit in that direction.
30.1	1095	# xwiki.calendar.bound.prev=6
	1096	# xwiki.calendar.bound.next=12
	1097
50.1	1098	#-# Lucene search engine
	1099	#-# Location where to place the lucene index files. The default is the "lucene" subdirectory in the container's "work"
	1100	#-# diectory. Change it if you want to store indexes in another place.
30.1	1101	# xwiki.plugins.lucene.indexdir=/usr/local/xwiki/lucene
50.1	1102	#-# The text analyzer to use for indexing.
30.1	1103	# xwiki.plugins.lucene.analyzer=org.apache.lucene.analysis.standard.StandardAnalyzer
50.1	1104	#-# The number of seconds to wait between reindexes. A smaller value ensures that new documents will be indexed faster,
	1105	#-# but with a minor performance reduction. Adjust according to your wiki load.
30.1	1106	# xwiki.plugins.lucene.indexinterval=20
50.1	1107	#-# The maximum size of the indexing queue. After this limit is reached, the reindex thread will have to wait until the
	1108	#-# queue is consumed. Note that this does not affect documents submitted through the notification mechanism, only the
	1109	#-# full reindex option.
	1110	# xwiki.plugins.lucene.maxQueueSize=1000
30.1	1111
50.1	1112	#-# [Since 2.0RC1]
	1113	#-# Activity Stream plugin.
	1114	#-# The Activity Stream plugin stores data in a dedicated table in the database. In virtual mode each wiki has it's own
	1115	#-# database, the plugin can be configured to store its data into the database corresponding to the wiki, into the main
	1116	#-# database (default: xwiki) or both. If the wiki is not running in virtual mode these options will not have any
	1117	#-# effect. These options should not be both set to 0 (in this case the local store will be forced).
	1118	#-# Important note: disabling storage in the main store will prevent the watchlist from retrieving events from subwikis.
	1119	#-#
	1120	#-# Default: 1
	1121	# xwiki.plugin.activitystream.uselocalstore=1
	1122	#-#
	1123	#-# Default: 1
	1124	# xwiki.plugin.activitystream.usemainstore=1
	1125	#-#
	1126	#-# Number of days the events should be kept (0 or any negative value: infinite duration)
	1127	#-# Note: if this value is greater than 0 a scheduler job will be created, this job will then be fired every week to
	1128	#-# delete events older than the configured value.
	1129	#-# Default: 0
	1130	# xwiki.plugin.activitystream.daystokeepevents=0
30.1	1131
50.1	1132	#---------------------------------------
	1133	# Misc
	1134	#
30.1	1135
50.1	1136	#-# Temporary directory where XWiki can put files (during exort and upload, for example).
	1137	# xwiki.temp.dir=/tmp/xwiki
	1138	#-# XWiki work directory
	1139	# xwiki.work.dir=/usr/local/xwiki
	1140
30.1	1141	xwiki.work.dir=work
51.1	1142	{{/code}}
1.22	1143
53.1	1144	= Sample xwiki.properties =
50.1	1145
54.2	1146	{{code language="none"}}
50.1	1147	# This is the new XWiki configuration file. In the future it'll replace the old
	1148	# xwiki.cfg file. However right now it's only used by some XWiki components.
	1149	# As time progresses more and more component will get their configurations from
	1150	# this file.
	1151
	1152	#-------------------------------------------------------------------------------------
	1153	# Core
	1154	#-------------------------------------------------------------------------------------
	1155
	1156	#-# [Since 1.8RC2]
	1157	#-# Specifies the default syntax to use when creating new documents.
	1158	#-# Default value is xwiki/2.0.
	1159	# core.defaultDocumentSyntax = xwiki/1.0
	1160
	1161	#-------------------------------------------------------------------------------------
	1162	# Rendering
	1163	#-------------------------------------------------------------------------------------
	1164
	1165	#-# [Since 1.8RC2]
	1166	#-# Specifies how links labels are displayed when the user doesn't specify the label explicitely.
	1167	#-# Valid values:
	1168	#-# %w: wiki name
	1169	#-# %s: space name
	1170	#-# %p: page name
	1171	#-# %P: page name with spaces between camel case words, i.e. "My Page" iff the page name is "MyPage"
	1172	#-# %t: page title
	1173	#-#
	1174	#-# Note that if the page title is empty or not defined then it defaults to %p. This is also the case
	1175	#-# if the title cannot be retrieved for the document.
	1176	#-#
	1177	#-# The default is "%p". Some examples: "%s.%p", "%w:%s.%p".
	1178	# rendering.linkLabelFormat = %p
	1179
	1180	#-# [Since 2.0M3]
	1181	#-# Overrides default macro categories (Each macro has a default category already defined, for example
	1182	#-# "presentation" for the Table of Contents Macro).
	1183	#-#
	1184	#-# Ex: To redefine the macro category for the TOC macro so that it'd be in the "My Category" category +
	1185	#-# redefine the category for the Script Macro to be "My Other Category", you'd use:
	1186	# rendering.macroCategories = toc:My Category
	1187	# rendering.macroCategories = script:My Other Category
	1188
	1189	#-------------------------------------------------------------------------------------
	1190	# Cache
	1191	#-------------------------------------------------------------------------------------
	1192
	1193	#-# [Since 1.7M1]
	1194	#-# The standard cache component implementation to use (can be local or distributed depending on the implementation).
	1195	#-# The default standard cache implementation is JBoss Cache.
	1196	# cache.defaultCache=jbosscache
	1197
	1198	#-# [Since 1.7M1]
	1199	#-# The local cache implementation to use.
	1200	#-# The default local cache implementation is JBoss Cache.
	1201	# cache.defaultLocalCache=jbosscache/local
	1202
	1203	#----------------------------------------------------------------------------------
	1204	# Settings for the OpenOffice server instance consumed by the OfficeImporter plugin
	1205	#----------------------------------------------------------------------------------
	1206
	1207	#-# [Since 1.9M2]
	1208	#-# Type of the openoffice server instance used by officeimporter plugin.
	1209	#-# 0 - Internally managed server instance. (Default)
	1210	#-# 1 - Externally managed (local) server instance.
	1211	# openoffice.serverType=0
	1212
	1213	#-# [Since 1.9M2]
	1214	#-# Port number used for connecting to the openoffice server instance.
	1215	#-# Default port is 8100
	1216	# openoffice.serverPort=8100
	1217
	1218	#-# [Since 1.9M2]
	1219	#-# If the openoffice server should be started / connected upon XE start.
	1220	#-# Default value is false
	1221	# openoffice.autoStart=false
	1222
	1223	#-# [Since 1.8RC3]
	1224	#-# Path to openoffice installation (serverType:0 only).
	1225	#-# If no path is provided, a default value will be calculated based on the operating environment.
	1226	# openoffice.homePath=/opt/openoffice.org3/
	1227
	1228	#-# [Since 1.8RC3]
	1229	#-# Path to openoffice execution profile (serverType:0 only).
	1230	#-# If no path is provided, a default value will be calculated based on the operating environment.
	1231	# openoffice.profilePath=/home/user/.openoffice.org/3
	1232
	1233	#-# [Since 1.8RC3]
	1234	#-# Maximum number of simultaneous conversion tasks to be handled by a single openoffice process (serverType:0 only).
	1235	#-# Default value is 50
	1236	# openoffice.maxTasksPerProcess=50
	1237
	1238	#-# [Since 1.8RC3]
	1239	#-# Timeout for conversion tasks (in miliseconds) (serverType:0 only).
	1240	#-# Default value is 30 seconds
	1241	# openoffice.taskExecutionTimeout=30000
	1242
	1243	#-------------------------------------------------------------------------------------
	1244	# Velocity
	1245	#-------------------------------------------------------------------------------------
	1246
	1247	#-# [Since 2.0M1]
	1248	#-# Velocity Tools that will be available from your scripts. The format is
	1249	#-# velocity.tools.<name under which it'll be available in the context> = <class name>
	1250	#-# Default values (no need to add them)
	1251	#-# velocity.tools = listtool = org.apache.velocity.tools.generic.ListTool
	1252	#-# velocity.tools = numbertool = org.apache.velocity.tools.generic.NumberTool
	1253	#-# velocity.tools = datetool = org.apache.velocity.tools.generic.DateTool
	1254	#-# velocity.tools = mathtool = org.apache.velocity.tools.generic.MathTool
	1255	#-# velocity.tools = sorttool = org.apache.velocity.tools.generic.SortTool
	1256	#-# velocity.tools = escapetool = org.apache.velocity.tools.generic.EscapeTool
	1257	#-# velocity.tools = regextool = org.xwiki.velocity.tools.RegexTool
	1258
	1259	#-# [Since 2.0M1]
	1260	#-# Velocity configuration properties. The format is
	1261	#-# velocity.property.<Velocity property name> = <value>
	1262	#-# Default values (no need to add them)
	1263	#-# velocity.properties = resource.loader = webapp
	1264	#-# velocity.properties = directive.set.null.allowed = true
	1265	#-# velocity.properties = webapp.resource.loader.class = org.apache.velocity.tools.view.servlet.WebappLoader
	1266	#-# velocity.properties = velocimacro.messages.on = false
	1267	#-# velocity.properties = resource.manager.logwhenfound = false
	1268	#-# velocity.properties = velocimacro.permissions.allow.inline.local.scope = true
	1269	#-# velocity.properties = runtime.introspector.uberspect = org.xwiki.velocity.introspection.ChainingUberspector
	1270	#-# velocity.properties = runtime.introspector.uberspect.chainClasses = org.apache.velocity.util.introspection.SecureUberspector,org.xwiki.velocity.introspection.DeprecatedCheckUberspector
	1271
	1272	#-------------------------------------------------------------------------------------
	1273	# Events distribution
	1274	#-------------------------------------------------------------------------------------
	1275
	1276	#-# [Since 2.0M3]
	1277	#-# Indicate if the network distribution module is enabled or not.
	1278	#-# By default remote events are disabled.
	1279	# observation.remote.enabled = false
	1280
	1281	#-# [Since 2.0M3]
	1282	#-# The list of events communication channels to start when the application starts.
	1283	#-# By default no channel is configured.
	1284	#-#
	1285	#-# The default remote event distribution implementation is using JGroups and you'll need to drop your JGroups channel
	1286	#-# xml files in the WEB-INF/observation/remote/jgroups/ directory. There's a README file in that directory with more
	1287	#-# information.
	1288	#-# Example: observation.remote.channels = public, cluster
	1289
	1290	#-# [Since 2.0M4]
	1291	#-# The implementation of network adapter to use.
	1292	#-# The default is jgroups.
	1293	#-#
	1294	#-# 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.
	1295	#-# Example: observation.remote.networkadapter = jgroups
	1296
	1297	#-------------------------------------------------------------------------------------
	1298	# Administration
	1299	#-------------------------------------------------------------------------------------
	1300
	1301	#-# [Since 2.2M2]
	1302	#-# Enable captcha: true\|false
	1303	#-#
	1304	#-# Captcha is disabled by default.
	1305	#-# Example: captcha.enabled = true
51.1	1306	{{/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