Wiki source code of Configuration

Version 45.1 by Ludovic Dubost on 2009/08/09

version	line-number	content
1.1	1	1 Configuration
	2
	3	One you have XWiki [installed>Installation] you'll want to configure it. Configuration can be done in 2 ways:
1.12	4
29.2	5	* by stopping the XWiki instance and editing the <tt>xwiki/WEB-INF/xwiki.cfg</tt> file, and then restarting XWiki
	6	* by logging in as a user with admin rights and going to the Administration page (when using the XWiki 1.0 skin, there's a an "Administration" link in the top right corner of the screen - You can also go directly to <tt>http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences</tt>). This allows to keep the Server running while making the changes.
1.1	7
29.2	8	Note that some configurations are only accessible from the <tt>xwiki.cfg</tt> file and have no equivalent on the Administration page.
1.1	9
45.1	10	You can verify some basic settings of your XWiki install (on Tomcat, MySQL) using the [check Config and Indexes application>code:Applications.CheckConfigAndIndexesApplication].
	11
1.1	12	There are various things you can configure:
1.12	13
1.1	14	#toc("" "" "")
1.29	15
	16	1.1 Enable superadmin account
	17
	18	Edit the <tt>xwiki.cfg</tt> file and enable the <tt>xwiki.superadminpassword</tt> property. For example:
	19
	20	{code:none}
	21	# Enable to allow superadmin. It is disabled by default as this could be a security breach if
	22	# it were set and you forgot about it.
	23	xwiki.superadminpassword=system
	24	{code}
	25
4.1	26	When logging in, the username will be "superadmin" and the password will be the one you set in the <tt>xwiki.superadminpassword</tt> property.
	27
12.2	28	1.1 Language settings
12.1	29
	30	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.
	31
12.2	32	In addition you can configure you wiki to be multilingual. See the [I18 user page>Features.I18N] for more information.
	33
43.1	34	Last, you can also force your wiki to display only in one of the languages specified in the settings, by editing your <tt>WEB-INF/xwiki.cfg</tt> file. Search for the "Internationalization" section, and you should see two commented settings that you can uncomment and set to 1:
	35
	36	{code:none}
	37	#-# By default, XWiki chooses the language specified by the client (browser) in the Accept-Language HTTP header. This
	38	#-# allows to use the default language of the wiki when the user didn't manually choose a language.
	39	# xwiki.language.preferDefault=0
	40
	41	#-# Force only one of the supported languages to be accepted.
	42	# xwiki.language.forceSupported=0
	43	{code}
	44
36.1	45	1.1 Date format
	46
	47	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:
	48
	49	{table}
	50	Format \| Result
	51	MMMM dd, HH:mm \| January 27, 12:27
	52	yyyy/MM/dd, HH:mm \| 2009/01/27, 12:27
	53	dd/MM/yyyy, HH:mm \| 27/01/2009, 12:27
	54	{table}
	55
36.2	56	[More information about date formatting>http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html].
	57
	58
1.12	59	1.1 Wiki Access Configuration
	60
	61	The first thing you will want to do is configure a policy access for your wiki. Depending on what you intend to use your wiki for, you have several options:
	62
1.17	63	* [Open Wiki>#HOpenWiki]: anyone can edit pages (including non registered users)
6.3	64	* [Public Wiki>#HPublicWiki]: only registered users can edit pages but registration is open to anyone. This is the default configuration of the default wiki (the wiki provided as a XAR on the [download page>xwiki:Main.Download]).
1.17	65	* [Private Wiki with password>#HPrivateWikiwithpassword]: registration is closed
	66	* [Private Wiki with token for registering>#HPrivateWikiwithtoken]: registration is closed but users knowing the token can register
1.12	67
	68	1.1.1 Open Wiki
	69
	70	TODO
	71
	72	1.1.1 Public Wiki
	73
40.1	74	Nothing to do. This is the default Way.
	75	If you want that only people with a verified Email Address can edit pages, you have to set
40.2	76	"Use email verification" AND "Check Active fields for user authentication" to "Yes" in Administration/Registration.
1.12	77
	78	1.1.1 Private Wiki with password
1.20	79	1.1.1.1 Global rights
1.12	80
1.21	81	In [Global rights>http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences?editor=globalrights&global=1] set User:XWikiGuest, Groups:, Level:register, Allow-Deny:Allow.
1.20	82
	83	1.1.1.1 Registration
	84
1.21	85	In [Preferences>http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences] under Registration set Use email verification:yes. fill the other fields appropriately.
1.20	86
1.12	87	1.1.1 Private Wiki with token
	88
	89	TODO
	90
41.1	91	* [Find out more about XWiki access rights here>Access Rights]
1.20	92
1.1	93	1.1 Enabling/Disabling Statistics
	94
6.1	95	To disable [the Statistics feature>code:Applications.StatisticsApplication], edit your ~~xwiki.cfg~~ file and replace the following properties as shown here:
1.12	96	{code:xml}
1.1	97	xwiki.stats=0
	98	xwiki.stats.default=0
	99	{code}
	100
1.10	101	where:
1.12	102
1.10	103	* ~~xwiki.stats~~ controls whether Statistics are on or off
	104	* ~~xwiki.stats.default~~ controls whether Statistics are on or off by default for the current Wiki. This is useful in [Virtual Wiki mode>AdminGuide.Virtualization]. A wiki can decide whether Statistics is on/off by setting the "statistics" field in XWiki.XWikiPreferences. If no such field is defined the the default value ~~xwiki.stats.default~~ is used.
1.1	105
1.10	106	To enable Statistics, change "0" to "1".
	107
12.3	108	1.1 Optional Store Features
	109
12.4	110	XWiki stores all document attachment versions by default. This is very memory consuming (both RAM and HDD).
	111	If you need only latest versions of attachments, you can disable attachment version control by editing your ~~xwiki.cfg~~ and adding:
12.3	112	{code:xml}
	113	xwiki.store.attachment.versioning=0
	114	{code}
	115
12.4	116
1.4	117	1.1 Customizing the Skin
1.3	118
	119	See the [Skin Guide>AdminGuide.Skins].
	120
1.4	121	1.1 Security configuration
1.3	122
	123	See the [Security Guide>AdminGuide.Security].
	124
1.4	125	1.1 Customizing Menus
1.3	126
6.2	127	The first thing to understand is that menus depend on the skin you're using. If you're using the 1.0 skin it's likely you're using the [Panels Application>code:Applications.PanelsApplication] to provide the different menu panels you see on the left or right of your wikis. Check the [Panels Application>code:Applications.PanelsApplication] to know more on how to configure/modify them.
1.3	128
1.5	129	1.1 Encoding
1.3	130
1.5	131	See the [Encoding Guide>AdminGuide.Encoding].
	132
1.6	133	1.1 User Authentication
1.5	134
1.9	135	See the [Authentication Guide>AdminGuide.Authentication].
1.18	136
1.30	137	1.1 Customizing the registration page
	138
	139	The default registration page is defined as a template on the file system (named <tt>registerinline.vm</tt>). However it's possible to easily override it by creating a page named <tt>XWiki.Registration</tt>.
	140
29.1	141	See [more details about configuring the registration page>AdminGuide.User Management#HCustomizingtheRegistrationpage].
1.23	142	1.1 Logging
	143
	144	See the [Logging page>Logging].
	145
1.24	146	1.1 Configuring Interwiki links
	147
	148	[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\].
	149
	150	Since XWiki renders wiki syntax using the [Radeox>http://radeox.org] engine, it supports Interwiki links in [much the same way as SnipSnap>http://snipsnap.org/space/InterWiki+HowTo].
	151
	152	To configure Interwiki links on your wiki:
	153
	154	* Create a file named <tt>\[location from where you start your container\]/conf/intermap.txt</tt>
	155	* Fill <tt>intermap.txt</tt> with content like:
	156	{code}
	157	IMDB http://us.imdb.com/Title?
	158	OpenWiki http://openwiki.com/?
	159	SourceForge http://sourceforge.net/
	160	TWiki http://twiki.org/cgi-bin/view/
	161	Why http://clublet.com/c/c/why?
	162	Wiki http://c2.com/cgi/wiki?
	163	WikiPedia http://www.wikipedia.com/wiki/
	164	{code}
	165
	166	You can of course add your own entries.
	167
	168	* Note that Radeox's parser for intermap.txt is [very fragile>http://snipforge.org/jira/browse/RADEOX-49]. A blank line at the bottom of the file is enough to make it fall over.
	169	* Restart XWiki (you'll need to restart XWiki every time you change <tt>intermap.txt</tt>) and try out an Interwiki link.
	170	* If it does not work, check your <tt>xwiki.log</tt> file. You'll see if <tt>conf/intermap.txt</tt> could not be found, or if there was an error parsing it.
	171
1.26	172	1.1 Setting the default editor to use (Wiki or WYSIWYG)
	173
20.1	174	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	175
1.28	176	{image:defaulteditor.png}
1.26	177
7.1	178	1.1 Short URLs
	179
7.2	180	It's possible to [configure XWiki so that is uses shorter URLs>Main.ShortURLs].
7.1	181
31.1	182	1.1 Configure the names of database schemas (since 1.6M1)
8.1	183
	184	Sometimes, especially in enterprise environment, we need control names of database schemes, other than default.
	185
	186	* xwiki.db -- name of database scheme of main wiki.
44.1	187	* xwiki.db.prefix -- usefull mainly for [virtual wikies>Virtualization], where we have database scheme for each virtual wiki. This prefix is added to database scheme name after usual mapping between wiki names and schemes. Note that this is also applying to main wiki database name.
8.1	188
44.1	189
9.1	190	1.1 Turning off comments or attachments
	191
	192	You need to change the XWiki.XWikiPreferences class like this:
	193
9.2	194	* Go to <tt>\<server\>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class</tt>
9.1	195	* Add a new property called <tt>showcomments</tt> (or <tt>showattachments</tt> for turning off attachments) of type String Class
9.2	196	* Go to <tt>\<server\>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences</tt> and write no in the <tt>showcomments</tt> (or <tt>showattachments</tt>) field
9.1	197
	198	That's it, the comments (or attachments) are gone. If you want to re-enable them, replace the "no" value with "yes".
	199
16.1	200	1.1 Configure edit comment behavior
	201
	202	When page editing you can add a comment of changes in special comment field by default (Look at [Features.PageEditing#HCommoneditactions]).
	203	You can disable this feature by set ~~xwiki.editcomment=0~~ in ~~xwiki.cfg~~.
	204
	205	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.
	206	If you want a popup, but want to be able to set empty edit comment, set ~~xwiki.editcomment.suggested=1~~ in ~~xwiki.cfg~~
	207
	208	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.
	209
	210	You can use the special fields in ~~XWikiPreferences~~ object instead of edit ~~xwiki.cfg~~.
	211	These fields are: ~~editcomment~~, ~~editcomment_mandatory~~, ~~editcomment_suggested~~ and ~~editcomment_hidden~~.
	212
10.1	213	1.1 Configuring the SMTP server
	214
	215	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.
	216
20.1	217	To configure these go to the Administration page (<tt>http://\<server\>/xwiki/bin/admin/XWiki/XWikiPreferences</tt>), click on the "general" icon and modify the <tt>Admin email</tt> field to set the email under which XWiki emails will be sent and modify the <tt>Outgoing SMTP Server</tt> field to set the SMTP server to use, as shown on the figure below.
10.1	218
	219	{image:emailconfiguration.png}
	220
42.1	221	1.1.1 Configuring authentication for SMTP
14.1	222
42.1	223	By default, the username/password fields are not available in the preferences. In order to configure the SMTP authentication, you must:
	224
42.2	225	- Edit the <tt>XWiki.XWikiPreferences</tt> class (<tt>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class</tt>) and add two <tt>String</tt> fields, named <tt>smtp_server_username</tt> and <tt>smtp_server_password</tt>.
	226	- Edit the <tt>XWiki.XWikiPreferences</tt> object (<tt>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences&nb=0&property=smtp_server_username,smtp_server_password</tt>) and enter the required username and password in the newly added fields.
42.1	227
	228	1.1.1 Configuring TLS for the connection to the server
	229
	230	In order to enable TLS, you must:
42.2	231	- Edit the <tt>XWiki.XWikiPreferences</tt> class (<tt>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class</tt>) and add a <tt>TextArea</tt> field, named <tt>javamail_extra_props </tt>.
	232	- Edit the <tt>XWiki.XWikiPreferences</tt> object (<tt>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences&nb=0&property=javamail_extra_props</tt>) and enter: <tt>mail.smtp.starttls.enable=true</tt>
42.1	233
31.1	234	1.1 Configuring WebDAV (since 1.7)
	235
33.1	236	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	237
34.1	238	1.1.1 Securing WebDAV Server
32.1	239
33.1	240	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.
	241
	242	1.1.1 Disabling WebDAV
	243
35.1	244	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	245
	246	{code}
	247	<servlet-mapping>
	248	<servlet-name>webdav</servlet-name>
	249	<url-pattern>/webdav/*</url-pattern>
	250	</servlet-mapping>
	251	{code}
	252
34.1	253
35.1	254
13.1	255	1.1 Redirections
	256
	257	XWiki supports defining redirections for incoming requests. To activate this feature modify your <tt>xwiki.cfg</tt> file and set the following property:
	258	{code:none}
	259	xwiki.preferences.redirect=1
	260	{code}
	261
	262	Then for each redirection you want to add, add a <tt>XWiki.GlobalRedirect</tt> object to your main wiki's <tt>XWiki.XWikiPreferences</tt> document. The <tt>XWiki.GlobalRedirect</tt> object has 2 fields: <tt>pattern</tt> and <tt>destination</tt>. The URL received is matched on <tt>pattern</tt> and if there's a match it's replaced with the value from <tt>destination</tt>. XWiki then redirects to the new URL.
	263
15.2	264	1.1 Customizing the PDF export Look & Feel
15.1	265
30.2	266	#info("A new rendering subsystem is on its way, so things could change in the following few months. You may want keep an eye on [the new rendering architecture page>http://dev.xwiki.org/xwiki/bin/view/Design/NewRenderingArchitecture>new].")
24.1	267
30.2	268	Here's how the PDF and RTF exports currently work:
28.1	269
30.2	270	{image:XWikiExport200805192259.png}
	271
	272	As shown in the diagram you can customize 3 parts:
	273	* The CSS used to render the content as PDF/RTF
	274	* The XHTML2FO XSL transformation
	275	* The FOP XSL transformation
	276
	277	In order to provide your own customization you need to start by creating a new [XWiki Class>platform:DevGuide.DataModel]. To do that simply create a new page and edit it in Class mode (for ex: <tt>http:/yourserver.com/xwiki/bin/edit/XWiki/PDFClass?editor=class</tt>). Add the following Text Area properties as needed (they are all optional so you only need to define the ones you need to use):
	278	* <tt>style</tt>: contains the CSS information that will be overriding the default <tt>pdf.css</tt> values.
	279	* <tt>xhtmlxsl</tt>: contains the XHTML to FO XSL overriding the default one.
	280	* <tt>fopxsl</tt>: contains the FOP to PDF/RTF XSL overriding the default one.
	281
	282	Then create a new page (say <tt>XWiki.PDFTemplate</tt>) and add the <tt>XWiki.PDFClass</tt> object to it.
	283
	284	Last use that page when calling the PDF/RTF export using the <tt>pdftemplate</tt> parameter as in <tt>http://yourserver/xwiki/bin/export/Space/Page?format=pdf&language=en&pdftemplate=XWiki.PDFTemplate</tt>.
	285
	286	#warning("As mentioned the <tt>style</tt> property stores CSS code. Don't add blank line between the rules. The field is parsed and rendered, so a blank line causes a paragraph to appear there, which breaks the CSS. You must use this... {code}
28.1	287	h2 {
	288	margin-left: 2cm;
	289	margin-bottom: 1cm;
	290	color: red;
	291	}
	292	h3 {
	293	margin: 3cm;
	294	color: yellow;
	295	}
30.2	296	{code} And not... {code}
28.1	297	h2 {
	298	margin-left: 2cm;
	299	margin-bottom: 1cm;
	300	color: red;
	301	}
	302
	303	h3 {
	304	margin: 3cm;
	305	color: yellow;
	306	}
30.2	307	{code}")
28.1	308
30.2	309	#info("Even though RTF export is expected to work the same way, there are still some isues to be solved affecting how CSS properties control the final layout.")
28.1	310
41.2	311	1.1 Configuring Wiki Syntaxes and default Syntax
23.1	312
41.4	313	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 <tt>WEB-INF/xwiki.cfg</tt> file and configure the <tt>xwiki.rendering.syntaxes</tt> property. It's a comma-separated list of syntax ids. For example:
24.1	314
41.3	315	{code:none}
30.1	316	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
	317	{code}
25.1	318
41.4	319	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 <tt>WEB-INF/xwiki.properties</tt> file and configure the <tt>core.defaultDocumentSyntax</tt> property. For example to use XWiki Syntax 2.0 by default:
41.2	320
41.3	321	{code:none}
41.2	322	#-# Specifies the default syntax to use when creating new documents.
	323	#-# Default value is xwiki/1.0.
	324	core.defaultDocumentSyntax = xwiki/2.0
	325	{code}
	326
41.5	327	#warning("Hint: If it doesn't work check that you've edited the correct configuration file.")
	328
1.18	329	1.1 Sample xwiki.cfg
	330
1.22	331	{code}
	332	xwiki.base=../../
30.1	333
1.22	334	xwiki.store.class=com.xpn.xwiki.store.XWikiHibernateStore
	335	xwiki.store.hibernate.path=/WEB-INF/hibernate.cfg.xml
	336	xwiki.store.hibernate.updateschema=1
	337	xwiki.store.hibernate.custommapping=1
	338	xwiki.store.cache=1
	339	xwiki.store.cache.capacity=100
30.1	340	xwiki.store.migration=1
	341
1.22	342	xwiki.monitor=1
	343
30.1	344	# List of active plugins.
	345	xwiki.plugins=\
	346	com.xpn.xwiki.monitor.api.MonitorPlugin,\
	347	com.xpn.xwiki.plugin.calendar.CalendarPlugin,\
	348	com.xpn.xwiki.plugin.skinx.JsSkinExtensionPlugin,\
	349	com.xpn.xwiki.plugin.skinx.CssSkinExtensionPlugin,\
	350	com.xpn.xwiki.plugin.feed.FeedPlugin,\
	351	com.xpn.xwiki.plugin.ldap.LDAPPlugin,\
	352	com.xpn.xwiki.plugin.google.GooglePlugin,\
	353	com.xpn.xwiki.plugin.flickr.FlickrPlugin,\
	354	com.xpn.xwiki.plugin.mail.MailPlugin,\
	355	com.xpn.xwiki.plugin.packaging.PackagePlugin,\
	356	com.xpn.xwiki.plugin.query.QueryPlugin,\
	357	com.xpn.xwiki.plugin.svg.SVGPlugin,\
	358	com.xpn.xwiki.plugin.charts.ChartingPlugin,\
	359	com.xpn.xwiki.plugin.fileupload.FileUploadPlugin,\
	360	com.xpn.xwiki.plugin.image.ImagePlugin,\
	361	com.xpn.xwiki.plugin.captcha.CaptchaPlugin,\
	362	com.xpn.xwiki.plugin.userdirectory.UserDirectoryPlugin,\
	363	com.xpn.xwiki.plugin.usertools.XWikiUserManagementToolsImpl,\
	364	com.xpn.xwiki.plugin.zipexplorer.ZipExplorerPlugin,\
	365	com.xpn.xwiki.plugin.autotag.AutoTagPlugin,\
	366	com.xpn.xwiki.plugin.lucene.LucenePlugin,\
	367	com.xpn.xwiki.plugin.diff.DiffPlugin,\
	368	com.xpn.xwiki.plugin.rightsmanager.RightsManagerPlugin,\
	369	com.xpn.xwiki.plugin.jodatime.JodaTimePlugin,\
	370	com.xpn.xwiki.plugin.scheduler.SchedulerPlugin,\
	371	com.xpn.xwiki.plugin.mailsender.MailSenderPlugin,\
	372	com.xpn.xwiki.plugin.watchlist.WatchListPlugin, \
	373	com.xpn.xwiki.wysiwyg.server.plugin.WysiwygPlugin
1.22	374
30.1	375	# [Since 1.6RC1] Defines the list of supported syntaxes
	376	# Available syntaxes are:
	377	# xwiki/1.0, xwiki/2.0, confluence/1.0, jspwiki/1.0, creole/1.0,
	378	# mediawiki/1.0, xhtml/1.0, twiki/1.0
	379	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
	380
	381	# This parameter allows XWiki to operate in Hosting mode allowing to create
	382	# multiple wikis having their own database and responding to different URLs
1.22	383	xwiki.virtual=0
30.1	384
1.22	385	xwiki.virtual.redirect=http://127.0.0.1:9080/xwiki/bin/Main/ThisWikiDoesNotExist
	386
30.1	387	# This parameter will activate the eXo Platform integration
1.22	388	xwiki.exo=0
	389
	390	xwiki.authentication=form
	391	xwiki.authentication.validationKey=totototototototototototototototo
	392	xwiki.authentication.encryptionKey=titititititititititititititititi
	393	xwiki.authentication.cookiedomains=xwiki.com,wiki.fr
	394
30.1	395	# This allows logout to happen for any page going through the /logout/ action, regardless of the document or the servlet.
	396	# Comment-out if you want to enable logout only for /bin/logout/XWiki/XWikiLogout
	397	xwiki.authentication.logoutpage=(/[^/]+/\|/)logout/*
	398
	399	# Stats configuration allows to globally activate/deactivate stats module (launch storage thread, register events...)
	400	xwiki.stats=1
	401	# When statistics are globally enabled, storage can be enabled/disabled by wiki using the XWikiPreference property "statistics".
	402	# Note: Statistics are disabled by default for improved performances/space.
	403	xwiki.stats.default=0
	404	# It is also possible to choose a different stats service to record statistics separately from XWiki.
1.22	405	xwiki.stats.class=com.xpn.xwiki.stats.impl.XWikiStatsServiceImpl
	406
	407	xwiki.encoding=ISO-8859-1
30.1	408
1.22	409	xwiki.backlinks=1
30.1	410
1.22	411	xwiki.tags=1
	412
30.1	413	# Use edit comments
1.22	414	xwiki.editcomment=1
30.1	415
	416	# Hide editcomment field and only use Javascript
1.22	417	xwiki.editcomment.hidden=0
30.1	418
	419	# Make edit comment mandatory
1.22	420	xwiki.editcomment.mandatory=0
30.1	421
	422	# Make edit comment suggested (asks 1 time if the comment is empty.
	423	# 1 shows one popup if comment is empty.
	424	# 0 means there is no popup.
	425	# This setting is ignored if mandatory is set
1.22	426	xwiki.editcomment.suggested=0
	427
30.1	428	# GraphViz plugin configuration. The GraphViz plugin is not configured by default.
	429	# To enable it, add "com.xpn.xwiki.plugin.graphviz.GraphVizPlugin" to the list of plugins
	430	# in the xwiki.plugins property.
	431	# Uncomment and set the locations of the Dot and Neato executables
	432	#xwiki.plugin.graphviz.dotpath=c:/Program Files/ATT/GraphViz/bin/dot.exe
	433	#xwiki.plugin.graphviz.neatopath=c:/Program Files/ATT/GraphViz/bin/neato.exe
1.22	434
	435	xwiki.plugin.laszlo.baseurl=/openlaszlo/xwiki/
	436	xwiki.plugin.laszlo.path=c:/Program Files/Apache Software Foundation/Tomcat 5.0/webapps/openlaszlo/xwiki/
	437
	438	xwiki.plugin.image.cache.capacity=30
	439
30.1	440	xwiki.plugin.captcha=0
1.22	441
	442
30.1	443	# Enable to allow superadmin. It is disabled by default as this could be a security breach if
	444	# it were set and you forgot about it.
	445	#xwiki.superadminpassword=system
1.22	446
30.1	447	#-------------------------------------------------------------------------------------
	448	# LDAP
	449	#-------------------------------------------------------------------------------------
	450
	451	#-# new LDAP authentication service
	452	# xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
	453
	454	#-# Turn LDAP authentication on - otherwise only XWiki authentication
	455	#-# 0: disable
	456	#-# 1: enable
	457	# xwiki.authentication.ldap=1
	458
	459	#-# LDAP Server (Active Directory, eDirectory, OpenLDAP, etc.)
	460	xwiki.authentication.ldap.server=127.0.0.1
1.22	461	xwiki.authentication.ldap.port=389
30.1	462
	463	#-# LDAP login, empty = anonymous access, otherwise specify full dn
	464	#-# {0} is replaced with the username, {1} with the password
	465	xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP
1.22	466	xwiki.authentication.ldap.bind_pass={1}
	467
30.1	468	#-# Force to check password after LDAP connection
	469	#-# 0: disable
	470	#-# 1: enable
	471	xwiki.authentication.ldap.validate_password=0
	472
	473	#-# only members of the following group will be verified in the LDAP
	474	#-# otherwise only users that are found after searching starting from the base_DN
	475	# xwiki.authentication.ldap.user_group=cn=developers,ou=groups,o=MegaNova,c=US
	476
	477	#-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl]
	478	#-# only users not member of the following group can autheticate
	479	# xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US
	480
	481	#-# base DN for searches
	482	xwiki.authentication.ldap.base_DN=
	483
	484	#-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name (default=cn)
	485	# xwiki.authentication.ldap.UID_attr=cn
	486
	487	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
	488	#-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password" is set to 1
	489	# xwiki.authentication.ldap.password_field=userPassword
	490
	491	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
	492	#-# The potential LDAP groups classes. Separated by commas.
	493	# xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList
	494
	495	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
	496	#-# The potential names of the LDAP groups fields containings the members. Separated by commas.
	497	# xwiki.authentication.ldap.group_memberfields=member,uniqueMember
	498
	499	#-# retrieve the following fields from LDAP and store them in the XWiki user object (xwiki-attribute=ldap-attribute)
	500	#-# ldap_dn=dn -- dn is set by class, caches dn in XWiki.user object for faster access
	501	xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,fullname=fullName,email=mail,ldap_dn=dn
	502
	503	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	504	#-# on every login update the mapped attributes from LDAP to XWiki otherwise this happens only once when the XWiki account is created.
	505	xwiki.authentication.ldap.update_user=1
	506
	507	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	508	#-# mapps XWiki groups to LDAP groups, separator is "\|"
	509	# xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=AdminRole,ou=groups,o=MegaNova,c=US\|\
	510	# XWiki.Organisation=cn=testers,ou=groups,o=MegaNova,c=US
	511
	512	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	513	#-# time in s after which the list of members in a group is refreshed from LDAP (default=3600*6)
	514	# xwiki.authentication.ldap.groupcache_expiration=21800
	515
	516	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	517	#-# - create : synchronize group membership only when the user is first created
	518	#-# - always: synchronize on every login
	519	# xwiki.authentication.ldap.mode_group_sync=always
	520
	521	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	522	#-# if ldap authentication fails for any reason, try XWiki DB authentication with the same credentials
	523	xwiki.authentication.ldap.trylocal=1
	524
	525	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	526	#-# SSL connection to LDAP server
	527	#-# 0: normal
	528	#-# 1: SSL
	529	# xwiki.authentication.ldap.ssl=0
	530
	531	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	532	#-# The keystore file to use in SSL connection
	533	# xwiki.authentication.ldap.ssl.keystore=
	534
	535	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
	536	#-# The java secure provider used in SSL connection
	537	# xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider
	538
	539	#-------------------------------------------------------------------------------------
	540	# Cache
	541	#-------------------------------------------------------------------------------------
	542
	543	#-# [Since 1.5M2]
	544	#-# The cache component implementation to use as "normal" (can be local or distributed depending on the implementation)
	545	#-# cache component.
	546	# xwiki.cache.cachefactory.hint=jbosscache
	547
	548	#-# [Since 1.5M2]
	549	#-# The cache component to use as local cache component.
	550	# xwiki.cache.cachefactory.local.hint=jbosscache/local
	551
	552	#-------------------------------------------------------------------------------------
	553
	554
1.22	555	xwiki.authentication.unauthorized_code=200
	556
30.1	557	# This parameter will activate the sectional editing
1.22	558	xwiki.section.edit=1
	559
30.1	560	# Uncomment if you want to ignore requests for unmapped actions, and simply display the document
	561	# xwiki.unknownActionResponse=view
1.22	562
	563
30.1	564	# You can configure the toolbars you wish to see in the WYSIWYG editor by defining the
	565	# xwiki.wysiwyg.toolbars property.
	566	# When not defined it defaults to:
	567	# xwiki.wysiwyg.toolbars=texttoolbar, listtoolbar, indenttoolbar, undotoolbar, titletoolbar, \
	568	# styletoolbar, horizontaltoolbar, attachmenttoolbar, macrostoolbar, \
	569	# tabletoolbar, tablerowtoolbar, tablecoltoolbar, linktoolbar
	570	# The full list of toolbars includes the one defined above and the following ones:
	571	# subtoolbar, findtoolbar, symboltoolbar
1.22	572
	573
30.1	574	xwiki.defaultskin=toucan
1.22	575	xwiki.defaultbaseskin=albatross
	576
30.1	577	# Calendar Prev/Next Month bounds.
	578	# The calendar generates links to the previous/next months for a limited range, by default 6 months back and 12 months after.
	579	# A value of 0 means that there is no limit in that direction.
	580	# xwiki.calendar.bound.prev=6
	581	# xwiki.calendar.bound.next=12
	582
	583	# xwiki.temp.dir=/tmp/xwiki
	584	# xwiki.work.dir=/usr/local/xwiki
	585
	586	# xwiki.plugins.lucene.indexdir=/usr/local/xwiki/lucene
	587	# xwiki.plugins.lucene.analyzer=org.apache.lucene.analysis.standard.StandardAnalyzer
	588	# xwiki.plugins.lucene.indexinterval=20
	589
	590	#-# [Since 1.6M1]
	591	#-# Force the database name for the main wiki in virtual mode and for the wiki itself in non virtual mode
	592	# xwiki.db=xwiki
	593
	594	#-# [Since 1.6M1]
	595	#-# Add a prefix to all databases names of the wikis in virtual mode and to the wiki name in non virtual mode
	596	# xwiki.db.prefix=
	597
	598	xwiki.work.dir=work
1.22	599	{code}
	600

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