Wiki source code of Configuration

Version 35.1 by Asiri Rathnayake on 2008/12/02

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

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