Wiki source code of Configuration

Version 42.2 by Sergiu Dumitriu on 2009/04/05

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

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