Wiki source code of Configuration

Version 49.1 by Sergiu Dumitriu on 2009/12/17

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
49.1	110	1.1.1 Document versioning
	111
	112	One of the key features of a wiki engine is the ability to keep all the history of a document, giving users the ability to see the evolution of a document, but also to revert changes. However, the history of an active wiki continuously grows and is usually much larger than the current version of the data. It is possible to disable the versioning feature in XWiki, which means that less storage space will be used, although it will not be possible to revert the document in case of vandalism.
	113
	114	To disable the versioning store, edit ~~xwiki.cfg~~ and add:
	115	{code:none}
	116	xwiki.store.versioning=0
	117	{code}
	118
	119	1.1.1 Attachment versioning
	120
12.4	121	XWiki stores all document attachment versions by default. This is very memory consuming (both RAM and HDD).
	122	If you need only latest versions of attachments, you can disable attachment version control by editing your ~~xwiki.cfg~~ and adding:
49.1	123	{code:none}
12.3	124	xwiki.store.attachment.versioning=0
	125	{code}
	126
49.1	127	1.1.1 Document recycle bin
12.4	128
49.1	129	By default deleted documents are not permanently removed, but are placed in a ~~recycle bin~~, from which they can later be removed or restored. To disable it, edit ~~xwiki.cfg~~ and add:
	130
	131	{code:none}
	132	xwiki.recyclebin=0
	133	{code}
	134
	135	Note that disabling it will make it impossible to restore a deleted document, unless a database backup is available.
	136
	137	By default, a deleted document can be permanently deleted right away by administrators, and after 7 days by regular users. To change these limits, edit ~~xwiki.cfg~~ and add:
	138
	139	{code:none}
	140	# Admins must wait 3 days before being allowed to permanently delete
	141	xwiki.store.recyclebin.adminWaitDays=3
	142	# Normal users must also wait 3 days
	143	xwiki.store.recyclebin.waitDays=3
	144	{code}
	145
	146	1.1.1 Attachment recycle bin
	147
	148	Deleted attachments are also stored in a recycle bin, so that they can be restored along with the document when rolling back or previewing an earlier version in which the attachment should be visible. To disable this feature, edit ~~xwiki.cfg~~ and add:
	149
	150	{code:none}
	151	storage.attachment.recyclebin=0
	152	{code}
	153
1.4	154	1.1 Customizing the Skin
1.3	155
	156	See the [Skin Guide>AdminGuide.Skins].
	157
1.4	158	1.1 Security configuration
1.3	159
	160	See the [Security Guide>AdminGuide.Security].
	161
1.4	162	1.1 Customizing Menus
1.3	163
6.2	164	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	165
1.5	166	1.1 Encoding
1.3	167
1.5	168	See the [Encoding Guide>AdminGuide.Encoding].
	169
1.6	170	1.1 User Authentication
1.5	171
1.9	172	See the [Authentication Guide>AdminGuide.Authentication].
1.18	173
1.30	174	1.1 Customizing the registration page
	175
	176	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>.
	177
