Configuration (XWiki.org)

One you have XWiki [[installed>>Installation]] you'll want to configure it. Configuration can be done in 2 ways:

* by stopping the XWiki instance and editing the ##xwiki/WEB-INF/xwiki.cfg## file, and then restarting XWiki

* 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 ##[[http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences]]##). This allows to keep the Server running while making the changes.

5

6

Note that some configurations are only accessible from the ##xwiki.cfg## file and have no equivalent on the Administration page.

7

8

You can verify some basic settings of your XWiki install (on Tomcat, MySQL) using the [[check Config and Indexes application>>code:Applications.CheckConfigAndIndexesApplication]].

9

10

There are various things you can configure:

= Enable superadmin account

15

16

Edit the ##xwiki.cfg## file and enable the ##xwiki.superadminpassword## property. For example:

17

18

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

23

24

When logging in, the username will be "superadmin" and the password will be the one you set in the ##xwiki.superadminpassword## property.

= Language settings

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

Last, you can also force your wiki to display only in one of the languages specified in the settings, by editing your ##WEB-INF/xwiki.cfg## file. Search for the "Internationalization" section, and you should see two commented settings that you can uncomment and set to 1:

33

34

35

#-# By default, XWiki chooses the language specified by the client (browser) in the Accept-Language HTTP header. This

36

#-# allows to use the default language of the wiki when the user didn't manually choose a language.

37

# xwiki.language.preferDefault=0

38

39

#-# Force only one of the supported languages to be accepted.

40

# xwiki.language.forceSupported=0

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

46

47

|=Format|=Result

48

|MMMM dd, HH:mm|January 27, 12:27

49

|yyyy/MM/dd, HH:mm|2009/01/27, 12:27

50

|dd/MM/yyyy, HH:mm|27/01/2009, 12:27

51

52

[[More information about date formatting>>http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html]].

53

54

55

= Wiki Access Configuration

56

57

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:

58

59

