Wiki source code of Configuration

Version 40.2 by Vincent Massol on 2009/02/23

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

Get Connected