Wiki source code of Configuration

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