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.

25

26

= 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

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

= Wiki Access Configuration =

55

56

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:

57

58

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

59

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

60

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

61

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

73

=== Global rights ===

74

75

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.

80

81

== Private Wiki with token ==

TODO

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

86

87

= Enabling/Disabling Statistics =

88

89

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

90

91

xwiki.stats=0

92

xwiki.stats.default=0

where:

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

98

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

99

100

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

101

102

= Optional Store Features =

103

104

== Document versioning ==

105

106

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.

107

108

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

109

110

xwiki.store.versioning=0

111

112

113

== Attachment versioning ==

114

115

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:

116

117

xwiki.store.attachment.versioning=0

118

119

120

== Document recycle bin ==

121

122

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.

129

130

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:

131

132

133

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

134

xwiki.store.recyclebin.adminWaitDays=3

135

# Normal users must also wait 3 days

136

xwiki.store.recyclebin.waitDays=3

137

138

139

== Attachment recycle bin ==

140

141

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:

142

143

144

storage.attachment.recyclebin=0

145

146

147

= Customizing the Skin =

148

149

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

150

151

= Security configuration =

152

153

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

154

155

= Customizing Menus =

156

157

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

162

163

= User Authentication =

164

165

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

166

167

= Customizing the registration page (2.1 and older) =

168

169

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

170

171

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

172

173

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

174

175

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.

176

177

(Since 2.3M1)

178

To turn on captcha you simply go to the administration page, click Registration and you will find a checkbox for turning on captcha along with other registation page related settings.

179

180

To turn on captcha support in version 2.2 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.

187

188

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

193

194

= Configuring Interwiki links =

195

196

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

197

198

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

199

200

To configure Interwiki links on your wiki:

201

202

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

203

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

204

205

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

206

OpenWiki http://openwiki.com/?

207

SourceForge http://sourceforge.net/

208

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

209

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

210

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

211

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

212

213

214

You can of course add your own entries.

215

216

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

217

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

218

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

219

220

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

221

222

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

223

224

image:defaulteditor.png

225

226

= Configure the WYSIWYG editor =

227

228

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

233

234

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

235

236

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

237

238

* xwiki.db ~-~- name of database scheme of main wiki (including the name of the wiki in a non-virtual environment, otherwise the database name comes from hibernate configuration file).

239

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

240

241

= Turning off comments or attachments =

242

243

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

244

245

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

246

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

247

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

248

249

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

250

251

= Configure edit comment behavior =

252

253

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

254

255

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

256

257

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.

258

259

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

260

261

= Configuring the SMTP server =

262

263

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.

264

265

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.

266

267

image:emailconfiguration.png

268

269

== Configuring authentication for SMTP ==

270

271

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

272

273

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

274

275

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

276

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

277

278

== Configuring TLS for the connection to the server ==

279

280

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

281

282

In order to enable TLS, you must:

283

284

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

285

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

286

287

== Using Google SMTP server ==

288

289

|=property|=value

290

|server|smtp.gmail.com

291

|port|587

292

|user|vovan@gmail.com

293

|password|xakep

294

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

295

296

= Configuring WebDAV (since 1.7) =

297

298

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.

299

300

== Securing WebDAV Server ==

301

302

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.

303

304

== Disabling WebDAV ==

305

306

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>

311

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

320

321

xwiki.preferences.redirect=1

322

323

324

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.

325

326

= Customizing the PDF export Look & Feel =

327

328

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

329

330

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

331

332

{image:XWikiExport200805192259.png}

333

334

As shown in the diagram you can customize 3 parts:

335

336

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

337

* The XHTML2FO XSL transformation

338

* The FOP XSL transformation

339

340

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

341

342

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

343

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

344

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

345

346

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

347

348

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

349

350

351

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

379

380

= Configuring Wiki Syntaxes and default Syntax =

381

382

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:

383

384

385

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

386

387

388

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:

389

390

391

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

392

#-# Default value is xwiki/1.0.

393

core.defaultDocumentSyntax = xwiki/2.0

394

395

396

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

= Sample xwiki.cfg =

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

402

# Preamble

403

#

404

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

405

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

406

407

408

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

409

# General wiki settings

410

#

411

412

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

413

# xwiki.readonly=no

414

415

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

416

#-# Available syntaxes are:

417

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

418

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

419

420

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

421

#-# names.

422

# xwiki.users.initialGroups=XWiki.XWikiAllGroup

423

424

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

425

#-# group's document?

426

# xwiki.authentication.group.allgroupimplicit=0

427

428

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

429

# xwiki.unknownActionResponse=view

430

431

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

432

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

433

xwiki.encoding=UTF-8

434

435

#-# This parameter will activate the sectional editing.

436

xwiki.section.edit=1

