Configuration (XWiki.org)

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:

#toc("" "" "")

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.

1.1 Date format

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:

{table}

Format | Result

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

1.1.1 Open Wiki

TODO

1.1.1 Public Wiki

TODO

1.1.1 Private Wiki with password

64

1.1.1.1 Global rights

65

66

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.1.1.1 Registration

In [Preferences>http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences] under *Registration* set *Use email verification:yes*. fill the other fields appropriately.

71

72

1.1.1 Private Wiki with token

TODO

1.1.1 An overview of rights

77

78

Here is a lists of all the rights available in XWiki and their default setting.

79

80

* ~~*Right name:* brief description of the right~~

81

** ~~Availability: where you can set this right~~

82

*** ~~Page: this right can be set at the page level~~

83

*** ~~Space: this right can be set at the space level~~

84

*** ~~Wiki: this right can be set at the wiki level~~

85

** ~~Default status: whether the right is allowed or denied when the checkbox is left blank~~

86

*** ~~ALLOWED: this means that users CAN perform the given action if no other right is set~~

87

*** ~~DENIED: this means that users CANNOT perform the given action if no other right is set~~

88

* *View:* whether users can see the page

89

** Availability: this right is available at the page, space and wiki level

90

** Default status: ALLOWED

91

* *Comment:* whether users can add a comment to the page

92

** Availability: this right is available at the page, space and wiki level

93

** Default status: ALLOWED

94

* *Edit:* whether users can edit and save modifications to the page

95

** Availability: this right is available at the page, space and wiki level

96

** Default status: ALLOWED

97

* *Delete:* whether users can delete the page

98

** Availability: this right is available at the page, space and wiki level

99

** Default status: DENIED

100

* *Admin:* whether users can manage administration settings for the space / wiki

101

** Availability: this right is available at the space and wiki level

102

** Default status: DENIED

103

* *Register:* whether users can create new user accounts

104

** Availability: this right is available at the level

105

** Default status: ALLOWED

106

* *Program:* whether users can use protected APIs & Groovy code in wiki pages

107

** Availability: this right is available at the wiki level

108

** Default status: DENIED

109

110

1.1 Enabling/Disabling Statistics

111

112

To disable [the Statistics feature>code:Applications.StatisticsApplication], edit your ~~xwiki.cfg~~ file and replace the following properties as shown here:

113

{code:xml}

114

xwiki.stats=0

115

xwiki.stats.default=0

{code}

where:

* ~~xwiki.stats~~ controls whether Statistics are on or off

121

* ~~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.

122

123

To enable Statistics, change "0" to "1".

124

125

1.1 Optional Store Features

126

127

XWiki stores all document attachment versions by default. This is very memory consuming (both RAM and HDD).

128

If you need only latest versions of attachments, you can disable attachment version control by editing your ~~xwiki.cfg~~ and adding:

129

{code:xml}

130

xwiki.store.attachment.versioning=0

{code}

1.1 Customizing the Skin

135

136

See the [Skin Guide>AdminGuide.Skins].

137

138

1.1 Security configuration

139

140

See the [Security Guide>AdminGuide.Security].

141

142

1.1 Customizing Menus

143

144

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.1 Encoding

See the [Encoding Guide>AdminGuide.Encoding].

149

150

1.1 User Authentication

151

152

See the [Authentication Guide>AdminGuide.Authentication].

153

154

1.1 Customizing the registration page

155

156

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>.

157

158

See [more details about configuring the registration page>AdminGuide.User Management#HCustomizingtheRegistrationpage].

159

1.1 Logging

160

161

See the [Logging page>Logging].

162

163

1.1 Configuring Interwiki links

164

165

[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\].

166

167

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].

168

169

To configure Interwiki links on your wiki:

170

171