29.1	178	See [more details about configuring the registration page>AdminGuide.User Management#HCustomizingtheRegistrationpage].
1.23	179	1.1 Logging
	180
	181	See the [Logging page>Logging].
	182
1.24	183	1.1 Configuring Interwiki links
	184
	185	[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\].
	186
	187	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].
	188
	189	To configure Interwiki links on your wiki:
	190
	191	* Create a file named <tt>\[location from where you start your container\]/conf/intermap.txt</tt>
	192	* Fill <tt>intermap.txt</tt> with content like:
	193	{code}
	194	IMDB http://us.imdb.com/Title?
	195	OpenWiki http://openwiki.com/?
	196	SourceForge http://sourceforge.net/
	197	TWiki http://twiki.org/cgi-bin/view/
	198	Why http://clublet.com/c/c/why?
	199	Wiki http://c2.com/cgi/wiki?
	200	WikiPedia http://www.wikipedia.com/wiki/
	201	{code}
	202
	203	You can of course add your own entries.
	204
	205	* 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.
	206	* Restart XWiki (you'll need to restart XWiki every time you change <tt>intermap.txt</tt>) and try out an Interwiki link.
	207	* 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.
	208
1.26	209	1.1 Setting the default editor to use (Wiki or WYSIWYG)
	210
20.1	211	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	212
1.28	213	{image:defaulteditor.png}
1.26	214
47.1	215	1.1 Configure the WYSIWYG editor
	216
	217	See [WYSIWYG Editor Configuration>WysiwygEditor] page to find out how you can enable or disable editing features.
	218
7.1	219	1.1 Short URLs
	220
7.2	221	It's possible to [configure XWiki so that is uses shorter URLs>Main.ShortURLs].
7.1	222
31.1	223	1.1 Configure the names of database schemas (since 1.6M1)
8.1	224
	225	Sometimes, especially in enterprise environment, we need control names of database schemes, other than default.
	226
	227	* xwiki.db -- name of database scheme of main wiki.
44.1	228	* 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	229
44.1	230
9.1	231	1.1 Turning off comments or attachments
	232
	233	You need to change the XWiki.XWikiPreferences class like this:
	234
9.2	235	* Go to <tt>\<server\>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class</tt>
9.1	236	* Add a new property called <tt>showcomments</tt> (or <tt>showattachments</tt> for turning off attachments) of type String Class
9.2	237	* 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	238
	239	That's it, the comments (or attachments) are gone. If you want to re-enable them, replace the "no" value with "yes".
	240
16.1	241	1.1 Configure edit comment behavior
	242
	243	When page editing you can add a comment of changes in special comment field by default (Look at [Features.PageEditing#HCommoneditactions]).
	244	You can disable this feature by set ~~xwiki.editcomment=0~~ in ~~xwiki.cfg~~.
	245
	246	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.
	247	If you want a popup, but want to be able to set empty edit comment, set ~~xwiki.editcomment.suggested=1~~ in ~~xwiki.cfg~~
	248
	249	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.
	250
	251	You can use the special fields in ~~XWikiPreferences~~ object instead of edit ~~xwiki.cfg~~.
	252	These fields are: ~~editcomment~~, ~~editcomment_mandatory~~, ~~editcomment_suggested~~ and ~~editcomment_hidden~~.
	253
10.1	254	1.1 Configuring the SMTP server
	255
	256	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.
	257
20.1	258	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	259
	260	{image:emailconfiguration.png}
	261
42.1	262	1.1.1 Configuring authentication for SMTP
14.1	263
48.1	264	#warning("These instructions are now obsolete")
	265
42.1	266	By default, the username/password fields are not available in the preferences. In order to configure the SMTP authentication, you must:
	267
42.2	268	- 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>.
	269	- 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	270
48.2	271	1.1.1 Configuring TLS for the connection to the server
42.1	272
48.1	273	#warning("These instructions are now obsolete")
	274
42.1	275	In order to enable TLS, you must:
42.2	276	- 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>.
	277	- 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	278
48.2	279	1.1.1 Using Google SMTP server
48.1	280
	281	{table}
48.3	282	property\|value
48.1	283	server\|smtp.gmail.com
	284	port\|587
	285	user\|vovan@gmail.com
	286	password\|xakep
	287	JavaMail properties\|mail.smtp.starttls.enable=true
	288	{table}
	289
31.1	290	1.1 Configuring WebDAV (since 1.7)
	291
33.1	292	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	293
34.1	294	1.1.1 Securing WebDAV Server
32.1	295
33.1	296	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.
	297
	298	1.1.1 Disabling WebDAV
	299
35.1	300	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	301
	302	{code}
	303	<servlet-mapping>
	304	<servlet-name>webdav</servlet-name>
	305	<url-pattern>/webdav/*</url-pattern>
	306	</servlet-mapping>
	307	{code}
	308
34.1	309
35.1	310
13.1	311	1.1 Redirections
	312
	313	XWiki supports defining redirections for incoming requests. To activate this feature modify your <tt>xwiki.cfg</tt> file and set the following property:
	314	{code:none}
	315	xwiki.preferences.redirect=1
	316	{code}
	317
	318	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.
	319
15.2	320	1.1 Customizing the PDF export Look & Feel
15.1	321
46.2	322	#info("In the future we'll want to rewrite the PDF/RTF exports as Renderers in the new [Rendering Module architecture>code:Modules.RenderingModule]. When this happens this section will be upgraded.")
24.1	323
30.2	324	Here's how the PDF and RTF exports currently work:
28.1	325
30.2	326	{image:XWikiExport200805192259.png}
	327
	328	As shown in the diagram you can customize 3 parts:
	329	* The CSS used to render the content as PDF/RTF
	330	* The XHTML2FO XSL transformation
	331	* The FOP XSL transformation
	332
	333	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):
	334	* <tt>style</tt>: contains the CSS information that will be overriding the default <tt>pdf.css</tt> values.
	335	* <tt>xhtmlxsl</tt>: contains the XHTML to FO XSL overriding the default one.
	336	* <tt>fopxsl</tt>: contains the FOP to PDF/RTF XSL overriding the default one.
	337
	338	Then create a new page (say <tt>XWiki.PDFTemplate</tt>) and add the <tt>XWiki.PDFClass</tt> object to it.
	339
	340	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>.
	341
	342	#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	343	h2 {
	344	margin-left: 2cm;
	345	margin-bottom: 1cm;
	346	color: red;
	347	}
	348	h3 {
	349	margin: 3cm;
	350	color: yellow;
	351	}
30.2	352	{code} And not... {code}
28.1	353	h2 {
	354	margin-left: 2cm;
	355	margin-bottom: 1cm;
	356	color: red;
	357	}
	358
	359	h3 {
	360	margin: 3cm;
	361	color: yellow;
	362	}
30.2	363	{code}")
28.1	364
30.2	365	#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	366
46.1	367
41.2	368	1.1 Configuring Wiki Syntaxes and default Syntax
23.1	369
41.4	370	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	371
41.3	372	{code:none}
30.1	373	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
	374	{code}
25.1	375
41.4	376	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	377
41.3	378	{code:none}
41.2	379	#-# Specifies the default syntax to use when creating new documents.
	380	#-# Default value is xwiki/1.0.
	381	core.defaultDocumentSyntax = xwiki/2.0
	382	{code}
	383
41.5	384	#warning("Hint: If it doesn't work check that you've edited the correct configuration file.")
	385
1.18	386	1.1 Sample xwiki.cfg
	387
1.22	388	{code}
	389	xwiki.base=../../
30.1	390
1.22	391	xwiki.store.class=com.xpn.xwiki.store.XWikiHibernateStore
	392	xwiki.store.hibernate.path=/WEB-INF/hibernate.cfg.xml
	393	xwiki.store.hibernate.updateschema=1
	394	xwiki.store.hibernate.custommapping=1
	395	xwiki.store.cache=1
	396	xwiki.store.cache.capacity=100
30.1	397	xwiki.store.migration=1
	398
1.22	399	xwiki.monitor=1
	400
30.1	401	# List of active plugins.
	402	xwiki.plugins=\
	403	com.xpn.xwiki.monitor.api.MonitorPlugin,\
	404	com.xpn.xwiki.plugin.calendar.CalendarPlugin,\
	405	com.xpn.xwiki.plugin.skinx.JsSkinExtensionPlugin,\
	406	com.xpn.xwiki.plugin.skinx.CssSkinExtensionPlugin,\
	407	com.xpn.xwiki.plugin.feed.FeedPlugin,\
	408	com.xpn.xwiki.plugin.ldap.LDAPPlugin,\
	409	com.xpn.xwiki.plugin.google.GooglePlugin,\
	410	com.xpn.xwiki.plugin.flickr.FlickrPlugin,\
	411	com.xpn.xwiki.plugin.mail.MailPlugin,\
	412	com.xpn.xwiki.plugin.packaging.PackagePlugin,\
	413	com.xpn.xwiki.plugin.query.QueryPlugin,\
	414	com.xpn.xwiki.plugin.svg.SVGPlugin,\
	415	com.xpn.xwiki.plugin.charts.ChartingPlugin,\
	416	com.xpn.xwiki.plugin.fileupload.FileUploadPlugin,\
	417	com.xpn.xwiki.plugin.image.ImagePlugin,\
	418	com.xpn.xwiki.plugin.captcha.CaptchaPlugin,\
	419	com.xpn.xwiki.plugin.userdirectory.UserDirectoryPlugin,\
	420	com.xpn.xwiki.plugin.usertools.XWikiUserManagementToolsImpl,\
	421	com.xpn.xwiki.plugin.zipexplorer.ZipExplorerPlugin,\
	422	com.xpn.xwiki.plugin.autotag.AutoTagPlugin,\
	423	com.xpn.xwiki.plugin.lucene.LucenePlugin,\
	424	com.xpn.xwiki.plugin.diff.DiffPlugin,\
	425	com.xpn.xwiki.plugin.rightsmanager.RightsManagerPlugin,\
	426	com.xpn.xwiki.plugin.jodatime.JodaTimePlugin,\
	427	com.xpn.xwiki.plugin.scheduler.SchedulerPlugin,\
	428	com.xpn.xwiki.plugin.mailsender.MailSenderPlugin,\
	429	com.xpn.xwiki.plugin.watchlist.WatchListPlugin, \
	430	com.xpn.xwiki.wysiwyg.server.plugin.WysiwygPlugin
1.22	431
30.1	432	# [Since 1.6RC1] Defines the list of supported syntaxes
	433	# Available syntaxes are:
	434	# xwiki/1.0, xwiki/2.0, confluence/1.0, jspwiki/1.0, creole/1.0,
	435	# mediawiki/1.0, xhtml/1.0, twiki/1.0
	436	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
	437
	438	# This parameter allows XWiki to operate in Hosting mode allowing to create
	439	# multiple wikis having their own database and responding to different URLs
1.22	440	xwiki.virtual=0
30.1	441
1.22	442	xwiki.virtual.redirect=http://127.0.0.1:9080/xwiki/bin/Main/ThisWikiDoesNotExist
	443
30.1	444	# This parameter will activate the eXo Platform integration
1.22	445	xwiki.exo=0
	446
	447	xwiki.authentication=form
	448	xwiki.authentication.validationKey=totototototototototototototototo
	449	xwiki.authentication.encryptionKey=titititititititititititititititi
	450	xwiki.authentication.cookiedomains=xwiki.com,wiki.fr
	451
30.1	452	# This allows logout to happen for any page going through the /logout/ action, regardless of the document or the servlet.
	453	# Comment-out if you want to enable logout only for /bin/logout/XWiki/XWikiLogout
	454	xwiki.authentication.logoutpage=(/[^/]+/\|/)logout/*
	455
	456	# Stats configuration allows to globally activate/deactivate stats module (launch storage thread, register events...)
	457	xwiki.stats=1
	458	# When statistics are globally enabled, storage can be enabled/disabled by wiki using the XWikiPreference property "statistics".
	459	# Note: Statistics are disabled by default for improved performances/space.
	460	xwiki.stats.default=0
	461	# It is also possible to choose a different stats service to record statistics separately from XWiki.
1.22	462	xwiki.stats.class=com.xpn.xwiki.stats.impl.XWikiStatsServiceImpl
	463
	464	xwiki.encoding=ISO-8859-1
30.1	465
1.22	466	xwiki.backlinks=1
30.1	467
1.22	468	xwiki.tags=1
	469
30.1	470	# Use edit comments
1.22	471	xwiki.editcomment=1
30.1	472
	473	# Hide editcomment field and only use Javascript
1.22	474	xwiki.editcomment.hidden=0
30.1	475
	476	# Make edit comment mandatory
1.22	477	xwiki.editcomment.mandatory=0
30.1	478
	479	# Make edit comment suggested (asks 1 time if the comment is empty.
	480	# 1 shows one popup if comment is empty.
	481	# 0 means there is no popup.
	482	# This setting is ignored if mandatory is set
1.22	483	xwiki.editcomment.suggested=0
	484
30.1	485	# GraphViz plugin configuration. The GraphViz plugin is not configured by default.
	486	# To enable it, add "com.xpn.xwiki.plugin.graphviz.GraphVizPlugin" to the list of plugins
	487	# in the xwiki.plugins property.
	488	# Uncomment and set the locations of the Dot and Neato executables
	489	#xwiki.plugin.graphviz.dotpath=c:/Program Files/ATT/GraphViz/bin/dot.exe
	490	#xwiki.plugin.graphviz.neatopath=c:/Program Files/ATT/GraphViz/bin/neato.exe
1.22	491
	492	xwiki.plugin.laszlo.baseurl=/openlaszlo/xwiki/
	493	xwiki.plugin.laszlo.path=c:/Program Files/Apache Software Foundation/Tomcat 5.0/webapps/openlaszlo/xwiki/
	494
	495	xwiki.plugin.image.cache.capacity=30
	496
30.1	497	xwiki.plugin.captcha=0
1.22	498
	499
30.1	500	# Enable to allow superadmin. It is disabled by default as this could be a security breach if
	501	# it were set and you forgot about it.
	502	#xwiki.superadminpassword=system
1.22	503
30.1	504	#-------------------------------------------------------------------------------------
	505	# LDAP
	506	#-------------------------------------------------------------------------------------
	507
	508	#-# new LDAP authentication service
	509	# xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
	510
	511	#-# Turn LDAP authentication on - otherwise only XWiki authentication
	512	#-# 0: disable
	513	#-# 1: enable
	514	# xwiki.authentication.ldap=1
	515
	516	#-# LDAP Server (Active Directory, eDirectory, OpenLDAP, etc.)
	517	xwiki.authentication.ldap.server=127.0.0.1
1.22	518	xwiki.authentication.ldap.port=389
30.1	519
	520	#-# LDAP login, empty = anonymous access, otherwise specify full dn
	521	#-# {0} is replaced with the username, {1} with the password
	522	xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP
1.22	523	xwiki.authentication.ldap.bind_pass={1}
	524
30.1	525	#-# Force to check password after LDAP connection
	526	#-# 0: disable
	527	#-# 1: enable
	528	xwiki.authentication.ldap.validate_password=0
	529
	530	#-# only members of the following group will be verified in the LDAP
	531	#-# otherwise only users that are found after searching starting from the base_DN
	532	# xwiki.authentication.ldap.user_group=cn=developers,ou=groups,o=MegaNova,c=US
	533
	534	#-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl]
	535	#-# only users not member of the following group can autheticate
	536	# xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US
	537
	538	#-# base DN for searches
	539	xwiki.authentication.ldap.base_DN=
	540
	541	#-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name (default=cn)
	542	# xwiki.authentication.ldap.UID_attr=cn
	543
	544	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
	545	#-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password" is set to 1
	546	# xwiki.authentication.ldap.password_field=userPassword
	547
	548	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
	549	#-# The potential LDAP groups classes. Separated by commas.
	550	# xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList
	551
	552	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
	553	#-# The potential names of the LDAP groups fields containings the members. Separated by commas.
	554	# xwiki.authentication.ldap.group_memberfields=member,uniqueMember
	555
	556	#-# retrieve the following fields from LDAP and store them in the XWiki user object (xwiki-attribute=ldap-attribute)
	557	#-# ldap_dn=dn -- dn is set by class, caches dn in XWiki.user object for faster access
	558	xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,fullname=fullName,email=mail,ldap_dn=dn
	559
	560	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	561	#-# on every login update the mapped attributes from LDAP to XWiki otherwise this happens only once when the XWiki account is created.
	562	xwiki.authentication.ldap.update_user=1
	563
	564	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	565	#-# mapps XWiki groups to LDAP groups, separator is "\|"
	566	# xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=AdminRole,ou=groups,o=MegaNova,c=US\|\
	567	# XWiki.Organisation=cn=testers,ou=groups,o=MegaNova,c=US
	568
	569	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	570	#-# time in s after which the list of members in a group is refreshed from LDAP (default=3600*6)
	571	# xwiki.authentication.ldap.groupcache_expiration=21800
	572
	573	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	574	#-# - create : synchronize group membership only when the user is first created
	575	#-# - always: synchronize on every login
	576	# xwiki.authentication.ldap.mode_group_sync=always
	577
	578	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	579	#-# if ldap authentication fails for any reason, try XWiki DB authentication with the same credentials
	580	xwiki.authentication.ldap.trylocal=1
	581
	582	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	583	#-# SSL connection to LDAP server
	584	#-# 0: normal
	585	#-# 1: SSL
	586	# xwiki.authentication.ldap.ssl=0
	587
	588	#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]
	589	#-# The keystore file to use in SSL connection
	590	# xwiki.authentication.ldap.ssl.keystore=
	591
	592	#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]
	593	#-# The java secure provider used in SSL connection
	594	# xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider
	595
	596	#-------------------------------------------------------------------------------------
	597	# Cache
	598	#-------------------------------------------------------------------------------------
	599
	600	#-# [Since 1.5M2]
	601	#-# The cache component implementation to use as "normal" (can be local or distributed depending on the implementation)
	602	#-# cache component.
	603	# xwiki.cache.cachefactory.hint=jbosscache
	604
	605	#-# [Since 1.5M2]
	606	#-# The cache component to use as local cache component.
	607	# xwiki.cache.cachefactory.local.hint=jbosscache/local
	608
	609	#-------------------------------------------------------------------------------------
	610
	611
1.22	612	xwiki.authentication.unauthorized_code=200
	613
30.1	614	# This parameter will activate the sectional editing
1.22	615	xwiki.section.edit=1
	616
30.1	617	# Uncomment if you want to ignore requests for unmapped actions, and simply display the document
	618	# xwiki.unknownActionResponse=view
1.22	619
	620
30.1	621	# You can configure the toolbars you wish to see in the WYSIWYG editor by defining the
	622	# xwiki.wysiwyg.toolbars property.
	623	# When not defined it defaults to:
	624	# xwiki.wysiwyg.toolbars=texttoolbar, listtoolbar, indenttoolbar, undotoolbar, titletoolbar, \
	625	# styletoolbar, horizontaltoolbar, attachmenttoolbar, macrostoolbar, \
	626	# tabletoolbar, tablerowtoolbar, tablecoltoolbar, linktoolbar
	627	# The full list of toolbars includes the one defined above and the following ones:
	628	# subtoolbar, findtoolbar, symboltoolbar
1.22	629
	630
30.1	631	xwiki.defaultskin=toucan
1.22	632	xwiki.defaultbaseskin=albatross
	633
30.1	634	# Calendar Prev/Next Month bounds.
	635	# The calendar generates links to the previous/next months for a limited range, by default 6 months back and 12 months after.
	636	# A value of 0 means that there is no limit in that direction.
	637	# xwiki.calendar.bound.prev=6
	638	# xwiki.calendar.bound.next=12
	639
	640	# xwiki.temp.dir=/tmp/xwiki
	641	# xwiki.work.dir=/usr/local/xwiki
	642
	643	# xwiki.plugins.lucene.indexdir=/usr/local/xwiki/lucene
	644	# xwiki.plugins.lucene.analyzer=org.apache.lucene.analysis.standard.StandardAnalyzer
	645	# xwiki.plugins.lucene.indexinterval=20
	646
	647	#-# [Since 1.6M1]
	648	#-# Force the database name for the main wiki in virtual mode and for the wiki itself in non virtual mode
	649	# xwiki.db=xwiki
	650
	651	#-# [Since 1.6M1]
	652	#-# Add a prefix to all databases names of the wikis in virtual mode and to the wiki name in non virtual mode
	653	# xwiki.db.prefix=
	654
	655	xwiki.work.dir=work
1.22	656	{code}
	657

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