437

438

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

439

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

440

xwiki.section.depth=2

441

442

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

443

xwiki.backlinks=1

444

445

#-# Enable document tags.

xwiki.tags=1

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

# Storage

#

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

454

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

455

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

456

#

457

#-# The main (documents) storage.

458

# xwiki.store.main.hint=default

459

#-# The attachment storage.

460

# xwiki.store.attachment.hint=default

461

#-# The document versioning storage.

462

# xwiki.store.versioning.hint=default

463

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

464

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

465

#-# The document recycle bin storage.

466

# xwiki.store.recyclebin.hint=default

467

#-# The attachment recycle bin storage.

468

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

469

470

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

471

# xwiki.recyclebin=1

472

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

473

# storage.attachment.recyclebin=1

474

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

475

# xwiki.store.versioning=1

476

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

477

# xwiki.store.attachment.versioning=1

478

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

479

# xwiki.store.rollbackattachmentwithdocuments=1

480

481

#-# The path to the hibernate configuration file.

482

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

483

484

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

485

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

486

#-# improve the startup time.

487

# xwiki.store.hibernate.updateschema=1

488

489

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

490

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

491

# xwiki.store.hibernate.custommapping=1

492

#-# Dynamic custom mapping.

493

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

494

495

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

496

#-# Disable only when memory is critical.

497

# xwiki.store.cache=1

498

499

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

500

# xwiki.store.cache.capacity=100

501

502

#-# [Since 1.6M1]

503

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

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

512

# Data migrations

513

#

514

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

515

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

516

# handled by velocity.

517

518

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

519

#-# disable them in production.

520

xwiki.store.migration=1

521

522

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

523

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

524

525

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

526

#-# live afterwards.

527

# xwiki.store.migration.exitAfterEnd=0

528

529

#-# Indicate the list of databases to migrate.

530

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

531

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

532

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

533

# xwiki.store.migration.databases=

534

535

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

536

# Internationalization

537

#

538

539

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

540

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

541

# xwiki.language.preferDefault=0

542

543

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

544

# xwiki.language.forceSupported=0

545

546

547

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

548

# Virtual wikis (farm)

549

#

550

551

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

552

#-# responding to different URLs

553

xwiki.virtual=0

554

555

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

556

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

557

558

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

559

# xwiki.virtual.reserved_wikis=

560

561

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

562

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

563

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

564

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

565

# xwiki.virtual.usepath=0

566

567

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

568

# xwiki.virtual.usepath.servletpath=wiki

569

570

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

# URLs

#

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

575

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

576

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

577

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

578

# xwiki.home=

579

580

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

581

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

582

583

#-# Force the protocol 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.

585

#-# For example:

586

#-# xwiki.url.protocol=https

587

# xwiki.url.protocol=

588

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

589

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

590

#-# xwiki.webapppath=xwiki/

591

# xwiki.webapppath=

592

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

593

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

594

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

595

#-# xwiki.servletpath=bin/

596

# xwiki.servletpath=

597

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

598

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

599

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

600

# xwiki.defaultservletpath=bin/

601

602

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

603

# xwiki.showviewaction=1

604

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

605

# xwiki.defaultweb=Main

606

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

607

# xwiki.usedefaultweb=0

608

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

609

# xwiki.defaultpage=WebHome

610

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

611

# xwiki.usedefaultaction=0

612

613

614

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

# Users

#

xwiki.inactiveuser.allowedpages=

619

620

621

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

622

# Authentication and authorization

623

#

624

625

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

626

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

627

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

628

# xwiki.superadminpassword=system

629

630

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

631

# xwiki.authentication=form

632

633

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

634

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

635

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

636

# xwiki.authentication.always=0

637

638

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

639

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

640

xwiki.authentication.validationKey=totototototototototototototototo

641

xwiki.authentication.encryptionKey=titititititititititititititititi

642

643

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

644

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

645

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

646

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

647

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

648

#-#

649

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

650

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

651

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

652

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

653

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

654

#-#

655

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

656

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

657

#-#

658

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

659

xwiki.authentication.cookiedomains=

660

661

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

662

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

663

#-# Currently accepted patterns:

664

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

665

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

666

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

667

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

668

669

#-# The group management class.

670

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

671

#-# Default value for exo:

672

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

673

674

#-# The authentication management class.

675

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

676

#-# Default value for exo:

677

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

678

#-# Default value for LDAP:

679

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

680

681

#-# The authorization management class.

682

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

683

684

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

685

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

686

# xwiki.hidelogin=false

687

688

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

689

xwiki.authentication.unauthorized_code=200

690

691

692

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

# Rendering

#

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

697

#-# Macro mapping

698

# xwiki.render.macromapping=1

699

#-# Velocity interpreter

