Configuration (XWiki.org)

Once 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 either the ##xwiki/WEB-INF/xwiki.cfg## file or the ##xwiki/WEB-INF/xwiki.properties## one, and then restarting XWiki. Note that ##xwiki.cfg## was the historical file containing configuration option but we're moving away from it and in due time all the XWiki configuration options will be found in ##xwiki.properties##

8

* by logging in as a user with admin rights and going to the Administration page using the top level menu (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.

9

10

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

11

12

13

If you're a developer and need to understand how Configuration works in XWiki, check the [[Configuration Module Documentation>>extensions:Extension.Configuration Module]].

14

15

16

You can verify some basic settings of your XWiki install (on Tomcat, MySQL) using the [[check Config and Indexes application>>extensions:Extension.Check Config And Indexes Application]].

17

18

There are various things you can configure:

19

20

= Enable superadmin account =

21

22

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

23

24

25

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

26

# it were set and you forgot about it.

27

xwiki.superadminpassword=system

28

29

30

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

31

32

= Language settings =

33

34

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.

35

36

In addition you can configure you wiki to be multilingual. See the [[I18 user page>>Features.I18N]] for more information.

37

38

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:

39

40

41

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

42

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

43

# xwiki.language.preferDefault=0

44

45

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

46

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

52

53

|=Format|=Result

54

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

55

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

56

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

57

58

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

59

60

= Enabling/Disabling Statistics =

61

62

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

63

{{code language="xml"}}xwiki.stats=0

64

xwiki.stats.default=0{{/code}}

where:

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

69

* //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 then the default value //xwiki.stats.default// is used.

70

71

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

72

73

= Optional Store Features =

74

75

== Document versioning ==

76

77

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.

78

79

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

80

{{code}}xwiki.store.versioning=0{{/code}}

81

82

[[Attachment versioning>>platform:AdminGuide.Attachments#HVersions]] is also available and also turned on by default.

83

84

== Document recycle bin ==

85

86

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.

93

94

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:

95

96

97

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

98

xwiki.store.recyclebin.adminWaitDays=3

99

# Normal users must also wait 3 days

100

xwiki.store.recyclebin.waitDays=3

101

102

103

[[Attachment recycle bin>>platform:AdminGuide.Attachments#HDeletion]] is similar.

104

105

= Customizing the Skin =

106

107

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

108

109

= Security configuration =

110

111

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

112

113

If the users will be accessing XWiki using SSL (https) then you will have to change the way links are created so that external links do not redirect users back to the http page. This is accomplished by setting the ##xwiki.url.protocol## property in //xwiki.cfg//.

114

115

= Customizing Menus =

116

117

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>>extensions:Extension.Panels Application]] to provide the different menu panels you see on the left or right of your wikis. Check the [[Panels Application>>extensions:Extension.Panels Application]] to know more on how to configure/modify them.

= Encoding =

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

122

123

= User Authentication =

124

125

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

126

127

= Customizing the registration page (2.1 and older) =

128

129

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

130

131

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

132

133

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

134

135

The Verified Registration Page is part of the [[Administration Application>>extensions:Extension.Administration Application]] 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.

136

137

(Since 2.3M1)

138

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.

139

140

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.

147

148

For more information about configuring the registration page you can visit the page on the [[Administration Application>>extensions:Extension.Administration Application]].

= Initial Groups =

You can set the default groups which new users will automatically be added to by changing the ##xwiki.users.initialGroups## parameter in your [[xwiki.cfg>>#HSamplexwikicfg]] file. To make all new users be added to the groups **XWiki.CoolPeople** and **XWiki.CommunityMembers** you would set the ##initialGroups## parameter like this:

153

154

155

xwiki.users.initialGroups=XWiki.CoolPeople, XWiki.CommunityMembers

156

157

158

* Current members will not be automatically be added to these groups, only new members.

159

* The groups have to be created before being specified as initial groups.

= Logging =

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

164

165

= Configuring Interwiki links =

166

167

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

168

169

170

Note that different lists have to be maintained to support this function in XWiki Syntax 1.0 and 2.x.

The link notation for Interwiki links has changed in XWiki Syntax 2.1. Links should look like this in XWiki Syntax 2.1: ~[~[interwiki:WikiPedia:InterWiki~]~].

175

176

177

== Interwiki links (XWiki Syntax 1.0) ==

178

179

Since XWiki renders wiki syntax using the [[Radeox>>http://codemonkeyism.com/forking-radeox-a-new-wiki-render-engine/]] engine, it supports Interwiki links in [[much the same way as SnipSnap>>http://snipsnap.org/space/InterWiki+HowTo]].

180

181

To configure Interwiki links on your wiki:

182

183

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

184

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

185

{{code}}IMDB http://us.imdb.com/Title?

186

OpenWiki http://openwiki.com/?

187

SourceForge http://sourceforge.net/

188

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

189

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

190

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

191

WikiPedia http://www.wikipedia.com/wiki/{{/code}}

192

193

You can of course add your own entries.

194

195

* Note that Radeox's parser for intermap.txt is very fragile. A blank line at the bottom of the file is enough to make it fall over.

196

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

197

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

198

199

== Interwiki links (XWiki Syntax 2.x) ==

200

201

In order to use Interwiki links in the XWiki Syntax 2.x it is necessary to configure the appropriate list in your ##xwiki.properties## file. Look for the following section:

#-# [Since 2.5M2]

#-# InterWiki definitions in the format alias=URL

206

#-# See http://en.wikipedia.org/wiki/Interwiki_links for a definition of an InterWiki link

207

# Some examples:

208

# rendering.interWikiDefinitions = wikipedia = http://en.wikipedia.org/wiki/

209

# rendering.interWikiDefinitions = definition = http://www.yourdictionary.com/

210

211

212

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

213

214

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

Starting with XWiki Enterprise 3.0, which introduced a revamp of the Administration, you can choose the default editor from "Configuration > Edit Mode Settings" (see below):

= Configure the WYSIWYG editor =

223

224

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

= Link URLs =

With parameters, you can specify what type of links will be made by XWiki.

229

230

== Reverse proxy setup ==

231

232

XWiki can and does run behind reverse proxies such as Apache mod_proxy. Usually the only thing needed is to have the ##x-forwarded-host## http header set to the external URL and XWiki will write links correctly.

233

234

Some reverse proxy software does not set this header and with XWiki Enterprise 3.0M3 or newer, you can use the

235

##xwiki.home## parameter in single wiki instances (non farm) to achieve the same result.

236

237

* **xwiki.home** - parameter in ##xwiki.cfg## will be used to make all links pointing to the main wiki on the server. If your main wiki is called "xwiki" but you want your users to access it by going to www.yoursite.tld instead of xwiki.yoursite.tld, you may set the ##xwiki.home## param to http:~/~/www.yoursite.tld/

238

Since XWiki Enterprise 3.0M3, this parameter will also work for single wiki instances and will be the final authority if the ##x-forwarded-host## parameter is not set.

239

240

* **xwiki.url.protocol** - with the xwiki.url.protocol parameter in xwiki.cfg, you can explicitly specify the protocol as https. This is useful if you are running xwiki behind a reverse proxy which converts https into plain http so xwiki only sees http.

== Short URLs ==

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

245

246

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

247

248

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

249

250

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

251

* xwiki.db.prefix ~-~- useful mainly for [[virtual wikis>>Virtualization]], where we have a separate database schema for each virtual wiki. This prefix is added to the database schema name after usual mapping between wiki names and schemas. Note that this is also applying to the main wiki database name.

252

253

= Turning off comments or attachments =

254

255

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

256

257

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

258

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

259

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

260

261

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

262

263

= Configure edit comment behavior =

264

265

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

266

267

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

268

269

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.

270

271

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

272

273

= Configuring the SMTP server =

274

275

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.

276

277

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 Server field to set the SMTP server to use, as shown on the figure below.

Starting with XWiki Enterprise 3.0 these changes should be performed from "Configuration > Email" (see below):

Your mail server might require some additional options. For a full list of possible parameters, please check the documentation for JavaMail. The most common are listed here :

286

287

|= Option|=Description|=Examples

288

|mail.smtp.localhost|Local host name used in the SMTP HELO or EHLO command. Defaults to InetAddress.getLocalHost().getHostName(). Should not normally need to be set if your JDK and your name service are configured properly.|mail.smtp.localhost=yourhostname.com

289

|mail.smtp.auth|If true, attempt to authenticate the user using the AUTH command. Defaults to false.|mail.smtp.auth=true

290

|mail.smtp.starttls.enable|If true, enables the use of the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. Note that an appropriate trust store must be configured so that the client trusts the server's certificate. Defaults to false. |mail.smtp.starttls.enable=true

291

292

== Using Google SMTP server ==

293

294

|=property|=value

295

|server|smtp.gmail.com

296

|port|587

297

|user|[email protected]

298

|password|xakep

299

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

300

301

= Configuring WebDAV (since 1.7) =

302

303

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.

304

305

== Securing WebDAV Server ==

306

307

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.

308

309

== Disabling WebDAV ==

310

311

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>

316

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

323

{{code}}xwiki.preferences.redirect=1{{/code}}

324

325

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.

326

327

= Customizing the PDF export Look & Feel =

328

329

330

In the future we'll want to rewrite the PDF/RTF exports as Renderers in the new [[Rendering Module architecture>>extensions:Extension.Rendering Module]]. When this happens this section will be upgraded.

331

332

333

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

334

[[image:XWikiExport201010290119.png||width="720" style="border: 1px solid silver;"]]

335

336

As shown in the diagram you can customize 4 parts:

337

338

* The templates, pdf.vm and the referenced subparts, pdfhtmlheader.vm, pdfheader.vm, pdffooter.vm, pdftoc.vm, pdfcover.vm, which can be overridden by a copy located in a custom skin.

339

* The CSS used to render the content as PDF/RTF. There is no pdf.css by default. It could be created in /templates or in a skin; a copy in a skin, override the one located in /templates.

340

* The XHTML2FO XSL transformation. The default one, xhtml2fo.xsl, is packed in core jar.

341

* The FOP XSL transformation. The default one, fop.xsl, is also packed in core jar.

342

343

After the export request triggers XWiki ExportAction, the content of your document is parsed by Velocity to get the initial XHTML content. **[[JTidy>>http://jtidy.sourceforge.net]]**, a HTML/XHTML syntax checker and pretty printer, will clean the initial XHTML to make it XHTML compliant. No customization is possible in this step.

344

345

In order to provide your own customization you need to start by tweaking the default templates (they can also be copied to a new skin) and/or by creating a new [[XWiki Class>>platform:DevGuide.DataModel]]. To do that simply create a new page called ##XWiki.PDFClass## 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):

346

347

* ##style##: contains the CSS information that will overwrite or complement the default ##pdf.css## values if they exist. **[[css4j>>http://www.informatica.info/projects/css/]]**, a CSS API implementation for the Java™ platform, will take care of this.

348

* ##xhtmlxsl##: contains the XHTML to FO XSL overriding the default one. It is processed by **[[Apache Xalan>>http://xml.apache.org/xalan-j/]]**, a XSLT processor for transforming XML documents into HTML, text, or other XML document types.

349

* ##fopxsl##: contains the FOP to PDF/RTF XSL overriding the default one. It is processed by **[[Apache FOP>>http://xmlgraphics.apache.org/fop/]]**.

350

351

352

The name of the class must be ##XWiki.PDFClass##

353

354

355

The good thing about fop/xsl-fo is that the xsl-fo document is independent of the final result. So we can export the wiki documents into many formats.

356

357

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

358

359

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##. (% style="color:#CC0000; font-weight: bold" %)No template is used by default(%%).

360

361

362

As mentioned the ##style## property stores CSS code. The field is parsed by the Velocity engine, so you can use the [[current color theme>>extensions:Extension.Color Theme Application#HUsingColorThemesvariables]] to style your PDF. For example:

363

364

#template('colorThemeInit.vm')

365

h2 {

366

color: $theme.titleColor;

}

td {

border-color: $theme.borderColor;

}

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.

377

378

379

= Configuring Wiki Syntaxes and default Syntax =

380

381

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:

382

383

384

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

385

386

387

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:

388

389

390

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

391

#-# Default value is xwiki/1.0.

392

core.defaultDocumentSyntax = xwiki/2.0

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

= Title behavior =

The following configuration parameters (in ##xwiki.cfg## can be used to control title behavior):

402

403

404

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

405

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

406

#-# the first header is stripped.

407

xwiki.title.compatibility=1

408

409

#-# Defines the maximum header depth to look for when computing a document's title from its content. If no header

410

#-# equal or lower to the specified depth is found then the computed title falls back to the document name.

411

#-# The default value is 2.

412

# xwiki.title.headerdepth=2

413

414

#-# Defines if setting the title field must be mandatory in the WYSIWYG and Wiki editors. It is mandatory when this

415

#-# property is set to 1. The default value is 0 (not mandatory).

416

# xwiki.title.mandatory=0

417

418

419

= Link Label Generation =

420

421

Starting with XWiki Syntax 2.0 it's possible to configure how labels are generated by the system when the user doesn't provide one (e.g. ##[[Main.WebHome]]##)

422

423

Her's an extract from the ##xwiki.properties## file which is where this feature is configurable:

#-# [Since 1.8RC2]

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

433

#-# %t: page title

434

#-#

435

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

436

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

437

#-#

438

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

439

# rendering.linkLabelFormat = %p

= Rendering Cache =

See the [[Performance page>>platform:AdminGuide.Performances#HRenderingcache]]

445

446

= Allowed Pages for Inactive Users =

447

448

The //xwiki.cfg// configuration file includes a property called ##xwiki.inactiveuser.allowedpages##. This property can be used to build a whitelist of pages that can be read by inactive users. The format that should be used is a comma-separated list of pages that users that are marked as inactive are allowed to see.

449

450

This property is needed due to the fact that in XWiki, some users can be marked as inactive, for example when enabling user email verification in the administration. An inactive user has an account, but the account needs to be validated in order for the user to be able to access the wiki. Access rights do not apply to inactive users (they are recognized neither as XWikiGuest nor as members of XWikiAllGroup).

451

452

Note: inactive users are always allowed to see the //XWiki.AccountValidation// page in order to validate their account.

453

454

= Rendering Transformations =

455

456

You can control which [[Transformations>>rendering:Main.Architecture]] are active (by default the [[Macro and Icon ones>>rendering:Main.Transformations]] are active by default) by editing ##xwiki.properties##:

#-# [Since 2.6RC1]

#-# Controls what transformations will be executed when rendering content.

461

#-# A transformation modifies the parsed content. For example the Icon transformation replaces some characters with

462

#-# icons, a WikiWord transformation will automatically create links when it finds wiki words, etc.

463

#-# Note that the Macro transformation is a special transformation that replaces macro markers by the result of the

464

#-# macro execution. If you don't list it, macros won't get executed.

465

#-# The default value is: rendering.transformations = macro, icon

466

467

468

For example if you wish to turn off the Icon Transformation to not render emoticons, you'd define the following property:

469

470

471

rendering.transformations = macro

= Sample xwiki.cfg =

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

478

# Preamble

479

#

480

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

481

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

482

483

484

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

485

# General wiki settings

486

#

487

488

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

489

# xwiki.readonly=no

490

491

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

492

#-# Available syntaxes are:

493

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

494

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

495

496

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

497

#-# names.

498

# xwiki.users.initialGroups=XWiki.XWikiAllGroup

499

500

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

501

#-# group's document?

502

# xwiki.authentication.group.allgroupimplicit=0

503

504

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

505

# xwiki.unknownActionResponse=view

506

507

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

508

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

509

xwiki.encoding=UTF-8

510

511

#-# This parameter will activate the sectional editing.

512

xwiki.section.edit=1

513

514

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

515

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

516

xwiki.section.depth=2

517

518

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

519

xwiki.backlinks=1

520

521

#-# Enable document tags.

xwiki.tags=1

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

# Storage

#

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

530

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

531

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

532

#

533

#-# The main (documents) storage.

534

# xwiki.store.main.hint=default

535

#-# The attachment storage.

536

# xwiki.store.attachment.hint=default

537

#-# The document versioning storage.

538

# xwiki.store.versioning.hint=default

539

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

540

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

541

#-# The document recycle bin storage.

542

# xwiki.store.recyclebin.hint=default

543

#-# The attachment recycle bin storage.

544

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

545

546

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

547

# xwiki.recyclebin=1

548

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

549

# storage.attachment.recyclebin=1

550

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

551

# xwiki.store.versioning=1

552

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

553

# xwiki.store.attachment.versioning=1

554

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

555

# xwiki.store.rollbackattachmentwithdocuments=1

556

557

#-# The path to the hibernate configuration file.

558

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

559

560

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

561

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

562

#-# improve the startup time.

563

# xwiki.store.hibernate.updateschema=1

564

565

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

566

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

567

# xwiki.store.hibernate.custommapping=1

568

#-# Dynamic custom mapping.

569

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

570

571

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

572

#-# Disable only when memory is critical.

573

# xwiki.store.cache=1

574

575

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

576

# xwiki.store.cache.capacity=100

577

578

#-# [Since 1.6M1]

579

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

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

588

# Data migrations

589

#

590

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

591

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

592

# handled by velocity.

593

594

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

595

#-# disable them in production.

596

xwiki.store.migration=1

597

598

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

599

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

600

601

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

602

#-# live afterwards.

603

# xwiki.store.migration.exitAfterEnd=0

604

605

#-# Indicate the list of databases to migrate.

606

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

607

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

608

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

609

# xwiki.store.migration.databases=

610

611

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

612

# Internationalization

613

#

614

615

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

616

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

617

# xwiki.language.preferDefault=0

618

619

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

620

# xwiki.language.forceSupported=0

621

622

623

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

624

# Virtual wikis (farm)

625

#

626

627

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

628

#-# responding to different URLs

629

xwiki.virtual=0

630

631

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

632

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

633

634

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

635

# xwiki.virtual.reserved_wikis=

636

637

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

638

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

639

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

640

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

641

# xwiki.virtual.usepath=0

642

643

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

644

# xwiki.virtual.usepath.servletpath=wiki

645

646

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

# URLs

#

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

651

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

652

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

653

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

654

# xwiki.home=

655

656

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

657

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

658

659

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

660

#-# is not recommended in most cases.

661

#-# For example:

662

#-# xwiki.url.protocol=https

663

# xwiki.url.protocol=

664

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

665

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

666

#-# xwiki.webapppath=xwiki/

667

# xwiki.webapppath=

668

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

669

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

670

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

671

#-# xwiki.servletpath=bin/

672

# xwiki.servletpath=

673

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

674

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

675

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

676

# xwiki.defaultservletpath=bin/

677

678

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

679

# xwiki.showviewaction=1

680

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

681

# xwiki.defaultweb=Main

682

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

683

# xwiki.usedefaultweb=0

684

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

685

# xwiki.defaultpage=WebHome

686

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

687

# xwiki.usedefaultaction=0

688

689

690

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

# Users

#

xwiki.inactiveuser.allowedpages=

695

696

697

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

698

# Authentication and authorization

699

#

700

701

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

702

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

703

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

704

# xwiki.superadminpassword=system

705

706

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

707

# xwiki.authentication=form

708

709

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

710

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

711

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

712

# xwiki.authentication.always=0

713

714

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

715

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

716

xwiki.authentication.validationKey=totototototototototototototototo

717

xwiki.authentication.encryptionKey=titititititititititititititititi

718

719

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

720

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

721

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

722

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

723

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

724

#-#

725

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

726

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

727

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

728

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

729

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

730

#-#

731

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

732

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

733

#-#

734

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

735

xwiki.authentication.cookiedomains=

736

737

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

738

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

739

#-# Currently accepted patterns:

740

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

741

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

742

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

743

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

744

745

#-# The group management class.

746

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

747

#-# Default value for exo:

748

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

749

750

#-# The authentication management class.

751

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

752

#-# Default value for exo:

753

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

754

#-# Default value for LDAP:

755

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

756

757

#-# The authorization management class.

758

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

759

760

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

761

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

762

# xwiki.hidelogin=false

763

764

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

765

xwiki.authentication.unauthorized_code=200

766

767

768

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

# Rendering

#

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

773

#-# Macro mapping

774

# xwiki.render.macromapping=1

775

#-# Velocity interpreter

776

# xwiki.render.velocity=1

777

#-# Groovy interpreter

778

# xwiki.render.groovy=1

779

#-# Plugin rendering

780

# xwiki.render.plugin=1

781

#-# Radeox wiki renderer

782

# xwiki.render.wiki=1

783

#-# Simple wiki syntax rendering

784

# xwiki.render.wikiwiki=0

785

786

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

787

# xwiki.render.cache.capacity=100

788

789

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

790

# xwiki.render.externallinks.defaulttarget=

791

792

793

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

# Editing

#

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

798

# xwiki.minoredit=1

799

800

#-# Use edit comments

801

xwiki.editcomment=1

802

803

#-# Hide editcomment field and only use Javascript

804

# xwiki.editcomment.hidden=0

805

806

#-# Make edit comment mandatory

807

xwiki.editcomment.mandatory=0

808

809

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

810

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

811

#-# 0 means there is no popup.

812

#-# This setting is ignored if mandatory is set

813

# xwiki.editcomment.suggested=0

814

815

816

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

817

# LDAP

818

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

819

820

#-# new LDAP authentication service

821

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

822

823

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

824

#-# 0: disable

825

#-# 1: enable

826

# xwiki.authentication.ldap=1

827

828

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

829

xwiki.authentication.ldap.server=127.0.0.1

830

xwiki.authentication.ldap.port=389

831

832

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

833

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

834

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

835

xwiki.authentication.ldap.bind_pass={1}

836

837

#-# Force to check password after LDAP connection

838

#-# 0: disable

839

#-# 1: enable

840

xwiki.authentication.ldap.validate_password=0

841

842

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

843

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

844

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

845

846

#-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl]

847

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

848

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

849

850

#-# base DN for searches

851

xwiki.authentication.ldap.base_DN=

852

853

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

854

# xwiki.authentication.ldap.UID_attr=cn

855

856

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

857

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

858

# xwiki.authentication.ldap.password_field=userPassword

859

860

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

861

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

862

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

863

864

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

865

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

866

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

867

868

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

869

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

870

871

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

872

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

873

xwiki.authentication.ldap.update_user=1

874

875

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

876

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

877

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

878

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

879

880

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

881

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

882

# xwiki.authentication.ldap.groupcache_expiration=21800

883

884

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

885

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

886

#-# - always: synchronize on every login

887

# xwiki.authentication.ldap.mode_group_sync=always

888

889

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

890

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

891

xwiki.authentication.ldap.trylocal=1

892

893

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

894

#-# SSL connection to LDAP server

895

#-# 0: normal

896

#-# 1: SSL

897

# xwiki.authentication.ldap.ssl=0

898

899

#-# [Since 1.3M2, XWikiLDAPAuthServiceImpl]

900

#-# The keystore file to use in SSL connection

901

# xwiki.authentication.ldap.ssl.keystore=

902

903

#-# [Since 1.5M1, XWikiLDAPAuthServiceImpl]

904

#-# The java secure provider used in SSL connection

905

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

906

907

908

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

909

# Cache

910

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

911

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

912

913

#-# [Since 1.5M2]

914

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

915

#-# cache component.

916

# xwiki.cache.cachefactory.hint=jbosscache

917

918

#-# [Since 1.5M2]

919

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

920

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

921

922

923

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

924

# WYSIWYG Editor configuration

925

#

926

927

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

928

#-# xwiki.wysiwyg.toolbars property.

929

#-# When not defined it defaults to:

930

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

931

# styletoolbar, horizontaltoolbar, attachmenttoolbar, macrostoolbar, \

932

# tabletoolbar, tablerowtoolbar, tablecoltoolbar, linktoolbar

933

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

934

#-# subtoolbar, findtoolbar, symboltoolbar

935

936

937

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

938

# Skins & Templates configuration

939

#

940

941

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

942

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

943

xwiki.defaultskin=colibri

944

945

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

946

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

947

xwiki.defaultbaseskin=albatross

948

949

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

950

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

951

#-# the first header is stripped.

952

xwiki.title.compatibility=1

953

954

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

# Extensions

#

#-# List of active plugins.

959

xwiki.plugins=\

960

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

961

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

962

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

963

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

964

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

965

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

966

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

967

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

968

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

969

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

970

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

971

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

972

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

973

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

974

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

975

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

976

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

977

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

978

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

979

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

980

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

981

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

982

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

983

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

984

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

985

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

986

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

987

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

988

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

989

com.xpn.xwiki.plugin.tag.TagPlugin

990

991

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

992

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

993

#-# performance and a bit of memory.

994

# xwiki.monitor=1

995

996

#-# Maximum number of last requests to remember.

997

# xwiki.monitor.lastlistsize=20

998

999

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

1000

#-# Enabled by default.

1001

# xwiki.stats=1

1002

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

1003

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

1004

xwiki.stats.default=0

1005

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

1006

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

1007

1008

#-# This parameter will activate the eXo Platform integration

1009

xwiki.exo=0

1010

1011

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

1012

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

1013

#-# in the xwiki.plugins property.

1014

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

1015

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

1016

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

1017

1018

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

1019

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

1020

1021

xwiki.plugin.image.cache.capacity=30

1022

1023

#-# Calendar Prev/Next Month bounds.

1024

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

1025

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

1026

# xwiki.calendar.bound.prev=6

1027

# xwiki.calendar.bound.next=12

1028

1029

#-# Lucene search engine

1030

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

1031

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

1032

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

1033

#-# The text analyzer to use for indexing.

1034

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

1035

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

1036

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

1037

# xwiki.plugins.lucene.indexinterval=20

1038

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

1039

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

1040

#-# full reindex option.

1041

# xwiki.plugins.lucene.maxQueueSize=1000

1042

1043

#-# [Since 2.0RC1]

1044

#-# Activity Stream plugin.

1045

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

1046

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

1047

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

1048

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

1049

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

1050

#-#

1051

#-# Default: 1

1052

# xwiki.plugin.activitystream.uselocalstore=1

1053

#-#

1054

#-# Default: 1

1055

# xwiki.plugin.activitystream.usemainstore=1

1056

#-#

1057

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

1058

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

1059

#-# delete events older than the configured value.

1060

#-# Default: 0

1061

# xwiki.plugin.activitystream.daystokeepevents=0

1062

1063

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

# Misc

#

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

1068

# xwiki.temp.dir=/tmp/xwiki

1069

#-# XWiki work directory

1070

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

xwiki.work.dir=work

= Sample xwiki.properties =

1076

1077

1078

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

1079

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

1080

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

1081

# this file.

1082

1083

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

1084

# Core

1085

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

1086

1087

#-# [Since 1.8RC2]

1088

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

1089

#-# Default value is xwiki/2.0.

1090

# core.defaultDocumentSyntax = xwiki/1.0

1091

1092

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

1093

# Rendering

1094

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

1095

1096

#-# [Since 1.8RC2]

1097

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

1103

#-# %t: page title

1104

#-#

1105

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

1106

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

1107

#-#

1108

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

1109

# rendering.linkLabelFormat = %p

1110

1111

#-# [Since 2.0M3]

1112

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

1113

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

1114

#-#

1115

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

1116

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

1117

# rendering.macroCategories = toc:My Category

1118

# rendering.macroCategories = script:My Other Category

1119

1120

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

1121

# Cache

1122

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

1123

1124

#-# [Since 1.7M1]

1125

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

1126

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

1127

# cache.defaultCache=jbosscache

1128

1129

#-# [Since 1.7M1]

1130

#-# The local cache implementation to use.

1131

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

1132

# cache.defaultLocalCache=jbosscache/local

1133

1134

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

1135

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

1136

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

1137

1138

#-# [Since 1.9M2]

1139

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

1140

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

1141

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

1142

# openoffice.serverType=0

1143

1144

#-# [Since 1.9M2]

1145

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

1146

#-# Default port is 8100

1147

# openoffice.serverPort=8100

1148

1149

#-# [Since 1.9M2]

1150

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

1151

#-# Default value is false

1152

# openoffice.autoStart=false

1153

1154

#-# [Since 1.8RC3]

1155

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

1156

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

1157

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

1158

1159

#-# [Since 1.8RC3]

1160

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

1161

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

1162

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

1163

1164

#-# [Since 1.8RC3]

1165

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

1166

#-# Default value is 50

1167

# openoffice.maxTasksPerProcess=50

1168

1169

#-# [Since 1.8RC3]

1170

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

1171

#-# Default value is 30 seconds

1172

# openoffice.taskExecutionTimeout=30000

1173

1174

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

1175

# Velocity

1176

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

1177

1178

#-# [Since 2.0M1]

1179

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

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

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

1188

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

1189

1190

#-# [Since 2.0M1]

1191

#-# Velocity configuration properties. The format is

1192

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

1193

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

1194

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

1195

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

1196

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

1197

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

1198

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

1199

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

1200

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

1201

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

1202

1203

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

1204

# Events distribution

1205

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

1206

1207

#-# [Since 2.0M3]

1208

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

1209

#-# By default remote events are disabled.

1210

# observation.remote.enabled = false

1211

1212

#-# [Since 2.0M3]

1213

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

1214

#-# By default no channel is configured.

1215

#-#

1216

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

1217

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

1218

#-# information.

1219

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

1220

1221

#-# [Since 2.0M4]

1222

#-# The implementation of network adapter to use.

1223

#-# The default is jgroups.

1224

#-#

1225

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

1226

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

1227

1228

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

1229

# Administration

1230

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

1231

1232

#-# [Since 2.2M2]