* Create a file named <tt>\[location from where you start your container\]/conf/*intermap.txt*</tt>

172

* Fill <tt>intermap.txt</tt> with content like:

173

{code}

174

IMDB http://us.imdb.com/Title?

175

OpenWiki http://openwiki.com/?

176

SourceForge http://sourceforge.net/

177

TWiki http://twiki.org/cgi-bin/view/

178

Why http://clublet.com/c/c/why?

179

Wiki http://c2.com/cgi/wiki?

180

WikiPedia http://www.wikipedia.com/wiki/

181

{code}

182

183

You can of course add your own entries.

184

185

* 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.

186

* Restart XWiki (you'll need to restart XWiki every time you change <tt>intermap.txt</tt>) and try out an Interwiki link.

187

* 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.

188

189

1.1 Setting the default editor to use (Wiki or WYSIWYG)

190

191

Go the Administration screen, then click on the "General" icon and select the default editor to use, as shown on the following screenshot:

192

193

{image:defaulteditor.png}

1.1 Short URLs

It's possible to [configure XWiki so that is uses shorter URLs>Main.ShortURLs].

198

199

1.1 Configure the names of database schemas (since 1.6M1)

200

201

Sometimes, especially in enterprise environment, we need control names of database schemes, other than default.

202

203

* xwiki.db -- name of database scheme of main wiki.

204

* 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.

205

206

1.1 Turning off comments or attachments

207

208

You need to change the XWiki.XWikiPreferences class like this:

209

210

* Go to <tt>\<server\>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class</tt>

211

* Add a new property called <tt>showcomments</tt> (or <tt>showattachments</tt> for turning off attachments) of type String Class

212

* 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

213

214

That's it, the comments (or attachments) are gone. If you want to re-enable them, replace the "no" value with "yes".

215

216

1.1 Configure edit comment behavior

217

218

When page editing you can add a comment of changes in special comment field by default (Look at [Features.PageEditing#HCommoneditactions]).

219

You can disable this feature by set ~~xwiki.editcomment=0~~ in ~~xwiki.cfg~~.

220

221

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.

222

If you want a popup, but want to be able to set empty edit comment, set ~~xwiki.editcomment.suggested=1~~ in ~~xwiki.cfg~~

223

224

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.

225

226

You can use the special fields in ~~XWikiPreferences~~ object instead of edit ~~xwiki.cfg~~.

227

These fields are: ~~editcomment~~, ~~editcomment_mandatory~~, ~~editcomment_suggested~~ and ~~editcomment_hidden~~.

228

229

1.1 Configuring the SMTP server

230

231

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.

232

233

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.

234

235

{image:emailconfiguration.png}

236

237

#warning("Now xwiki can't configure password for SMTP user. Hence, you should use a SMTP server without password Authentication.")

238

239

1.1 Configuring WebDAV (since 1.7)

240

241

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.

242

243

1.1.1 Securing WebDAV Server

244

245

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.

246

247

1.1.1 Disabling WebDAV

248

249

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:

{code}

<servlet-mapping>

<servlet-name>webdav</servlet-name>

254

<url-pattern>/webdav/*</url-pattern>

</servlet-mapping>

{code}

1.1 Redirections

XWiki supports defining redirections for incoming requests. To activate this feature modify your <tt>xwiki.cfg</tt> file and set the following property:

263

{code:none}

264

xwiki.preferences.redirect=1

265

{code}

266

267

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.

268

269

1.1 Customizing the PDF export Look & Feel

270

271

#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].")

272

273

Here's how the PDF and RTF exports currently work:

274

275

{image:XWikiExport200805192259.png}

276

277

As shown in the diagram you can customize 3 parts:

278

* The CSS used to render the content as PDF/RTF

279

* The XHTML2FO XSL transformation

280

* The FOP XSL transformation

281

282

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):

283

* <tt>style</tt>: contains the CSS information that will be overriding the default <tt>pdf.css</tt> values.

284

* <tt>xhtmlxsl</tt>: contains the XHTML to FO XSL overriding the default one.

285

* <tt>fopxsl</tt>: contains the FOP to PDF/RTF XSL overriding the default one.

286

287

Then create a new page (say <tt>XWiki.PDFTemplate</tt>) and add the <tt>XWiki.PDFClass</tt> object to it.

288

289

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>.

290

291

#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}

h2 {

margin-left: 2cm;

margin-bottom: 1cm;

color: red;

}

h3 {

margin: 3cm;

color: yellow;

}

{code} And not... {code}

h2 {

margin-left: 2cm;

margin-bottom: 1cm;

color: red;

}

h3 {

margin: 3cm;

color: yellow;

}

{code}")

#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.")

315

316

1.1 Configuring Wiki Syntaxes

317

318

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:

319

320

{code}

321

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

{code}

1.1 Sample xwiki.cfg

{code}

xwiki.base=../../

xwiki.store.class=com.xpn.xwiki.store.XWikiHibernateStore

330

xwiki.store.hibernate.path=/WEB-INF/hibernate.cfg.xml

331

xwiki.store.hibernate.updateschema=1

332

xwiki.store.hibernate.custommapping=1

333

xwiki.store.cache=1

334

xwiki.store.cache.capacity=100

335

xwiki.store.migration=1

xwiki.monitor=1

# List of active plugins.

340

xwiki.plugins=\

341

com.xpn.xwiki.monitor.api.MonitorPlugin,\

342

com.xpn.xwiki.plugin.calendar.CalendarPlugin,\

343

com.xpn.xwiki.plugin.skinx.JsSkinExtensionPlugin,\

344

com.xpn.xwiki.plugin.skinx.CssSkinExtensionPlugin,\

345

com.xpn.xwiki.plugin.feed.FeedPlugin,\

346

com.xpn.xwiki.plugin.ldap.LDAPPlugin,\

347

com.xpn.xwiki.plugin.google.GooglePlugin,\

348

com.xpn.xwiki.plugin.flickr.FlickrPlugin,\

349

com.xpn.xwiki.plugin.mail.MailPlugin,\

350

com.xpn.xwiki.plugin.packaging.PackagePlugin,\

351

com.xpn.xwiki.plugin.query.QueryPlugin,\

352

com.xpn.xwiki.plugin.svg.SVGPlugin,\

353

com.xpn.xwiki.plugin.charts.ChartingPlugin,\

354

com.xpn.xwiki.plugin.fileupload.FileUploadPlugin,\

355

com.xpn.xwiki.plugin.image.ImagePlugin,\

356

com.xpn.xwiki.plugin.captcha.CaptchaPlugin,\

357

com.xpn.xwiki.plugin.userdirectory.UserDirectoryPlugin,\

358

com.xpn.xwiki.plugin.usertools.XWikiUserManagementToolsImpl,\

359

com.xpn.xwiki.plugin.zipexplorer.ZipExplorerPlugin,\

360

com.xpn.xwiki.plugin.autotag.AutoTagPlugin,\

361

com.xpn.xwiki.plugin.lucene.LucenePlugin,\

362

com.xpn.xwiki.plugin.diff.DiffPlugin,\

363

com.xpn.xwiki.plugin.rightsmanager.RightsManagerPlugin,\

364

com.xpn.xwiki.plugin.jodatime.JodaTimePlugin,\

365

com.xpn.xwiki.plugin.scheduler.SchedulerPlugin,\

366

com.xpn.xwiki.plugin.mailsender.MailSenderPlugin,\

367

com.xpn.xwiki.plugin.watchlist.WatchListPlugin, \

368

com.xpn.xwiki.wysiwyg.server.plugin.WysiwygPlugin

369

370

# [Since 1.6RC1] Defines the list of supported syntaxes

371

# Available syntaxes are:

372

# xwiki/1.0, xwiki/2.0, confluence/1.0, jspwiki/1.0, creole/1.0,

373

# mediawiki/1.0, xhtml/1.0, twiki/1.0

374

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

375

376

# This parameter allows XWiki to operate in Hosting mode allowing to create

377

# multiple wikis having their own database and responding to different URLs

378

xwiki.virtual=0

379

380

xwiki.virtual.redirect=http://127.0.0.1:9080/xwiki/bin/Main/ThisWikiDoesNotExist

381

382

# This parameter will activate the eXo Platform integration

383

xwiki.exo=0

384

385

xwiki.authentication=form

386

xwiki.authentication.validationKey=totototototototototototototototo

387

xwiki.authentication.encryptionKey=titititititititititititititititi

388

xwiki.authentication.cookiedomains=xwiki.com,wiki.fr

389

390

# This allows logout to happen for any page going through the /logout/ action, regardless of the document or the servlet.

391

# Comment-out if you want to enable logout only for /bin/logout/XWiki/XWikiLogout

392

xwiki.authentication.logoutpage=(/[^/]+/|/)logout/*

393

394

# Stats configuration allows to globally activate/deactivate stats module (launch storage thread, register events...)

395

xwiki.stats=1

396

# When statistics are globally enabled, storage can be enabled/disabled by wiki using the XWikiPreference property "statistics".

397

# Note: Statistics are disabled by default for improved performances/space.

398

xwiki.stats.default=0

399

# It is also possible to choose a different stats service to record statistics separately from XWiki.

400

xwiki.stats.class=com.xpn.xwiki.stats.impl.XWikiStatsServiceImpl

401

402

xwiki.encoding=ISO-8859-1

xwiki.backlinks=1

xwiki.tags=1

# Use edit comments

xwiki.editcomment=1

# Hide editcomment field and only use Javascript

412

xwiki.editcomment.hidden=0

413

414

# Make edit comment mandatory

415

xwiki.editcomment.mandatory=0

416

417

# Make edit comment suggested (asks 1 time if the comment is empty.

418

# 1 shows one popup if comment is empty.

419

# 0 means there is no popup.

420

# This setting is ignored if mandatory is set

421

xwiki.editcomment.suggested=0

422

423

# GraphViz plugin configuration. The GraphViz plugin is not configured by default.

424

# To enable it, add "com.xpn.xwiki.plugin.graphviz.GraphVizPlugin" to the list of plugins

425

# in the xwiki.plugins property.

426

# Uncomment and set the locations of the Dot and Neato executables

427

#xwiki.plugin.graphviz.dotpath=c:/Program Files/ATT/GraphViz/bin/dot.exe

428

#xwiki.plugin.graphviz.neatopath=c:/Program Files/ATT/GraphViz/bin/neato.exe

429

430

xwiki.plugin.laszlo.baseurl=/openlaszlo/xwiki/

431

xwiki.plugin.laszlo.path=c:/Program Files/Apache Software Foundation/Tomcat 5.0/webapps/openlaszlo/xwiki/

432

433

xwiki.plugin.image.cache.capacity=30

434

435

xwiki.plugin.captcha=0

436

437

438

# Enable to allow superadmin. It is disabled by default as this could be a security breach if

439

# it were set and you forgot about it.

440

#xwiki.superadminpassword=system

441

442

#-------------------------------------------------------------------------------------

443

# LDAP

444

#-------------------------------------------------------------------------------------

445

446

#-# new LDAP authentication service

447

# xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl

448

449

#-# Turn LDAP authentication on - otherwise only XWiki authentication

450

#-# 0: disable

451

#-# 1: enable

452

# xwiki.authentication.ldap=1

453

454

#-# LDAP Server (Active Directory, eDirectory, OpenLDAP, etc.)

455

xwiki.authentication.ldap.server=127.0.0.1

456

xwiki.authentication.ldap.port=389

457

458

#-# LDAP login, empty = anonymous access, otherwise specify full dn

459

#-# {0} is replaced with the username, {1} with the password

460

xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP

461

xwiki.authentication.ldap.bind_pass={1}

462

463

#-# Force to check password after LDAP connection

464

#-# 0: disable

465

#-# 1: enable

466

xwiki.authentication.ldap.validate_password=0

467

468

#-# only members of the following group will be verified in the LDAP

469

#-# otherwise only users that are found after searching starting from the base_DN

470

# xwiki.authentication.ldap.user_group=cn=developers,ou=groups,o=MegaNova,c=US

471

472

#-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl]

473

#-# only users not member of the following group can autheticate

474

# xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US

475

476

#-# base DN for searches

477

xwiki.authentication.ldap.base_DN=

478

479

#-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name (default=cn)

480

# xwiki.authentication.ldap.UID_attr=cn

481

482

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

483

#-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password" is set to 1

484

# xwiki.authentication.ldap.password_field=userPassword

485

486

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

487

#-# The potential LDAP groups classes. Separated by commas.

488

# xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList

489

490

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

491

#-# The potential names of the LDAP groups fields containings the members. Separated by commas.

492

# xwiki.authentication.ldap.group_memberfields=member,uniqueMember

493

494

#-# retrieve the following fields from LDAP and store them in the XWiki user object (xwiki-attribute=ldap-attribute)

495

#-# ldap_dn=dn -- dn is set by class, caches dn in XWiki.user object for faster access

496

xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,fullname=fullName,email=mail,ldap_dn=dn

497

498

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

499

#-# on every login update the mapped attributes from LDAP to XWiki otherwise this happens only once when the XWiki account is created.

500

xwiki.authentication.ldap.update_user=1

501

502

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

503

#-# mapps XWiki groups to LDAP groups, separator is "|"

504

# xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=AdminRole,ou=groups,o=MegaNova,c=US|\

505

# XWiki.Organisation=cn=testers,ou=groups,o=MegaNova,c=US

506

507

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

508

#-# time in s after which the list of members in a group is refreshed from LDAP (default=3600*6)

509

# xwiki.authentication.ldap.groupcache_expiration=21800

510

511

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

512

#-# - create : synchronize group membership only when the user is first created

513

#-# - always: synchronize on every login

514

# xwiki.authentication.ldap.mode_group_sync=always

515

516

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

517

#-# if ldap authentication fails for any reason, try XWiki DB authentication with the same credentials

518

xwiki.authentication.ldap.trylocal=1

519

520

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

521

#-# SSL connection to LDAP server

522

#-# 0: normal

523

#-# 1: SSL

524

# xwiki.authentication.ldap.ssl=0

525

526

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

527

#-# The keystore file to use in SSL connection

528

# xwiki.authentication.ldap.ssl.keystore=

529

530

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

531

#-# The java secure provider used in SSL connection

532

# xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider

533

534

#-------------------------------------------------------------------------------------

535

# Cache

536

#-------------------------------------------------------------------------------------

537

538

#-# [Since 1.5M2]

539

#-# The cache component implementation to use as "normal" (can be local or distributed depending on the implementation)

540

#-# cache component.

541

# xwiki.cache.cachefactory.hint=jbosscache

542

543

#-# [Since 1.5M2]

544

#-# The cache component to use as local cache component.

545

# xwiki.cache.cachefactory.local.hint=jbosscache/local

546

547

#-------------------------------------------------------------------------------------

548

549

550

xwiki.authentication.unauthorized_code=200

551

552

# This parameter will activate the sectional editing

553

xwiki.section.edit=1

554

555

# Uncomment if you want to ignore requests for unmapped actions, and simply display the document

556

# xwiki.unknownActionResponse=view

557

558

559

# You can configure the toolbars you wish to see in the WYSIWYG editor by defining the

560

# xwiki.wysiwyg.toolbars property.

561

# When not defined it defaults to:

562

# xwiki.wysiwyg.toolbars=texttoolbar, listtoolbar, indenttoolbar, undotoolbar, titletoolbar, \

563

# styletoolbar, horizontaltoolbar, attachmenttoolbar, macrostoolbar, \

564

# tabletoolbar, tablerowtoolbar, tablecoltoolbar, linktoolbar

565

# The full list of toolbars includes the one defined above and the following ones:

566

# subtoolbar, findtoolbar, symboltoolbar

567

568

569

xwiki.defaultskin=toucan

570

xwiki.defaultbaseskin=albatross

571

572

# Calendar Prev/Next Month bounds.

573

# The calendar generates links to the previous/next months for a limited range, by default 6 months back and 12 months after.

574

# A value of 0 means that there is no limit in that direction.

575

# xwiki.calendar.bound.prev=6

576

# xwiki.calendar.bound.next=12

577

578

# xwiki.temp.dir=/tmp/xwiki

579

# xwiki.work.dir=/usr/local/xwiki

580

581

# xwiki.plugins.lucene.indexdir=/usr/local/xwiki/lucene

582

# xwiki.plugins.lucene.analyzer=org.apache.lucene.analysis.standard.StandardAnalyzer

583

# xwiki.plugins.lucene.indexinterval=20

584

585

#-# [Since 1.6M1]

586

#-# Force the database name for the main wiki in virtual mode and for the wiki itself in non virtual mode

# xwiki.db=xwiki

#-# [Since 1.6M1]

#-# Add a prefix to all databases names of the wikis in virtual mode and to the wiki name in non virtual mode

# xwiki.db.prefix=

xwiki.work.dir=work

{code}

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