700

# xwiki.render.velocity=1

701

#-# Groovy interpreter

702

# xwiki.render.groovy=1

703

#-# Plugin rendering

704

# xwiki.render.plugin=1

705

#-# Radeox wiki renderer

706

# xwiki.render.wiki=1

707

#-# Simple wiki syntax rendering

708

# xwiki.render.wikiwiki=0

709

710

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

711

# xwiki.render.cache.capacity=100

712

713

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

714

# xwiki.render.externallinks.defaulttarget=

715

716

717

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

# Editing

#

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

722

# xwiki.minoredit=1

723

724

#-# Use edit comments

725

xwiki.editcomment=1

726

727

#-# Hide editcomment field and only use Javascript

728

# xwiki.editcomment.hidden=0

729

730

#-# Make edit comment mandatory

731

xwiki.editcomment.mandatory=0

732

733

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

734

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

735

#-# 0 means there is no popup.

736

#-# This setting is ignored if mandatory is set

737

# xwiki.editcomment.suggested=0

738

739

740

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

741

# LDAP

742

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

743

744

#-# new LDAP authentication service

745

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

746

747

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

748

#-# 0: disable

749

#-# 1: enable

750

# xwiki.authentication.ldap=1

751

752

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

753

xwiki.authentication.ldap.server=127.0.0.1

754

xwiki.authentication.ldap.port=389

755

756

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

757

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

758

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

759

xwiki.authentication.ldap.bind_pass={1}

760

761

#-# Force to check password after LDAP connection

762

#-# 0: disable

763

#-# 1: enable

764

xwiki.authentication.ldap.validate_password=0

765

766

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

767

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

768

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

769

770

#-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl]

771

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

772

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

773

774

#-# base DN for searches

775

xwiki.authentication.ldap.base_DN=

776

777

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

778

# xwiki.authentication.ldap.UID_attr=cn

779

780

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

781

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

782

# xwiki.authentication.ldap.password_field=userPassword

783

784

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

785

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

786

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

787

788

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

789

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

790

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

791

792

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

793

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

794

795

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

796

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

797

xwiki.authentication.ldap.update_user=1

798

799

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

800

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

801

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

802

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

803

804

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

805

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

806

# xwiki.authentication.ldap.groupcache_expiration=21800

807

808

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

809

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

810

#-# - always: synchronize on every login

811

# xwiki.authentication.ldap.mode_group_sync=always

812

813

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

814

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

815

xwiki.authentication.ldap.trylocal=1

816

817

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

818

#-# SSL connection to LDAP server

819

#-# 0: normal

820

#-# 1: SSL

821

# xwiki.authentication.ldap.ssl=0

822

823

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

824

#-# The keystore file to use in SSL connection

825

# xwiki.authentication.ldap.ssl.keystore=

826

827

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

828

#-# The java secure provider used in SSL connection

829

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

830

831

832

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

833

# Cache

834

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

835

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

836

837

#-# [Since 1.5M2]

838

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

839

#-# cache component.

840

# xwiki.cache.cachefactory.hint=jbosscache

841

842

#-# [Since 1.5M2]

843

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

844

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

845

846

847

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

848

# WYSIWYG Editor configuration

849

#

850

851

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

852

#-# xwiki.wysiwyg.toolbars property.

853

#-# When not defined it defaults to:

854

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

855

# styletoolbar, horizontaltoolbar, attachmenttoolbar, macrostoolbar, \

856

# tabletoolbar, tablerowtoolbar, tablecoltoolbar, linktoolbar

857

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

858

#-# subtoolbar, findtoolbar, symboltoolbar

859

860

861

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

862

# Skins & Templates configuration

863

#

864

865

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

866

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

867

xwiki.defaultskin=colibri

868

869

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

870

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

871

xwiki.defaultbaseskin=albatross

872

873

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

874

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

875

#-# the first header is stripped.

876

xwiki.title.compatibility=1

877

878

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

# Extensions

#

#-# List of active plugins.

883

xwiki.plugins=\

884

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

885

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

886

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

887

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

888

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

889

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

890

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

891

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

892

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

893

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

894

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

895

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

896

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

897

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

898

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

899

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

900

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

901

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

902

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

903

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

904

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

905

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

906

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

907

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

908

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

909

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

910

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

911

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

912

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

913

com.xpn.xwiki.plugin.tag.TagPlugin

914

915

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

916

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

917

#-# performance and a bit of memory.

918

# xwiki.monitor=1

919

920

#-# Maximum number of last requests to remember.

921

# xwiki.monitor.lastlistsize=20

922

923

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

924

#-# Enabled by default.

925

# xwiki.stats=1

926

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

927

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

928

xwiki.stats.default=0

929

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

930

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

