Wiki source code of Configuration

Version 43.1 by Vincent Massol on 2009/04/14

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

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