* [[Open Wiki>>#HOpenWiki]]: anyone can edit pages (including non registered users)

60

* [[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]]).

61

* [[Private Wiki with password>>#HPrivateWikiwithpassword]]: registration is closed

62

* [[Private Wiki with token for registering>>#HPrivateWikiwithtoken]]: registration is closed but users knowing the token can register

== Open Wiki

TODO

== Public Wiki

Nothing to do. This is the default Way. If you want that only people with a verified Email Address can edit pages, you have to set "Use email verification" AND "Check Active fields for user authentication" to "Yes" in Administration/Registration.

70

71

== Private Wiki with password

72

=== Global rights

73

74

In [[Global rights>>http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences?editor=globalrights&global=1]] set **User:XWikiGuest, Groups:, Level:register, Allow-Deny:Allow**.

=== Registration

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

79

80

== Private Wiki with token

TODO

* **[[Find out more about XWiki access rights here>>Access Rights]]**

85

86

= Enabling/Disabling Statistics

87

88

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

89

90

xwiki.stats=0

91

xwiki.stats.default=0

where:

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

97

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

98

99

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

100

101

= Optional Store Features

102

103

== Document versioning

104

105

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.

106

107

To disable the versioning store, edit //xwiki.cfg// and add:

108

109

xwiki.store.versioning=0

110

111

112

== Attachment versioning

113

114

XWiki stores all document attachment versions by default. This is very memory consuming (both RAM and HDD). If you need only latest versions of attachments, you can disable attachment version control by editing your //xwiki.cfg// and adding:

115

116

xwiki.store.attachment.versioning=0

117

118

119

== Document recycle bin

120

121

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:

xwiki.recyclebin=0

Note that disabling it will make it impossible to restore a deleted document, unless a database backup is available.

128

129

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:

130

131

132

# Admins must wait 3 days before being allowed to permanently delete

133

xwiki.store.recyclebin.adminWaitDays=3

134

# Normal users must also wait 3 days

135

xwiki.store.recyclebin.waitDays=3

136

137

138

== Attachment recycle bin

139

140

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:

141

142

143

storage.attachment.recyclebin=0

144

145

146

= Customizing the Skin

147

148

See the [[Skin Guide>>AdminGuide.Skins]].

149

150

= Security configuration

151

152

See the [[Security Guide>>AdminGuide.Security]].

= Customizing Menus

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.

= Encoding

See the [[Encoding Guide>>AdminGuide.Encoding]].

161

162

= User Authentication

163

164

See the [[Authentication Guide>>AdminGuide.Authentication]].

165

166

= Customizing the registration page

167

168

The default registration page is defined as a template on the file system (named ##registerinline.vm##). However it's possible to easily override it by creating a page named ##XWiki.Registration##.

169

170

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

171

172

== Customizing the Verified Registration Page (Since 2.2M2)

173

174

The Verified Registration Page is part of the [[Administration Application>>code:Applications.AdministrationApplication]] and allows you to require users to fill in a captcha and validates user input on both the server side and the client side using Javascript. The configuration allows you to add fields and add validation constraints to the fields which are there.

175

176

To turn on captcha support you have to edit your [[xwiki.properties>>#HSamplexwikiproperties]] file. You will find this in xwiki/WEB-INF/xwiki.properties you need to add a line which says:

captcha.enabled=true

Then the registration page will require captchas.

183

184

For more information about configuring the registration page you can visit the page on the [[Administration Application>>code:Applications.AdministrationApplication]].

= Logging

See the [[Logging page>>Logging]].

189

190

= Configuring Interwiki links

191

192

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

193

194

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

195

196

To configure Interwiki links on your wiki:

197

198

* Create a file named ##[location from where you start your container]/conf/**intermap.txt**##

199

* Fill ##intermap.txt## with content like:

200

201

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

202

OpenWiki http://openwiki.com/?

203

SourceForge http://sourceforge.net/

204

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

205

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

206

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

207

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

208

209

210

You can of course add your own entries.

211

212

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

213

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

214

* If it does not work, check your ##xwiki.log## file. You'll see if ##conf/intermap.txt## could not be found, or if there was an error parsing it.

215

216

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

217

218

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

219

220

image:defaulteditor.png

221

222

= Configure the WYSIWYG editor

223

224

See [[WYSIWYG Editor Configuration>>WysiwygEditor]] page to find out how you can enable or disable editing features.

= Short URLs

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

229

230

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

231

232

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

233

234

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

235

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

236

237

238

= Turning off comments or attachments

239

240

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

241

242

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

243

* Add a new property called ##showcomments## (or ##showattachments## for turning off attachments) of type String Class

244

* Go to ##<server>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences## and write no in the ##showcomments## (or ##showattachments##) field

245

246

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

247

248

= Configure edit comment behavior

249

250

When page editing you can add a comment of changes in special comment field by default (Look at [[Features.PageEditing#HCommoneditactions]]). You can disable this feature by set //xwiki.editcomment=0// in //xwiki.cfg//.

251

252

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. If you want a popup, but want to be able to set empty edit comment, set //xwiki.editcomment.suggested=1// in //xwiki.cfg//

253

254

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.

255

256

You can use the special fields in //XWikiPreferences// object instead of edit //xwiki.cfg//. These fields are: //editcomment//, //editcomment_mandatory//, //editcomment_suggested// and //editcomment_hidden//.

257

258

= Configuring the SMTP server

259

260

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.

261

262

To configure these go to the Administration page (##[[http://<server>/xwiki/bin/admin/XWiki/XWikiPreferences]]##), click on the "general" icon and modify the ##Admin email## field to set the email under which XWiki emails will be sent and modify the ##Outgoing SMTP Server## field to set the SMTP server to use, as shown on the figure below.

263

264

image:emailconfiguration.png

265

266

== Configuring authentication for SMTP

267

268

{{warning}}These instructions are now obsolete{{/warning}}

269

270

By default, the username/password fields are not available in the preferences. In order to configure the SMTP authentication, you must:

271

272

* Edit the ##XWiki.XWikiPreferences## class (##/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class##) and add two ##String## fields, named ##smtp_server_username## and ##smtp_server_password##.

273

* Edit the ##XWiki.XWikiPreferences## object (##/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences&nb=0&property=smtp_server_username,smtp_server_password##) and enter the required username and password in the newly added fields.

274

275

== Configuring TLS for the connection to the server

276

277

{{warning}}These instructions are now obsolete{{/warning}}

278

279

In order to enable TLS, you must:

280

* Edit the ##XWiki.XWikiPreferences## class (##/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class##) and add a ##TextArea## field, named ##javamail_extra_props ##.

281

* Edit the ##XWiki.XWikiPreferences## object (##/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences&nb=0&property=javamail_extra_props##) and enter: ##mail.smtp.starttls.enable=true##

282

283

== Using Google SMTP server

284

285

|=property|=value

286

|server|smtp.gmail.com

287

|port|587

288

|user|vovan@gmail.com

289

|password|xakep

290

|JavaMail properties|mail.smtp.starttls.enable=true

291

292

= Configuring WebDAV (since 1.7)

293

294

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.

295

296

== Securing WebDAV Server

297

298

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.

== Disabling WebDAV

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:

<servlet-mapping>

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

307

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

</servlet-mapping>

= Redirections

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

316

317

xwiki.preferences.redirect=1

318

319

320

Then for each redirection you want to add, add a ##XWiki.GlobalRedirect## object to your main wiki's ##XWiki.XWikiPreferences## document. The ##XWiki.GlobalRedirect## object has 2 fields: ##pattern## and ##destination##. The URL received is matched on ##pattern## and if there's a match it's replaced with the value from ##destination##. XWiki then redirects to the new URL.

321

322

= Customizing the PDF export Look & Feel

323

324

{{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.{{/info}}

325

326

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

327

328

{image:XWikiExport200805192259.png}

329

330

As shown in the diagram you can customize 3 parts:

331

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

332

* The XHTML2FO XSL transformation

333

* The FOP XSL transformation

334

335

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: ##http:/yourserver.com/xwiki/bin/edit/XWiki/PDFClass?editor=class##). Add the following Text Area properties as needed (they are all optional so you only need to define the ones you need to use):

336

* ##style##: contains the CSS information that will be overriding the default ##pdf.css## values.

337

* ##xhtmlxsl##: contains the XHTML to FO XSL overriding the default one.

338

* ##fopxsl##: contains the FOP to PDF/RTF XSL overriding the default one.

339

340

Then create a new page (say ##XWiki.PDFTemplate##) and add the ##XWiki.PDFClass## object to it.

341

342

Last use that page when calling the PDF/RTF export using the ##pdftemplate## parameter as in ##[[http://yourserver/xwiki/bin/export/Space/Page?format=pdf&language=en&pdftemplate=XWiki.PDFTemplate]]##.

343

344

345

As mentioned the ##style## 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...

h2 {

margin-left: 2cm;

margin-bottom: 1cm;

color: red;

}

h3 {

margin: 3cm;

color: yellow;

}

And not...

h2 {

margin-left: 2cm;

margin-bottom: 1cm;

color: red;

}

h3 {

margin: 3cm;

color: yellow;

}

{{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.{{/info}}

373

374

375

= Configuring Wiki Syntaxes and default Syntax

376

377

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 **##WEB-INF/xwiki.cfg##** file and configure the ##xwiki.rendering.syntaxes## property. It's a comma-separated list of syntax ids. For example:

378

379

380

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

381

382

383

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 **##WEB-INF/xwiki.properties##** file and configure the ##core.defaultDocumentSyntax## property. For example to use XWiki Syntax 2.0 by default:

384

385

386

#-# Specifies the default syntax to use when creating new documents.

387

#-# Default value is xwiki/1.0.

388

core.defaultDocumentSyntax = xwiki/2.0

389

390

391

{{warning}}Hint: If it doesn't work check that you've edited the correct configuration file.{{/warning}}

= Sample xwiki.cfg

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

397

# Preamble

398

#

399

# This is the main old XWiki configuration file. Commented parameters show the default value, although some features

400

# might be disabled. To customize, uncomment and put your own value instead.

401

402

403

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

404

# General wiki settings

405

#

406

407

#-# When the wiki is readonly, any updates are forbidden. To mark readonly, use one of: yes, 1, true

408

# xwiki.readonly=no

409

410

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

411

#-# Available syntaxes are:

412

#-# xwiki/1.0, xwiki/2.0, confluence/1.0, jspwiki/1.0, creole/1.0, mediawiki/1.0, twiki/1.0, xhtml/1.0, html/4.01, plain/1.0

413

xwiki.rendering.syntaxes = xwiki/1.0, xwiki/2.0

414

415

#-# List of groups that a new user should be added to by default after registering. Comma-separated list of group document

416

#-# names.

417

# xwiki.users.initialGroups=XWiki.XWikiAllGroup

418

419

#-# Should all users be considered members of XWiki.XWikiAllGroup, even if they don't have an associated object in the

420

#-# group's document?

421

# xwiki.authentication.group.allgroupimplicit=0

422

423

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

424

# xwiki.unknownActionResponse=view

425

426

#-# The encoding to use when transformin strings to and from byte arrays. This causes the jvm encoding to be ignored,

427

#-# since we want to be independend of the underlying system.

428

xwiki.encoding=UTF-8

429

430

#-# This parameter will activate the sectional editing.

431

xwiki.section.edit=1

432

433

#-# This parameter controls the depth of sections that have section editing.

434

#-# By default level 1 and level 2 sections have section editing.

435

xwiki.section.depth=2

436

437

#-# Enable backlinks storage, which increases the update time, but allows to keep track of inter document links.

438

xwiki.backlinks=1

439

440

#-# Enable document tags.

xwiki.tags=1

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

# Storage

#

#-# Role hints that differentiate implementations of the various storage components. To add a new implementation for one

449

#-# of the storages, implement the appropriate interface and declare it in a components.xml file (using a role-hint other

450

#-# than 'default') and put its hint here.

451

#

452

#-# The main (documents) storage.

453

# xwiki.store.main.hint=default

454

#-# The attachment storage.

455

# xwiki.store.attachment.hint=default

456

#-# The document versioning storage.

457

# xwiki.store.versioning.hint=default

458

#-# The attachment versioning storage. Use 'void' to disable attachment versioning.

459

# xwiki.store.attachment.versioning.hint=default

460

#-# The document recycle bin storage.

461

# xwiki.store.recyclebin.hint=default

462

#-# The attachment recycle bin storage.

463

# xwiki.store.attachment.recyclebin.hint=default

464

465

#-# Whether the document recycle bin feature is activated or not

466

# xwiki.recyclebin=1

467

#-# Whether the attachment recycle bin feature is activated or not

468

# storage.attachment.recyclebin=1

469

#-# Whether the document versioning feature is activated or not

470

# xwiki.store.versioning=1

471

#-# Whether the attachment versioning feature is activated or not

472

# xwiki.store.attachment.versioning=1

473

#-# Whether the attachments should also be rolled back when a document is reverted.

474

# xwiki.store.rollbackattachmentwithdocuments=1

475

476

#-# The path to the hibernate configuration file.

477

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

478

479

#-# Whether to update the database schema on startup. Useful when upgrading XWiki. as the mapping could change between

480

#-# versions, and this allows to automatically update the database. Should be disabled (=0) during normal operation to

481

#-# improve the startup time.

482

# xwiki.store.hibernate.updateschema=1

483

484

#-# Allow or disable custom mapping for particular XClasses. Custom mapping may increase the performance of certain

485

#-# queries when large number of objects from particular classes are used in the wiki.

486

# xwiki.store.hibernate.custommapping=1

487

#-# Dynamic custom mapping.

488

# xwiki.store.hibernate.custommapping.dynamic=0

489

490

#-# Put a cache in front of the document store. This greatly improves performance at the cost of memory consumption.

491

#-# Disable only when memory is critical.

492

# xwiki.store.cache=1

493

494

#-# Maximum number of documents to keep in the cache.

495

# xwiki.store.cache.capacity=100

496

497

#-# [Since 1.6M1]

498

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

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

507

# Data migrations

508

#

509

# Similar to schema updates, this manipulates the actual data, and not just the layout of the database. Useful for

510

# migrating data to new formats, correct errors introduced in older versions, or even for schema updates that are not

511

# handled by velocity.

512

513

#-# Whether migrations are enabled or not. Should be enabled when upgrading, but for a better startup time it is better to

514

#-# disable them in production.

515

xwiki.store.migration=1

516

517

#-# Migration manager class. The default works with a Hibernate storage.

518

# xwiki.store.migration.manager.class=com.xpn.xwiki.store.migration.hibernate.XWikiHibernateMigrationManager

519

520

#-# Whether to exit after migration. Useful when a server should handle migrations for a large database, without going

521

#-# live afterwards.

522

# xwiki.store.migration.exitAfterEnd=0

523

524

#-# Indicate the list of databases to migrate.

525

#-# to upgrade all wikis database set xwiki.store.migration.databases=all

526

#-# to upgrade just some wikis databases set xwiki.store.migration.databases=xwiki,wiki1,wiki2

527

#-# Note: the main wiki is always migrated whatever the configuration.

528

# xwiki.store.migration.databases=

529

530

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

531

# Internationalization

532

#

533

534

#-# By default, XWiki chooses the language specified by the client (browser) in the Accept-Language HTTP header. This

535

#-# allows to use the default language of the wiki when the user didn't manually choose a language.

536

# xwiki.language.preferDefault=0

537

538

#-# Force only one of the supported languages to be accepted.

539

# xwiki.language.forceSupported=0

540

541

542

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

543

# Virtual wikis (farm)

544

#

545

546

#-# This parameter allows XWiki to operate in Hosting mode allowing to create multiple wikis having their own database and

547

#-# responding to different URLs

548

xwiki.virtual=0

549

550

#-# URL to redirect to when a requested wiki does not exist. This should be changed to a real page.

551

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

552

553

#-# Forbidden names that should not be allowed when creating a new wiki.

554

# xwiki.virtual.reserved_wikis=

555

556

#-# How virtual wikis are mapped to different URLs. If set to 0 (the default), then virtual wikis have different domain

557

#-# names, in the format http://wikiname.myfarm.net/. If set to 1, then the domain is common for the entire farm, but the

558

#-# path contains the wiki name, in the format http://myfarm.net/xwiki/wiki/wikiname/.

559

#-# Note that you can configure the "/wiki/" part with xwiki.virtual.usepath.servletpath property.

560

# xwiki.virtual.usepath=0

561

562

#-# Configure the servlet action identifier for url path based multiwiki. It has also to be modified in web.xml.

563

# xwiki.virtual.usepath.servletpath=wiki

564

565

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

# URLs

#

#-# The domain name to use when creating URLs to the default wiki. If set, the generated URLs will point to this server

570

#-# instead of the requested one. It should contain schema, domain and (optional) port, and the trailing /. For example:

571

#-# xwiki.home=http://www.xwiki.org/

572

#-# xwiki.home=http://wiki.mycompany.net:8080/

573

# xwiki.home=

574

575

#-# The name of the default URL factory that should be used.

576

# xwiki.urlfactory.serviceclass=com.xpn.xwiki.web.XWikiURLFactoryServiceImpl

577

578

#-# Force the protocol to use in the generated URLs. The right value is taken from the request URL, so setting this

579

#-# is not recommended in most cases.

580

#-# For example:

581

#-# xwiki.url.protocol=https

582

# xwiki.url.protocol=

583

#-# The name of the webapp to use in the generated URLs. The right value is taken from the request URL, so setting this

584

#-# is not recommended in most cases. If set, the value should contain a trailing /, but not a leading one. For example:

585

#-# xwiki.webapppath=xwiki/

586

# xwiki.webapppath=

587

#-# The default servlet mapping name to use in the generated URLs. The right value is taken from the request URL,

588

#-# preserving the requested servlet mapping, so setting this is not recommended in most cases. If set, the value should

589

#-# contain a trailing /, but not a leading one. For example:

590

#-# xwiki.servletpath=bin/

591

# xwiki.servletpath=

592

#-# The fallback servlet mapping name to use in the generated URLs. Unlike xwiki.servletpath, this is the value used when

593

#-# the correct setting could not be determined from the request URL. A good way to use this setting is to achieve short

594

#-# URLs, see http://platform.xwiki.org/xwiki/bin/Main/ShortURLs

595

# xwiki.defaultservletpath=bin/

596

597

#-# Whether the /view/ part of the URL should be included if the target action is 'view'.

598

# xwiki.showviewaction=1

599

#-# The name of the default space. This is displayed when the URL specifies a document, but not a space, or neither.

600

# xwiki.defaultweb=Main

601

#-# Hide the /Space/ part of the URL when the space is the default one. Warning: use 1 to hide, 0 to show.

602

# xwiki.usedefaultweb=0

603

#-# The name of the default page of a space. This is displayed when the URL specifies a space, but not a document, or neither.

604

# xwiki.defaultpage=WebHome

605

#-# Hide the /WebHome part of the URL when the document is the default one. Use 0 to hide, 1 to show.

606

# xwiki.usedefaultaction=0

607

608

609

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

# Users

#

xwiki.inactiveuser.allowedpages=

614

615

616

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

617

# Authentication and authorization

618

#

619

620

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

621

#-# security breach if it were set and you forgot about it. Should only be enabled

622

#-# for recovering the Wiki when the rights are completely messed.

623

# xwiki.superadminpassword=system

624

625

#-# Authentication type. You can use 'basic' to always use basic authentication.

626

# xwiki.authentication=form

627

628

#-# Indicate if the authentication has do be done for each request

629

#-# 0: the default value, authentication is done only once by session.

630

#-# 1: the authentication is done for each request.

631

# xwiki.authentication.always=0

632

633

#-# Cookie encryption keys. You SHOULD replace these values with any random string,

634

#-# as long as the length is the same.

635

xwiki.authentication.validationKey=totototototototototototototototo

636

xwiki.authentication.encryptionKey=titititititititititititititititi

637

638

#-# Comma separated list of domains for which authentication cookies are set. This

639

#-# concerns mostly wiki farms. The exact meaning is that when a user logs in, if

640

#-# the current domain name corresponding to the wiki ends with one of the entries

641

#-# in this parameter, then the cookie is set for the larger domain. Otherwise, it

642

#-# is set for the exact domain name of the wiki.

643

#-#

644

#-# For example, suppose the cookiedomains is set to "mydomain.net". If I log in

645

#-# on wiki1.xwiki.com, then the cookie will be set for the entire mydomain.net

646

#-# domain, and if I visit wiki2.xwiki.com I will still be authenticated. If I log

647

#-# in on wiki1.otherdomain.net, then I will only be authenticated on

648

#-# wiki1.otherdomain.net, and not on wiki2.otherdomain.net.

649

#-#

650

#-# So you need this parameter set only for global authentication in a

651

#-# farm, there's no need to specify your domain name otherwise.

652

#-#

653

#-# Example: xwiki.authentication.cookiedomains=xwiki.org,myxwiki.org

654

xwiki.authentication.cookiedomains=

655

656

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

657

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

658

#-# Currently accepted patterns:

659

#-# - /StrutsServletName/logout/ (this is usually /bin/logout/ and is the default setup)

660

#-# - /logout/ (this works with the short URLs configuration)

661

#-# - /wiki/SomeWikiName/logout/ (this works with path-based virtual wikis)

662

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

663

664

#-# The group management class.

665

# xwiki.authentication.groupclass=com.xpn.xwiki.user.impl.xwiki.XWikiGroupServiceImpl

666

#-# Default value for exo:

667

# xwiki.authentication.groupclass=com.xpn.xwiki.user.impl.exo.ExoGroupServiceImpl

668

669

#-# The authentication management class.

670

# xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.XWikiAuthServiceImpl

671

#-# Default value for exo:

672

# xwiki.authentication.authclass=com.xpn.xwiki.user.impl.exo.ExoAuthServiceImpl

673

#-# Default value for LDAP:

674

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

675

676

#-# The authorization management class.

677

# xwiki.authentication.rightsclass=com.xpn.xwiki.user.impl.xwiki.XWikiRightServiceImpl

678

679

#-# If an unauthenticated user (guest) tries to perform a restricted action, by default the wiki redirects to the login

680

#-# page. Enable this to simply display an "unauthorized" message instead, to hide the login form.

681

# xwiki.hidelogin=false

682

683

#-# HTTP status code to sent when the authentication failed.

684

xwiki.authentication.unauthorized_code=200

685

686

687

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

# Rendering

#

#-# Disable particular renderers (in the old rendering engine).

692

#-# Macro mapping

693

# xwiki.render.macromapping=1

694

#-# Velocity interpreter

695

# xwiki.render.velocity=1

696

#-# Groovy interpreter

697

# xwiki.render.groovy=1

698

#-# Plugin rendering

699

# xwiki.render.plugin=1

700

#-# Radeox wiki renderer

701

# xwiki.render.wiki=1

702

#-# Simple wiki syntax rendering

703

# xwiki.render.wikiwiki=0

704

705

#-# Maximum number of documents to keep in the rendered cache

706

# xwiki.render.cache.capacity=100

707

708

#-# Default target for external links. Use _blank to open external links in a new tab/window.

709

# xwiki.render.externallinks.defaulttarget=

710

711

712

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

# Editing

#

#-# Minor edits don't participate in notifications.

717

# xwiki.minoredit=1

718

719

#-# Use edit comments

720

xwiki.editcomment=1

721

722

#-# Hide editcomment field and only use Javascript

723

# xwiki.editcomment.hidden=0

724

725

#-# Make edit comment mandatory

726

xwiki.editcomment.mandatory=0

727

728

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

729

#-# 1 shows one popup if comment is empty.

730

#-# 0 means there is no popup.

731

#-# This setting is ignored if mandatory is set

732

# xwiki.editcomment.suggested=0

733

734

735

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

736

# LDAP

737

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

738

739

#-# new LDAP authentication service

740

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

741

742

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

743

#-# 0: disable

744

#-# 1: enable

745

# xwiki.authentication.ldap=1

746

747

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

748

xwiki.authentication.ldap.server=127.0.0.1

749

xwiki.authentication.ldap.port=389

750

751

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

752

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

753

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

754

xwiki.authentication.ldap.bind_pass={1}

755

756

#-# Force to check password after LDAP connection

757

#-# 0: disable

758

#-# 1: enable

759

xwiki.authentication.ldap.validate_password=0

760

761

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

762

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

763

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

764

765

#-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl]

766

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

767

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

768

769

#-# base DN for searches

770

xwiki.authentication.ldap.base_DN=

771

772

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

773

# xwiki.authentication.ldap.UID_attr=cn

774

775

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

776

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

777

# xwiki.authentication.ldap.password_field=userPassword

778

779

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

780

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

781

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

782

783

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

784

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

785

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

786

787

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

788

xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,email=mail

789

790

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

791

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

792

xwiki.authentication.ldap.update_user=1

793

794

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

795

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

796

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

797

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

798

799

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

800

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

801

# xwiki.authentication.ldap.groupcache_expiration=21800

802

803

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

804

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

805

#-# - always: synchronize on every login

806

# xwiki.authentication.ldap.mode_group_sync=always

807

808

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

809

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

810

xwiki.authentication.ldap.trylocal=1

811

812

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

813

#-# SSL connection to LDAP server

814

#-# 0: normal

815

#-# 1: SSL

816

# xwiki.authentication.ldap.ssl=0

817

818

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

819

#-# The keystore file to use in SSL connection

820

# xwiki.authentication.ldap.ssl.keystore=

821

822

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

823

#-# The java secure provider used in SSL connection

824

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

825

826

827

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

828

# Cache

829

# [DEPRECATED since 1.7M1: this way to configure cache provider is deprecated, you should use xwiki.properties instead.]

830

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

831

832

#-# [Since 1.5M2]

833

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

834

#-# cache component.

835

# xwiki.cache.cachefactory.hint=jbosscache

836

837

#-# [Since 1.5M2]

838

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

839

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

840

841

842

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

843

# WYSIWYG Editor configuration

844

#

845

846

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

847

#-# xwiki.wysiwyg.toolbars property.

848

#-# When not defined it defaults to:

849

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

850

# styletoolbar, horizontaltoolbar, attachmenttoolbar, macrostoolbar, \

851

# tabletoolbar, tablerowtoolbar, tablecoltoolbar, linktoolbar

852

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

853

#-# subtoolbar, findtoolbar, symboltoolbar

854

855

856

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

857

# Skins & Templates configuration

858

#

859

860

#-# The default skin to use when there's no value specified in the wiki preferences document. Note that the default

861

#-# wiki already specifies a skin, so this setting is only valid for empty wikis.

862

xwiki.defaultskin=colibri

863

864

#-# The default base for skins that don't specify a base skin. This is also the last place where a skin file is searched

865

#-# if not found in the more specific skins.

866

xwiki.defaultbaseskin=albatross

867

868

#-# Defines whether title handling should be using the compatibility mode or not. When the compatibility

869

#-# mode is active, if the document's content first header (level 1 or level 2) matches the document's title

870

#-# the first header is stripped.

871

xwiki.title.compatibility=1

872

873

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

# Extensions

#

#-# List of active plugins.

878

xwiki.plugins=\

879

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

880

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

881

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

882

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

883

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

884

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

885

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

886

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

887

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

888

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

889

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

890

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

891

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

892

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

893

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

894

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

895

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

896

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

897

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

898

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

899

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

900

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

901

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

902

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

903

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

904

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

905

com.xpn.xwiki.plugin.activitystream.plugin.ActivityStreamPlugin, \

906

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

907

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

908

com.xpn.xwiki.plugin.tag.TagPlugin

909

910

#-# Enable light monitoring of the wiki performance. Records various statistics, like number of requests processed,

911

#-# time spent in rendering or in the database, medium time for a request, etc. Disable for a minor increase of

912

#-# performance and a bit of memory.

913

# xwiki.monitor=1

914

915

#-# Maximum number of last requests to remember.

916

# xwiki.monitor.lastlistsize=20

917

918

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

919

#-# Enabled by default.

920

# xwiki.stats=1

921

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

922

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

923

xwiki.stats.default=0

924

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

925

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

926

927

#-# This parameter will activate the eXo Platform integration

928

xwiki.exo=0

929

930

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

931

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

932

#-# in the xwiki.plugins property.

933

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

934

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

935

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

936

937

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

938

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

939

940

xwiki.plugin.image.cache.capacity=30

941

942

#-# Calendar Prev/Next Month bounds.

943

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

944

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

945

# xwiki.calendar.bound.prev=6

946

# xwiki.calendar.bound.next=12

947

948

#-# Lucene search engine

949

#-# Location where to place the lucene index files. The default is the "lucene" subdirectory in the container's "work"

950

#-# diectory. Change it if you want to store indexes in another place.

951

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

952

#-# The text analyzer to use for indexing.

953

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

954

#-# The number of seconds to wait between reindexes. A smaller value ensures that new documents will be indexed faster,

955

#-# but with a minor performance reduction. Adjust according to your wiki load.

956

# xwiki.plugins.lucene.indexinterval=20

957

#-# The maximum size of the indexing queue. After this limit is reached, the reindex thread will have to wait until the

958

#-# queue is consumed. Note that this does not affect documents submitted through the notification mechanism, only the

959

#-# full reindex option.

960

# xwiki.plugins.lucene.maxQueueSize=1000

961

962

#-# [Since 2.0RC1]

963

#-# Activity Stream plugin.

964

#-# The Activity Stream plugin stores data in a dedicated table in the database. In virtual mode each wiki has it's own

965

#-# database, the plugin can be configured to store its data into the database corresponding to the wiki, into the main

966

#-# database (default: xwiki) or both. If the wiki is not running in virtual mode these options will not have any

967

#-# effect. These options should not be both set to 0 (in this case the local store will be forced).

968

#-# Important note: disabling storage in the main store will prevent the watchlist from retrieving events from subwikis.

969

#-#

970

#-# Default: 1

971

# xwiki.plugin.activitystream.uselocalstore=1

972

#-#

973

#-# Default: 1

974

# xwiki.plugin.activitystream.usemainstore=1

975

#-#

976

#-# Number of days the events should be kept (0 or any negative value: infinite duration)

977

#-# Note: if this value is greater than 0 a scheduler job will be created, this job will then be fired every week to

978

#-# delete events older than the configured value.

979

#-# Default: 0

980

# xwiki.plugin.activitystream.daystokeepevents=0

981

982

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

# Misc

#

#-# Temporary directory where XWiki can put files (during exort and upload, for example).

987

# xwiki.temp.dir=/tmp/xwiki

988

#-# XWiki work directory

989

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

xwiki.work.dir=work

= Sample xwiki.properties

995

996

997

# This is the new XWiki configuration file. In the future it'll replace the old

998

# xwiki.cfg file. However right now it's only used by some XWiki components.

999

# As time progresses more and more component will get their configurations from

1000

# this file.

1001

1002

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

1003

# Core

1004

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

1005

1006

#-# [Since 1.8RC2]

1007

#-# Specifies the default syntax to use when creating new documents.

1008

#-# Default value is xwiki/2.0.

1009

# core.defaultDocumentSyntax = xwiki/1.0

1010

1011

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

1012

# Rendering

1013

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

1014

1015

#-# [Since 1.8RC2]

1016

#-# Specifies how links labels are displayed when the user doesn't specify the label explicitely.

#-# Valid values:

#-# %w: wiki name

#-# %s: space name

#-# %p: page name

#-# %P: page name with spaces between camel case words, i.e. "My Page" iff the page name is "MyPage"

1022

#-# %t: page title

1023

#-#

1024

#-# Note that if the page title is empty or not defined then it defaults to %p. This is also the case

1025

#-# if the title cannot be retrieved for the document.

1026

#-#

1027

#-# The default is "%p". Some examples: "%s.%p", "%w:%s.%p".

1028

# rendering.linkLabelFormat = %p

1029

1030

#-# [Since 2.0M3]

1031

#-# Overrides default macro categories (Each macro has a default category already defined, for example

1032

#-# "presentation" for the Table of Contents Macro).

1033

#-#

1034

#-# Ex: To redefine the macro category for the TOC macro so that it'd be in the "My Category" category +

1035

#-# redefine the category for the Script Macro to be "My Other Category", you'd use:

1036

# rendering.macroCategories = toc:My Category

1037

# rendering.macroCategories = script:My Other Category

1038

1039

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

1040

# Cache

1041

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

1042

1043

#-# [Since 1.7M1]

1044

#-# The standard cache component implementation to use (can be local or distributed depending on the implementation).

1045

#-# The default standard cache implementation is JBoss Cache.

1046

# cache.defaultCache=jbosscache

1047

1048

#-# [Since 1.7M1]

1049

#-# The local cache implementation to use.

1050

#-# The default local cache implementation is JBoss Cache.

1051

# cache.defaultLocalCache=jbosscache/local

1052

1053

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

1054

# Settings for the OpenOffice server instance consumed by the OfficeImporter plugin

1055

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

1056

1057

#-# [Since 1.9M2]

1058

#-# Type of the openoffice server instance used by officeimporter plugin.

1059

#-# 0 - Internally managed server instance. (Default)

1060

#-# 1 - Externally managed (local) server instance.

1061

# openoffice.serverType=0

1062

1063

#-# [Since 1.9M2]

1064

#-# Port number used for connecting to the openoffice server instance.

1065

#-# Default port is 8100

1066

# openoffice.serverPort=8100

1067

1068

#-# [Since 1.9M2]

1069

#-# If the openoffice server should be started / connected upon XE start.

1070

#-# Default value is false

1071

# openoffice.autoStart=false

1072

1073

#-# [Since 1.8RC3]

1074

#-# Path to openoffice installation (serverType:0 only).

1075

#-# If no path is provided, a default value will be calculated based on the operating environment.

1076

# openoffice.homePath=/opt/openoffice.org3/

1077

1078

#-# [Since 1.8RC3]

1079

#-# Path to openoffice execution profile (serverType:0 only).

1080

#-# If no path is provided, a default value will be calculated based on the operating environment.

1081

# openoffice.profilePath=/home/user/.openoffice.org/3

1082

1083

#-# [Since 1.8RC3]

1084

#-# Maximum number of simultaneous conversion tasks to be handled by a single openoffice process (serverType:0 only).

1085

#-# Default value is 50

1086

# openoffice.maxTasksPerProcess=50

1087

1088

#-# [Since 1.8RC3]

1089

#-# Timeout for conversion tasks (in miliseconds) (serverType:0 only).

1090

#-# Default value is 30 seconds

1091

# openoffice.taskExecutionTimeout=30000

1092

1093

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

1094

# Velocity

1095

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

1096

1097

#-# [Since 2.0M1]

1098

#-# Velocity Tools that will be available from your scripts. The format is

1099

#-# velocity.tools.<name under which it'll be available in the context> = <class name>

1100

#-# Default values (no need to add them)

1101

#-# velocity.tools = listtool = org.apache.velocity.tools.generic.ListTool

1102

#-# velocity.tools = numbertool = org.apache.velocity.tools.generic.NumberTool

1103

#-# velocity.tools = datetool = org.apache.velocity.tools.generic.DateTool

1104

#-# velocity.tools = mathtool = org.apache.velocity.tools.generic.MathTool

1105

#-# velocity.tools = sorttool = org.apache.velocity.tools.generic.SortTool

1106

#-# velocity.tools = escapetool = org.apache.velocity.tools.generic.EscapeTool

1107

#-# velocity.tools = regextool = org.xwiki.velocity.tools.RegexTool

1108

1109

#-# [Since 2.0M1]

1110

#-# Velocity configuration properties. The format is

1111

#-# velocity.property.<Velocity property name> = <value>

1112

#-# Default values (no need to add them)

1113

#-# velocity.properties = resource.loader = webapp

1114

#-# velocity.properties = directive.set.null.allowed = true

1115

#-# velocity.properties = webapp.resource.loader.class = org.apache.velocity.tools.view.servlet.WebappLoader

1116

#-# velocity.properties = velocimacro.messages.on = false

1117

#-# velocity.properties = resource.manager.logwhenfound = false

1118

#-# velocity.properties = velocimacro.permissions.allow.inline.local.scope = true

1119

#-# velocity.properties = runtime.introspector.uberspect = org.xwiki.velocity.introspection.ChainingUberspector

1120

#-# velocity.properties = runtime.introspector.uberspect.chainClasses = org.apache.velocity.util.introspection.SecureUberspector,org.xwiki.velocity.introspection.DeprecatedCheckUberspector

1121

1122

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

1123

# Events distribution

1124

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

1125

1126

#-# [Since 2.0M3]

1127

#-# Indicate if the network distribution module is enabled or not.

1128

#-# By default remote events are disabled.

1129

# observation.remote.enabled = false

1130

1131

#-# [Since 2.0M3]

1132

#-# The list of events communication channels to start when the application starts.

1133

#-# By default no channel is configured.

1134

#-#

1135

#-# The default remote event distribution implementation is using JGroups and you'll need to drop your JGroups channel

1136

#-# xml files in the WEB-INF/observation/remote/jgroups/ directory. There's a README file in that directory with more

1137

#-# information.

1138

#-# Example: observation.remote.channels = public, cluster

1139

1140

#-# [Since 2.0M4]

1141

#-# The implementation of network adapter to use.

1142

#-# The default is jgroups.

1143

#-#

1144

#-# By default obnly jgroups is provided. To add one implements NetworkAdaptor componenet interface. The identifier provided in the configuration is matched with the component role hint.

1145

#-# Example: observation.remote.networkadapter = jgroups

1146

1147

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

1148

# Administration

1149

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

1150

1151

#-# [Since 2.2M2]