931

932

#-# This parameter will activate the eXo Platform integration

933

xwiki.exo=0

934

935

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

936

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

937

#-# in the xwiki.plugins property.

938

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

939

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

940

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

941

942

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

943

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

944

945

xwiki.plugin.image.cache.capacity=30

946

947

#-# Calendar Prev/Next Month bounds.

948

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

949

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

950

# xwiki.calendar.bound.prev=6

951

# xwiki.calendar.bound.next=12

952

953

#-# Lucene search engine

954

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

955

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

956

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

957

#-# The text analyzer to use for indexing.

958

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

959

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

960

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

961

# xwiki.plugins.lucene.indexinterval=20

962

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

963

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

964

#-# full reindex option.

965

# xwiki.plugins.lucene.maxQueueSize=1000

966

967

#-# [Since 2.0RC1]

968

#-# Activity Stream plugin.

969

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

970

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

971

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

972

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

973

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

974

#-#

975

#-# Default: 1

976

# xwiki.plugin.activitystream.uselocalstore=1

977

#-#

978

#-# Default: 1

979

# xwiki.plugin.activitystream.usemainstore=1

980

#-#

981

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

982

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

983

#-# delete events older than the configured value.

984

#-# Default: 0

985

# xwiki.plugin.activitystream.daystokeepevents=0

986

987

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

# Misc

#

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

992

# xwiki.temp.dir=/tmp/xwiki

993

#-# XWiki work directory

994

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

xwiki.work.dir=work

= Sample xwiki.properties =

1000

1001

1002

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

1003

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

1004

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

1005

# this file.

1006

1007

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

1008

# Core

1009

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

1010

1011

#-# [Since 1.8RC2]

1012

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

1013

#-# Default value is xwiki/2.0.

1014

# core.defaultDocumentSyntax = xwiki/1.0

1015

1016

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

1017

# Rendering

1018

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

1019

1020

#-# [Since 1.8RC2]

1021

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

1027

#-# %t: page title

1028

#-#

1029

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

1030

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

1031

#-#

1032

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

1033

# rendering.linkLabelFormat = %p

1034

1035

#-# [Since 2.0M3]

1036

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

1037

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

1038

#-#

1039

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

1040

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

1041

# rendering.macroCategories = toc:My Category

1042

# rendering.macroCategories = script:My Other Category

1043

1044

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

1045

# Cache

1046

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

1047

1048

#-# [Since 1.7M1]

1049

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

1050

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

1051

# cache.defaultCache=jbosscache

1052

1053

#-# [Since 1.7M1]

1054

#-# The local cache implementation to use.

1055

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

1056

# cache.defaultLocalCache=jbosscache/local

1057

1058

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

1059

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

1060

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

1061

1062

#-# [Since 1.9M2]

1063

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

1064

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

1065

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

1066

# openoffice.serverType=0

1067

1068

#-# [Since 1.9M2]

1069

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

1070

#-# Default port is 8100

1071

# openoffice.serverPort=8100

1072

1073

#-# [Since 1.9M2]

1074

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

1075

#-# Default value is false

1076

# openoffice.autoStart=false

1077

1078

#-# [Since 1.8RC3]

1079

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

1080

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

1081

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

1082

1083

#-# [Since 1.8RC3]

1084

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

1085

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

1086

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

1087

1088

#-# [Since 1.8RC3]

1089

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

1090

#-# Default value is 50

1091

# openoffice.maxTasksPerProcess=50

1092

1093

#-# [Since 1.8RC3]

1094

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

1095

#-# Default value is 30 seconds

1096

# openoffice.taskExecutionTimeout=30000

1097

1098

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

1099

# Velocity

1100

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

1101

1102

#-# [Since 2.0M1]

1103

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

1104

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

1105

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

1106

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

1107

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

1108

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

1109

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

1110

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

1111

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

1112

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

1113

1114

#-# [Since 2.0M1]

1115

#-# Velocity configuration properties. The format is

1116

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

1117

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

1118

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

1119

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

1120

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

1121

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

1122

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

1123

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

1124

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

1125

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

1126

1127

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

1128

# Events distribution

1129

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

1130

1131

#-# [Since 2.0M3]

1132

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

1133

#-# By default remote events are disabled.

1134

# observation.remote.enabled = false

1135

1136

#-# [Since 2.0M3]

1137

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

1138

#-# By default no channel is configured.

1139

#-#

1140

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

1141

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

1142

#-# information.

1143

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

1144

1145

#-# [Since 2.0M4]

1146

#-# The implementation of network adapter to use.

1147

#-# The default is jgroups.

1148

#-#

1149

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

1150

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

1151

1152

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

1153

# Administration

1154

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

1155

1156

#-# [Since 2.2M2]