Wiki source code of Configuration
Version 141.1 by Marc Lijour on 2013/05/06
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | Once you have XWiki [[installed>>Installation]] you'll want to configure it. Configuration can be done in 2 ways: | ||
| 6 | |||
| 7 | * 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 the 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. 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 | {{info}} | ||
| 10 | * Some configurations are only accessible from the ##xwiki.cfg## and ##xwiki.properties## files and have no equivalent on the administration page. | ||
| 11 | * If you're a developer and need to understand how Configuration works in XWiki, check the [[Configuration Module Documentation>>extensions:Extension.Configuration Module]]. | ||
| 12 | {{/info}} | ||
| 13 | )))You can verify some basic settings of your XWiki installation (on Tomcat, MySQL) using the [[Check Config and Indexes application>>extensions:Extension.Check Config And Indexes Application]]. | ||
| 14 | |||
| 15 | There are various things you can configure: | ||
| 16 | |||
| 17 | = Enable superadmin account = | ||
| 18 | |||
| 19 | Edit the ##xwiki.cfg## file and enable the ##xwiki.superadminpassword## property. For example: | ||
| 20 | |||
| 21 | {{code language="none"}} | ||
| 22 | # Enable to allow superadmin. It is disabled by default as this could be a security breach if | ||
| 23 | # it were set and you forgot about it. | ||
| 24 | xwiki.superadminpassword=system | ||
| 25 | {{/code}} | ||
| 26 | |||
| 27 | When logging in, the username will be "superadmin" and the password will be the one you set in the ##xwiki.superadminpassword## property. | ||
| 28 | |||
| 29 | = Language settings = | ||
| 30 | |||
| 31 | To define the default language for your wiki go to the administration page, click on "Localization", 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. | ||
| 32 | |||
| 33 | In addition you can configure your wiki to be multilingual. See the [[I18 user page>>Features.I18N]] for more information. | ||
| 34 | |||
| 35 | 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: | ||
| 36 | |||
| 37 | {{code language="none"}} | ||
| 38 | #-# By default, XWiki chooses the language specified by the client (browser) in the Accept-Language HTTP header. This | ||
| 39 | #-# allows to use the default language of the wiki when the user didn't manually choose a language. | ||
| 40 | # xwiki.language.preferDefault=0 | ||
| 41 | |||
| 42 | #-# Force only one of the supported languages to be accepted. | ||
| 43 | # xwiki.language.forceSupported=0 | ||
| 44 | {{/code}} | ||
| 45 | |||
| 46 | = Date format = | ||
| 47 | |||
| 48 | To define the date format used in the interfaces, go to //Wiki -> Administer Wiki -> Localization//, locate the "Date format" field and enter the date format you wish to use. Examples: | ||
| 49 | |||
| 50 | |=Format|=Result | ||
| 51 | |MMMM dd, HH:mm|January 27, 12:27 | ||
| 52 | |yyyy/MM/dd, HH:mm|2009/01/27, 12:27 | ||
| 53 | |dd/MM/yyyy, HH:mm|27/01/2009, 12:27 | ||
| 54 | |||
| 55 | [[More information about date formatting>>http://docs.oracle.com/javase/1.5.0/docs/api/java/text/SimpleDateFormat.html]]. | ||
| 56 | |||
| 57 | = Enabling/Disabling Statistics = | ||
| 58 | |||
| 59 | To disable [[the Statistics feature>>extensions:Extension.Statistics Application]] edit your //xwiki.cfg// file and replace the following properties as shown here (to enable statistics, change ##0## to ##1##): | ||
| 60 | |||
| 61 | {{code}} | ||
| 62 | xwiki.stats=0 | ||
| 63 | xwiki.stats.default=0 | ||
| 64 | {{/code}} | ||
| 65 | |||
| 66 | where: | ||
| 67 | |||
| 68 | * ##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 are on or 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 | {{info}} | ||
| 71 | There's currently no UI to set the statistics on or off for a given subwiki. Thus at the moment you'll need to do 2 things: | ||
| 72 | * Edit ##XWiki.XWikiPreferences## to add a new boolean property to the class, by going to //{{{http://localhost:8080/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class}}}// | ||
| 73 | * Set the ##statistics## property to true by going to //{{{http://localhost:8080/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object}}}// and setting the ##statistics## property to ##true## | ||
| 74 | {{/info}} | ||
| 75 | ))) | ||
| 76 | |||
| 77 | = Optional Store Features = | ||
| 78 | |||
| 79 | == Document versioning == | ||
| 80 | |||
| 81 | 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. | ||
| 82 | |||
| 83 | To disable versioning edit //xwiki.cfg// and add {{code}}xwiki.store.versioning=0{{/code}}. | ||
| 84 | |||
| 85 | [[Attachment versioning>>platform:AdminGuide.Attachments#HVersions]] is also available and turned on by default. | ||
| 86 | |||
| 87 | == Document recycle bin == | ||
| 88 | |||
| 89 | 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 {{code}}xwiki.recyclebin=0{{/code}}. | ||
| 90 | |||
| 91 | {{info}} | ||
| 92 | Disabling the recycle bin will make it impossible to restore a deleted document, unless a database backup is available. | ||
| 93 | {{/info}} | ||
| 94 | |||
| 95 | 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: | ||
| 96 | |||
| 97 | {{code}} | ||
| 98 | # Admins must wait 3 days before being allowed to permanently delete | ||
| 99 | xwiki.store.recyclebin.adminWaitDays=3 | ||
| 100 | # Normal users must also wait 3 days | ||
| 101 | xwiki.store.recyclebin.waitDays=3 | ||
| 102 | {{/code}} | ||
| 103 | |||
| 104 | [[Attachment recycle bin>>platform:AdminGuide.Attachments#HDeletion]] is similar. | ||
| 105 | |||
| 106 | = Customizing the Skin = | ||
| 107 | |||
| 108 | See the [[Skin Guide>>AdminGuide.Skins]]. | ||
| 109 | |||
| 110 | = Security configuration = | ||
| 111 | |||
| 112 | See the [[Security Guide>>AdminGuide.Security]]. | ||
| 113 | |||
| 114 | 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//. | ||
| 115 | |||
| 116 | = Customizing Menus = | ||
| 117 | |||
| 118 | 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. | ||
| 119 | |||
| 120 | = Encoding = | ||
| 121 | |||
| 122 | See the [[Encoding Guide>>AdminGuide.Encoding]]. | ||
| 123 | |||
| 124 | = User Authentication = | ||
| 125 | |||
| 126 | See the [[Authentication Guide>>AdminGuide.Authentication]]. | ||
| 127 | |||
| 128 | == Customizing the Verified Registration Page (Since 2.2M2) == | ||
| 129 | |||
| 130 | 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 validation constraints to the fields which are there. | ||
| 131 | |||
| 132 | Since version 2.3M1 in order 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. | ||
| 133 | |||
| 134 | For more information about configuring the registration page you can visit the page on the [[Administration Application>>extensions:Extension.Administration Application]]. | ||
| 135 | |||
| 136 | = Initial Groups = | ||
| 137 | |||
| 138 | 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>>#HSamplexwiki.cfg]] file. To make all new users be added to the groups **XWiki.CoolPeople** and **XWiki.CommunityMembers** you will have to set the ##initialGroups## parameter like this: | ||
| 139 | |||
| 140 | ((( | ||
| 141 | {{code language="none"}} | ||
| 142 | xwiki.users.initialGroups=XWiki.CoolPeople, XWiki.CommunityMembers | ||
| 143 | {{/code}} | ||
| 144 | ))) | ||
| 145 | |||
| 146 | * Current members will not be automatically be added to these groups, only new members. | ||
| 147 | * The groups have to be created before being specified as initial groups. | ||
| 148 | |||
| 149 | = Logging = | ||
| 150 | |||
| 151 | See the [[Logging page>>Logging]]. | ||
| 152 | |||
| 153 | = Configuring Interwiki links = | ||
| 154 | |||
| 155 | [[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]]. | ||
| 156 | |||
| 157 | {{info}} | ||
| 158 | Note that different lists have to be maintained to support this function in XWiki Syntax 1.0 and 2.x. | ||
| 159 | {{/info}} | ||
| 160 | |||
| 161 | {{warning}} | ||
| 162 | 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~]~]. | ||
| 163 | {{/warning}} | ||
| 164 | |||
| 165 | == Interwiki links (XWiki Syntax 1.0) == | ||
| 166 | |||
| 167 | 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]]. | ||
| 168 | |||
| 169 | To configure Interwiki links on your wiki: | ||
| 170 | |||
| 171 | * Create a file named ##[location from where you start your container]/conf/**intermap.txt**## | ||
| 172 | * Fill ##intermap.txt## with content like:((( | ||
| 173 | {{code}} | ||
| 174 | IMDB http://us.imdb.com/Title? | ||
| 175 | OpenWiki http://openwiki.com/? | ||
| 176 | SourceForge http://sourceforge.net/ | ||
| 177 | TWiki http://twiki.org/cgi-bin/view/ | ||
| 178 | Why http://clublet.com/c/c/why? | ||
| 179 | Wiki http://c2.com/cgi/wiki? | ||
| 180 | WikiPedia http://www.wikipedia.com/wiki/ | ||
| 181 | {{/code}} | ||
| 182 | )))You can of course add your own entries. | ||
| 183 | |||
| 184 | {{warning}} | ||
| 185 | 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. | ||
| 186 | {{/warning}} | ||
| 187 | |||
| 188 | Restart XWiki (you'll need to restart XWiki every time you change ##intermap.txt##) and try out an Interwiki link. 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. | ||
| 189 | |||
| 190 | == Interwiki links (XWiki Syntax 2.x) == | ||
| 191 | |||
| 192 | 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: | ||
| 193 | |||
| 194 | {{code language="none"}} | ||
| 195 | #-# [Since 2.5M2] | ||
| 196 | #-# InterWiki definitions in the format alias=URL | ||
| 197 | #-# See http://en.wikipedia.org/wiki/Interwiki_links for a definition of an InterWiki link | ||
| 198 | # Some examples: | ||
| 199 | # rendering.interWikiDefinitions = wikipedia = http://en.wikipedia.org/wiki/ | ||
| 200 | # rendering.interWikiDefinitions = definition = http://www.yourdictionary.com/ | ||
| 201 | {{/code}} | ||
| 202 | |||
| 203 | = Setting the default editor to use (Wiki or WYSIWYG) = | ||
| 204 | |||
| 205 | 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): | ||
| 206 | |||
| 207 | {{image reference="DefaultEditorStarting30.png"/}} | ||
| 208 | |||
| 209 | = Configure the WYSIWYG editor = | ||
| 210 | |||
| 211 | See [[WYSIWYG Editor Configuration>>WysiwygEditor]] page to find out how you can enable or disable editing features. | ||
| 212 | |||
| 213 | = Link URLs = | ||
| 214 | |||
| 215 | With parameters, you can specify what type of links will be made by XWiki. | ||
| 216 | |||
| 217 | == Reverse proxy setup == | ||
| 218 | |||
| 219 | 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. | ||
| 220 | |||
| 221 | Some reverse proxy software does not set this header and with XWiki Enterprise 3.0M3 or newer, you can use the ##xwiki.home## parameter in single wiki instances (non farm) to achieve the same result. | ||
| 222 | |||
| 223 | * **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## parameter to //{{{http://www.yoursite.tld/}}}// | ||
| 224 | 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. | ||
| 225 | |||
| 226 | * **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. | ||
| 227 | |||
| 228 | == Short URLs == | ||
| 229 | |||
| 230 | It's possible to [[configure XWiki to use shorter URLs>>Main.ShortURLs]]. | ||
| 231 | |||
| 232 | = Configure the names of database schemas (since 1.6M1) = | ||
| 233 | |||
| 234 | Sometimes, especially in enterprise environment, we need to control the names of database schemes, other than default. | ||
| 235 | |||
| 236 | * **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 the hibernate configuration file). | ||
| 237 | * **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 applied to the main wiki database name. | ||
| 238 | |||
| 239 | = Turning off comments or attachments = | ||
| 240 | |||
| 241 | You need to change the ##XWiki.XWikiPreferences## class like this: | ||
| 242 | |||
| 243 | * Go to ##<server>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class## | ||
| 244 | * Add a new property called ##showcomments## (or ##showattachments## for turning off attachments) of type String Class | ||
| 245 | * Go to ##<server>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences## and write no in the ##showcomments## (or ##showattachments##) field | ||
| 246 | |||
| 247 | That's it, the comments (or attachments) are gone. If you want to re-enable them, replace the "no" value with "yes". | ||
| 248 | |||
| 249 | = Configure "Version Summary" behavior = | ||
| 250 | |||
| 251 | When you're editing a page you can add a brief description of your changes in the "Version Summary" field by default (look at [[Features.PageEditing#HCommoneditactions]]). You can disable this feature by setting ##xwiki.editcomment=0## in ##xwiki.cfg##. | ||
| 252 | |||
| 253 | When the "Version Summary" feature is enabled, you can also set "Version Summary" to be mandatory by setting //xwiki.editcomment.mandatory=1// in //xwiki.cfg//. This will show a popup window with the request to write a short comment if there is no comment entered. It doesn't allow you to enter an empty comment. If you want a popup, but you also want to be able to enter an empty comment, set //xwiki.editcomment.suggested=1// in //xwiki.cfg// | ||
| 254 | |||
| 255 | If you set "Version Summary" as mandatory or suggested, you can also remove the "Version Summary" field and use only a popup window for writing a comment. Set //xwiki.editcomment.hidden=0// in //xwiki.cfg// to do this. | ||
| 256 | |||
| 257 | You can use the special fields in the //XWikiPreferences// object instead of editing //xwiki.cfg//. These fields are: //editcomment//, //editcomment_mandatory//, //editcomment_suggested// and //editcomment_hidden//. | ||
| 258 | |||
| 259 | = Configuring Directories = | ||
| 260 | |||
| 261 | XWiki uses a temporary directory to cache images after re-sizing them or store attachments after loading them out of the database. It also uses a permanent directory for storing data such as [[filesystem attachments>>AdminGuide.Attachments#HFilesystemAttachmentStore28SinceXWikiEnterprise3.0M229]] which must not be deleted and search indexes which are replaceable but laborious to create. | ||
| 262 | |||
| 263 | If there is no configured persistent directory, XWiki will use the temporary directory and log a warning on startup. | ||
| 264 | |||
| 265 | Since [[XWiki Enterprise 4.1M2>>http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/ReleaseNotesXWikiEnterprise41M2#HBugfixesandimprovements]] the temporary files will be placed in a special sub-directory of the temporary directory called ##xwiki-temp##. This directory is periodically cleaned and all its content deleted so it is critical that it is not used for anything else. | ||
| 266 | |||
| 267 | To set the permanent directory, you have 2 options: | ||
| 268 | |||
| 269 | * Set the ##xwiki.data.dir## system property when starting the JVM (ie. the Servlet Container's JVM, specifically: ##-Dxwiki.data.dir=...##) | ||
| 270 | * Set the ##environment.permanentDirectory## property in your ##xwiki.properties## file | ||
| 271 | |||
| 272 | If the location points to a file or a directory to which XWiki does not have access, a warning will be printed in the log and the temporary directory will be used as a default. | ||
| 273 | |||
| 274 | The temporary directory is taken from the Servlet Container's ##javax.servlet.context.tempdir## Servlet Context property and thus must be configured at that level. If it is pointed to a file or directory where XWiki cannot write, it will print a warning in the log and attempt to use [[java.io.tmpdir>>http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/System.html#getProperties()]]. If this is not a writable directory, an exception will be thrown. | ||
| 275 | |||
| 276 | = Configuring the SMTP server = | ||
| 277 | |||
| 278 | If you're planning to use XWiki's feature that sends emails you'll need to configure the SMTP server used and the email address under which XWiki will send emails. | ||
| 279 | |||
| 280 | Starting with XWiki Enterprise 3.0 to configure these you need to go to the administration page (//{{{http://<server>/xwiki/bin/admin/XWiki/XWikiPreferences}}}//) and click on "Email" under "Configuration". Then modify the "Admin Email" field to set the email under which XWiki emails will be sent and also modify the "Server" field to set the SMTP server to use: | ||
| 281 | |||
| 282 | {{image reference="MailSettingsStarting30.png"/}} | ||
| 283 | |||
| 284 | 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: | ||
| 285 | |||
| 286 | |= Option|=Description|=Examples | ||
| 287 | |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 | ||
| 288 | |mail.smtp.auth|If true, attempt to authenticate the user using the AUTH command. Defaults to false.|mail.smtp.auth=true | ||
| 289 | |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 | ||
| 290 | |||
| 291 | == Using Google SMTP server == | ||
| 292 | |||
| 293 | |=property|=value | ||
| 294 | |server|smtp.gmail.com | ||
| 295 | |port|587 | ||
| 296 | |user|vovan@gmail.com | ||
| 297 | |password|xakep | ||
| 298 | |JavaMail properties|mail.smtp.starttls.enable=true | ||
| 299 | |||
| 300 | = Configuring WebDAV (since 1.7) = | ||
| 301 | |||
| 302 | WebDAV support has been added to XWiki beginning with XWiki Enterprise 1.7. It is very important to note that WebDAV is enabled by default. | ||
| 303 | |||
| 304 | == Securing WebDAV Server == | ||
| 305 | |||
| 306 | XWiki's WebDAV implementation only supports the [[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. | ||
| 307 | |||
| 308 | == Disabling WebDAV == | ||
| 309 | |||
| 310 | 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 like this: | ||
| 311 | |||
| 312 | {{code language="xml"}} | ||
| 313 | <servlet-mapping> | ||
| 314 | <servlet-name>webdav</servlet-name> | ||
| 315 | <url-pattern>/webdav/*</url-pattern> | ||
| 316 | </servlet-mapping> | ||
| 317 | {{/code}} | ||
| 318 | |||
| 319 | = Redirections = | ||
| 320 | |||
| 321 | XWiki supports defining redirections for incoming requests. To activate this feature modify your ##xwiki.cfg## file and set the following property: {{code}}xwiki.preferences.redirect=1{{/code}}. | ||
| 322 | 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. | ||
| 323 | |||
| 324 | = Customizing the PDF export Look & Feel = | ||
| 325 | |||
| 326 | {{info}} | ||
| 327 | 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. | ||
| 328 | {{/info}} | ||
| 329 | |||
| 330 | Here's how the PDF and RTF exports currently work: | ||
| 331 | [[image:XWikiExport201010290119.png||style="border: 1px solid silver;" width="720"]] | ||
| 332 | |||
| 333 | As shown in the diagram you can customize 4 parts: | ||
| 334 | |||
| 335 | * 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 | ||
| 336 | * 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 | ||
| 337 | * The XHTML2FO XSL transformation. The default one, xhtml2fo.xsl, is packed in core jar. | ||
| 338 | * The FOP XSL transformation. The default one, fop.xsl, is also packed in core jar. | ||
| 339 | |||
| 340 | 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. | ||
| 341 | |||
| 342 | 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): | ||
| 343 | |||
| 344 | * ##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&trade platform, will take care of this | ||
| 345 | * ##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. Since version 3.0M2 (see issue [[XWIKI-5918>>http://jira.xwiki.org/browse/XWIKI-5918||title="Impossible to override XSLT documents used in the PDF export process"]]) this field needs to be the actual content of the customized ##xhtml2fo.xsl##. Note that you can also use velocity in this field (useful to get the content of an attached .xsl file, which comes in very handy when you need to fill in a big file, since the limit of textarea properties is of 60 000 characters) | ||
| 346 | * ##fopxsl##: contains the FOP to PDF/RTF XSL overriding the default one. It is processed by **[[Apache FOP>>http://xmlgraphics.apache.org/fop/]]**. | ||
| 347 | |||
| 348 | {{warning}} | ||
| 349 | The name of the class must be ##XWiki.PDFClass##. | ||
| 350 | {{/warning}} | ||
| 351 | |||
| 352 | 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. | ||
| 353 | |||
| 354 | Then create a new page (say ##XWiki.PDFTemplate##) and add the ##XWiki.PDFClass## object to it. | ||
| 355 | |||
| 356 | 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}}}//. | ||
| 357 | |||
| 358 | {{warning}} | ||
| 359 | No template is used by default. | ||
| 360 | {{/warning}} | ||
| 361 | |||
| 362 | {{info}} | ||
| 363 | 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: | ||
| 364 | |||
| 365 | {{code language=css}} | ||
| 366 | #template('colorThemeInit.vm') | ||
| 367 | h2 { | ||
| 368 | color: $theme.titleColor; | ||
| 369 | } | ||
| 370 | |||
| 371 | td { | ||
| 372 | border-color: $theme.borderColor; | ||
| 373 | } | ||
| 374 | {{/code}} | ||
| 375 | {{/info}} | ||
| 376 | |||
| 377 | = Override the PDF Templates = | ||
| 378 | |||
| 379 | == Customize the PDF Footer == | ||
| 380 | |||
| 381 | By default, the PDF footer will display the page number, the last author and the date on which the last modification was performed. In order to also display a customized message, the template ##pdffooter.vm## must be overridden. To do that, edit the skin class (e.g. //{{{http://yourserver/xwiki/bin/edit/XWiki/XWikiSkins?editor=class}}}//) and add a "TextArea" object named ##pdffooter.vm##: | ||
| 382 | |||
| 383 | [[image:OverridePDFFooter.png]] | ||
| 384 | |||
| 385 | Next, edit the skin page (e.g. //{{{http://yourserver/xwiki/bin/edit/XWiki/DefaultSkin?editor=object}}}//) and add the following code to the ##pdffooter.vm## property: | ||
| 386 | |||
| 387 | {{code}} | ||
| 388 | $msg.Page <span class="page-number"></span> - $msg.get('lastmodifiedby') | ||
| 389 | $xwiki.getUserName($tdoc.author, false) | ||
| 390 | $msg.get('lastmodifiedon') | ||
| 391 | $!xwiki.formatDate($tdoc.date) | ||
| 392 | <div> | ||
| 393 | <p>CustomName SAS. All rights reserved. Confidential and proprietary document. Printed Copies are not controlled.</p> | ||
| 394 | </div> | ||
| 395 | {{/code}} | ||
| 396 | |||
| 397 | To see the changes, just export any wiki page: | ||
| 398 | |||
| 399 | [[image:OverridePDFFooterFinal.png]] | ||
| 400 | |||
| 401 | == Customize the PDF Cover == | ||
| 402 | |||
| 403 | This could be useful when you want for instance to add the company's logo to the PDF cover. In order to do this, the template ##pdfcover.vm## must be overridden. Just like for the PDF header, a "TextArea" property named ##pdfcover.vm## must be added to the XWiki.XWikiSkins class (e.g. //{{{http://yourserver/xwiki/bin/view/XWiki/XWikiSkins?editor=class}}}//). | ||
| 404 | |||
| 405 | [[image:OverridePDFCover.png]] | ||
| 406 | |||
| 407 | Next, edit the skin page (e.g. //{{{http://yourserver/xwiki/bin/edit/XWiki/DefaultSkin?editor=object}}}//) and add the following code to the ##pdfcover.vm## property: | ||
| 408 | |||
| 409 | {{code}} | ||
| 410 | <img src="$xwiki.getSkinFile("logo.png")"/> | ||
| 411 | |||
| 412 | <div style="text-align: center; width: 100%;"> | ||
| 413 | <h1> | ||
| 414 | #set($title = "$!pdfdoc.display('title', 'rendered')") | ||
| 415 | #if($title == '') | ||
| 416 | $escapetool.xml($!doc.displayTitle) | ||
| 417 | #else | ||
| 418 | $escapetool.xml($title) | ||
| 419 | #end | ||
| 420 | </h1> | ||
| 421 | <br /> | ||
| 422 | <br /> | ||
| 423 | $!xwiki.getUserName($tdoc.author, false) | ||
| 424 | <br /> | ||
| 425 | $!xwiki.formatDate($tdoc.date) | ||
| 426 | </div> | ||
| 427 | {{/code}} | ||
| 428 | |||
| 429 | The last step consists of attaching the image "logo.png" to the skin: | ||
| 430 | |||
| 431 | [[image:OverridePDFCoverFinal.png]] | ||
| 432 | |||
| 433 | == Override the CSS rules == | ||
| 434 | |||
| 435 | In order to use your own template when exporting a page as PDF, you need to create a class in the XWiki space and name it PDFClass. Next, edit the page in "Class" mode (e.g. //{{{http://yourserver/xwiki/bin/edit/XWiki/PDFClass?editor=class}}}//) and add the following TextArea properties: | ||
| 436 | |||
| 437 | * style which contains the CSS rules that will override the default ##pdf.css## values; by default, there won't be a ##pdf.css## file on your filesystem, but you can create it in the folder ##\webapps\xwiki\templates\## or specify it in your skin page | ||
| 438 | * xhtmlxsl which contains the XHTML2FO XSL transformation that will override the default one | ||
| 439 | * fopxsl which contains the FOP XSL transformation that will override the default one | ||
| 440 | |||
| 441 | [[image:CreatePDFClass.png]] | ||
| 442 | |||
| 443 | Then, create the wiki page for which your want to customize the PDF export (e.g. XWiki.PDFTemplate) and add a "XWiki.PDFClass" object to it. | ||
| 444 | |||
| 445 | Supposing your wiki page contains a table, you have to edit it in "Wiki" mode and add a style parameter as shown below: | ||
| 446 | |||
| 447 | {{code}} | ||
| 448 | (% class="mytable" %) | ||
| 449 | |=Column 1|=Column 2 | ||
| 450 | | data|data | ||
| 451 | {{/code}} | ||
| 452 | |||
| 453 | Next, edit the page in "Objects" mode and write your own CSS rules in the "style" property: | ||
| 454 | |||
| 455 | [[image:CreatePDFTemplate.png]] | ||
| 456 | |||
| 457 | Because no template is used by default, you need to specify the ##pdftemplate## parameter in the URL in order to use your own template: //{{{http://yourserver/xwiki/bin/export/XWiki/PDFTemplate?format=pdf&pdftemplate=XWiki.PDFTemplate}}}//. | ||
| 458 | |||
| 459 | [[image:CustomizedPDF.png]] | ||
| 460 | |||
| 461 | {{info}} | ||
| 462 | 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. | ||
| 463 | {{/info}} | ||
| 464 | |||
| 465 | == Override the xhtml2fo.xsl rules == | ||
| 466 | |||
| 467 | As explained above, the entire code of [[xhtml2fo.xsl>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-oldcore/src/main/resources/xhtml2fo.xsl]] needs to be copied in the xhtmlxsl textarea and then customized. | ||
| 468 | |||
| 469 | For example, to disable the generation of clickable URLs in the PDF, modify the follwing section: | ||
| 470 | {{code}} <xsl:template match="html:a[@href]" mode="transform"> | ||
| 471 | <fo:basic-link xsl:use-attribute-sets="a-link"> | ||
| 472 | <xsl:call-template name="process-a-link"/> | ||
| 473 | </fo:basic-link> | ||
| 474 | </xsl:template>{{/code}} | ||
| 475 | as | ||
| 476 | {{code}} <xsl:template match="html:a[@href]" mode="transform"> | ||
| 477 | <fo:inline> | ||
| 478 | <xsl:call-template name="process-a-link"/> | ||
| 479 | </fo:inline> | ||
| 480 | </xsl:template>{{/code}} | ||
| 481 | |||
| 482 | = Configuring Wiki Syntaxes and default Syntax = | ||
| 483 | |||
| 484 | 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: | ||
| 485 | |||
| 486 | {{code}} | ||
| 487 | 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 | ||
| 488 | {{/code}} | ||
| 489 | |||
| 490 | 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: | ||
| 491 | |||
| 492 | {{code}} | ||
| 493 | #-# Specifies the default syntax to use when creating new documents. | ||
| 494 | #-# Default value is xwiki/1.0. | ||
| 495 | core.defaultDocumentSyntax = xwiki/2.0 | ||
| 496 | {{/code}} | ||
| 497 | |||
| 498 | {{warning}} | ||
| 499 | Hint: If it doesn't work check that you've edited the correct configuration file. | ||
| 500 | {{/warning}} | ||
| 501 | |||
| 502 | = Title behavior = | ||
| 503 | |||
| 504 | The following configuration parameters (found in ##xwiki.cfg##) can be used to control title behavior: | ||
| 505 | |||
| 506 | {{code language="none"}} | ||
| 507 | #-# Defines whether title handling should be using the compatibility mode or not. When the compatibility | ||
| 508 | #-# mode is active, if the document's content first header (level 1 or level 2) matches the document's title | ||
| 509 | #-# the first header is stripped. | ||
| 510 | xwiki.title.compatibility=1 | ||
| 511 | |||
| 512 | #-# Defines the maximum header depth to look for when computing a document's title from its content. If no header | ||
| 513 | #-# equal or lower to the specified depth is found then the computed title falls back to the document name. | ||
| 514 | #-# The default value is 2. | ||
| 515 | # xwiki.title.headerdepth=2 | ||
| 516 | |||
| 517 | #-# Defines if setting the title field must be mandatory in the WYSIWYG and Wiki editors. It is mandatory when this | ||
| 518 | #-# property is set to 1. The default value is 0 (not mandatory). | ||
| 519 | # xwiki.title.mandatory=0 | ||
| 520 | {{/code}} | ||
| 521 | |||
| 522 | = Link Label Generation = | ||
| 523 | |||
| 524 | 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]]##). | ||
| 525 | |||
| 526 | Her's an extract from the ##xwiki.properties## file which is where this feature is configurable: | ||
| 527 | |||
| 528 | {{code language="none"}} | ||
| 529 | #-# [Since 1.8RC2] | ||
| 530 | #-# Specifies how links labels are displayed when the user doesn't specify the label explicitely. | ||
| 531 | #-# Valid values: | ||
| 532 | #-# %w: wiki name | ||
| 533 | #-# %s: space name | ||
| 534 | #-# %p: page name | ||
| 535 | #-# %P: page name with spaces between camel case words, i.e. "My Page" iff the page name is "MyPage" | ||
| 536 | #-# %t: page title | ||
| 537 | #-# | ||
| 538 | #-# Note that if the page title is empty or not defined then it defaults to %p. This is also the case | ||
| 539 | #-# if the title cannot be retrieved for the document. | ||
| 540 | #-# | ||
| 541 | #-# The default is "%p". Some examples: "%s.%p", "%w:%s.%p". | ||
| 542 | # rendering.linkLabelFormat = %p | ||
| 543 | {{/code}} | ||
| 544 | |||
| 545 | = Rendering Cache = | ||
| 546 | |||
| 547 | See the [[Performance page>>platform:AdminGuide.Performances#HRenderingcache]]. | ||
| 548 | |||
| 549 | = Allowed Pages for Inactive Users = | ||
| 550 | |||
| 551 | 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. | ||
| 552 | |||
| 553 | 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). | ||
| 554 | |||
| 555 | {{info}} | ||
| 556 | Inactive users are always allowed to see the //XWiki.AccountValidation// page in order to validate their account. | ||
| 557 | {{/info}} | ||
| 558 | |||
| 559 | = Rendering Transformations = | ||
| 560 | |||
| 561 | You can control which [[Transformations>>rendering:Main.Architecture]] are active (by default the [[Macro>>rendering:Main.Architecture]] and [[Icon>>rendering:Main.Transformations#HIconTransformation]] ones are active by default) by editing ##xwiki.properties##: | ||
| 562 | |||
| 563 | {{code language="none"}} | ||
| 564 | #-# [Since 2.6RC1] | ||
| 565 | #-# Controls what transformations will be executed when rendering content. | ||
| 566 | #-# A transformation modifies the parsed content. For example the Icon transformation replaces some characters with | ||
| 567 | #-# icons, a WikiWord transformation will automatically create links when it finds wiki words, etc. | ||
| 568 | #-# Note that the Macro transformation is a special transformation that replaces macro markers by the result of the | ||
| 569 | #-# macro execution. If you don't list it, macros won't get executed. | ||
| 570 | #-# The default value is: rendering.transformations = macro, icon | ||
| 571 | {{/code}} | ||
| 572 | |||
| 573 | For example if you wish to turn off the Icon Transformation in order to not render emoticons, you'd have to define the following property: {{code language="none"}}rendering.transformations = macro{{/code}}. | ||
| 574 | |||
| 575 | = Securing Groovy Scripts = | ||
| 576 | |||
| 577 | See: | ||
| 578 | |||
| 579 | * The [[Commons Groovy Module>>extensions:Extension.GroovyModuleCommons]] | ||
| 580 | * The [[Platform Groovy Module>>extensions:Extension.GroovyModulePlatform]] | ||
| 581 | |||
| 582 | = Sample xwiki.cfg = | ||
| 583 | |||
| 584 | {{code language="none"}} | ||
| 585 | #--------------------------------------- | ||
| 586 | # Preamble | ||
| 587 | # | ||
| 588 | # This is the main old XWiki configuration file. Commented parameters show the default value, although some features | ||
| 589 | # might be disabled. To customize, uncomment and put your own value instead. | ||
| 590 | |||
| 591 | |||
| 592 | #--------------------------------------- | ||
| 593 | # General wiki settings | ||
| 594 | # | ||
| 595 | |||
| 596 | #-# When the wiki is readonly, any updates are forbidden. To mark readonly, use one of: yes, 1, true | ||
| 597 | # xwiki.readonly=no | ||
| 598 | |||
| 599 | #-# [Since 1.6RC1] Defines the list of supported syntaxes | ||
| 600 | #-# Available syntaxes are: | ||
| 601 | #-# 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 | ||
| 602 | xwiki.rendering.syntaxes = xwiki/1.0, xwiki/2.0 | ||
| 603 | |||
| 604 | #-# List of groups that a new user should be added to by default after registering. Comma-separated list of group document | ||
| 605 | #-# names. | ||
| 606 | # xwiki.users.initialGroups=XWiki.XWikiAllGroup | ||
| 607 | |||
| 608 | #-# Should all users be considered members of XWiki.XWikiAllGroup, even if they don't have an associated object in the | ||
| 609 | #-# group's document? | ||
| 610 | # xwiki.authentication.group.allgroupimplicit=0 | ||
| 611 | |||
| 612 | #-# Uncomment if you want to ignore requests for unmapped actions, and simply display the document | ||
| 613 | # xwiki.unknownActionResponse=view | ||
| 614 | |||
| 615 | #-# The encoding to use when transformin strings to and from byte arrays. This causes the jvm encoding to be ignored, | ||
| 616 | #-# since we want to be independend of the underlying system. | ||
| 617 | xwiki.encoding=UTF-8 | ||
| 618 | |||
| 619 | #-# This parameter will activate the sectional editing. | ||
| 620 | xwiki.section.edit=1 | ||
| 621 | |||
| 622 | #-# This parameter controls the depth of sections that have section editing. | ||
| 623 | #-# By default level 1 and level 2 sections have section editing. | ||
| 624 | xwiki.section.depth=2 | ||
| 625 | |||
| 626 | #-# Enable backlinks storage, which increases the update time, but allows to keep track of inter document links. | ||
| 627 | xwiki.backlinks=1 | ||
| 628 | |||
| 629 | #-# Enable document tags. | ||
| 630 | xwiki.tags=1 | ||
| 631 | |||
| 632 | |||
| 633 | #--------------------------------------- | ||
| 634 | # Storage | ||
| 635 | # | ||
| 636 | |||
| 637 | #-# Role hints that differentiate implementations of the various storage components. To add a new implementation for one | ||
| 638 | #-# of the storages, implement the appropriate interface and declare it in a components.xml file (using a role-hint other | ||
| 639 | #-# than 'default') and put its hint here. | ||
| 640 | # | ||
| 641 | #-# The main (documents) storage. | ||
| 642 | # xwiki.store.main.hint=default | ||
| 643 | #-# The attachment storage. | ||
| 644 | # xwiki.store.attachment.hint=default | ||
| 645 | #-# The document versioning storage. | ||
| 646 | # xwiki.store.versioning.hint=default | ||
| 647 | #-# The attachment versioning storage. Use 'void' to disable attachment versioning. | ||
| 648 | # xwiki.store.attachment.versioning.hint=default | ||
| 649 | #-# The document recycle bin storage. | ||
| 650 | # xwiki.store.recyclebin.hint=default | ||
| 651 | #-# The attachment recycle bin storage. | ||
| 652 | # xwiki.store.attachment.recyclebin.hint=default | ||
| 653 | |||
| 654 | #-# Whether the document recycle bin feature is activated or not | ||
| 655 | # xwiki.recyclebin=1 | ||
| 656 | #-# Whether the attachment recycle bin feature is activated or not | ||
| 657 | # storage.attachment.recyclebin=1 | ||
| 658 | #-# Whether the document versioning feature is activated or not | ||
| 659 | # xwiki.store.versioning=1 | ||
| 660 | #-# Whether the attachment versioning feature is activated or not | ||
| 661 | # xwiki.store.attachment.versioning=1 | ||
| 662 | #-# Whether the attachments should also be rolled back when a document is reverted. | ||
| 663 | # xwiki.store.rollbackattachmentwithdocuments=1 | ||
| 664 | |||
| 665 | #-# The path to the hibernate configuration file. | ||
| 666 | # xwiki.store.hibernate.path=/WEB-INF/hibernate.cfg.xml | ||
| 667 | |||
| 668 | #-# Whether to update the database schema on startup. Useful when upgrading XWiki. as the mapping could change between | ||
| 669 | #-# versions, and this allows to automatically update the database. Should be disabled (=0) during normal operation to | ||
| 670 | #-# improve the startup time. | ||
| 671 | # xwiki.store.hibernate.updateschema=1 | ||
| 672 | |||
| 673 | #-# Allow or disable custom mapping for particular XClasses. Custom mapping may increase the performance of certain | ||
| 674 | #-# queries when large number of objects from particular classes are used in the wiki. | ||
| 675 | # xwiki.store.hibernate.custommapping=1 | ||
| 676 | #-# Dynamic custom mapping. | ||
| 677 | # xwiki.store.hibernate.custommapping.dynamic=0 | ||
| 678 | |||
| 679 | #-# Put a cache in front of the document store. This greatly improves performance at the cost of memory consumption. | ||
| 680 | #-# Disable only when memory is critical. | ||
| 681 | # xwiki.store.cache=1 | ||
| 682 | |||
| 683 | #-# Maximum number of documents to keep in the cache. | ||
| 684 | # xwiki.store.cache.capacity=100 | ||
| 685 | |||
| 686 | #-# [Since 1.6M1] | ||
| 687 | #-# Force the database name for the main wiki in virtual mode and for the wiki itself in non virtual mode. | ||
| 688 | # xwiki.db=xwiki | ||
| 689 | |||
| 690 | #-# [Since 1.6M1] | ||
| 691 | #-# Add a prefix to all databases names of the wikis in virtual mode and to the wiki name in non virtual mode. | ||
| 692 | # xwiki.db.prefix= | ||
| 693 | |||
| 694 | |||
| 695 | #--------------------------------------- | ||
| 696 | # Data migrations | ||
| 697 | # | ||
| 698 | # Similar to schema updates, this manipulates the actual data, and not just the layout of the database. Useful for | ||
| 699 | # migrating data to new formats, correct errors introduced in older versions, or even for schema updates that are not | ||
| 700 | # handled by velocity. | ||
| 701 | |||
| 702 | #-# Whether migrations are enabled or not. Should be enabled when upgrading, but for a better startup time it is better to | ||
| 703 | #-# disable them in production. | ||
| 704 | xwiki.store.migration=1 | ||
| 705 | |||
| 706 | #-# Migration manager class. The default works with a Hibernate storage. | ||
| 707 | # xwiki.store.migration.manager.class=com.xpn.xwiki.store.migration.hibernate.XWikiHibernateMigrationManager | ||
| 708 | |||
| 709 | #-# Whether to exit after migration. Useful when a server should handle migrations for a large database, without going | ||
| 710 | #-# live afterwards. | ||
| 711 | # xwiki.store.migration.exitAfterEnd=0 | ||
| 712 | |||
| 713 | #-# Indicate the list of databases to migrate. | ||
| 714 | #-# to upgrade all wikis database set xwiki.store.migration.databases=all | ||
| 715 | #-# to upgrade just some wikis databases set xwiki.store.migration.databases=xwiki,wiki1,wiki2 | ||
| 716 | #-# Note: the main wiki is always migrated whatever the configuration. | ||
| 717 | # xwiki.store.migration.databases= | ||
| 718 | |||
| 719 | #--------------------------------------- | ||
| 720 | # Internationalization | ||
| 721 | # | ||
| 722 | |||
| 723 | #-# By default, XWiki chooses the language specified by the client (browser) in the Accept-Language HTTP header. This | ||
| 724 | #-# allows to use the default language of the wiki when the user didn't manually choose a language. | ||
| 725 | # xwiki.language.preferDefault=0 | ||
| 726 | |||
| 727 | #-# Force only one of the supported languages to be accepted. | ||
| 728 | # xwiki.language.forceSupported=0 | ||
| 729 | |||
| 730 | |||
| 731 | #--------------------------------------- | ||
| 732 | # Virtual wikis (farm) | ||
| 733 | # | ||
| 734 | |||
| 735 | #-# This parameter allows XWiki to operate in Hosting mode allowing to create multiple wikis having their own database and | ||
| 736 | #-# responding to different URLs | ||
| 737 | xwiki.virtual=0 | ||
| 738 | |||
| 739 | #-# URL to redirect to when a requested wiki does not exist. This should be changed to a real page. | ||
| 740 | xwiki.virtual.redirect=http://127.0.0.1:9080/xwiki/bin/Main/ThisWikiDoesNotExist | ||
| 741 | |||
| 742 | #-# Forbidden names that should not be allowed when creating a new wiki. | ||
| 743 | # xwiki.virtual.reserved_wikis= | ||
| 744 | |||
| 745 | #-# How virtual wikis are mapped to different URLs. If set to 0 (the default), then virtual wikis have different domain | ||
| 746 | #-# names, in the format http://wikiname.myfarm.net/. If set to 1, then the domain is common for the entire farm, but the | ||
| 747 | #-# path contains the wiki name, in the format http://myfarm.net/xwiki/wiki/wikiname/. | ||
| 748 | #-# Note that you can configure the "/wiki/" part with xwiki.virtual.usepath.servletpath property. | ||
| 749 | # xwiki.virtual.usepath=0 | ||
| 750 | |||
| 751 | #-# Configure the servlet action identifier for url path based multiwiki. It has also to be modified in web.xml. | ||
| 752 | # xwiki.virtual.usepath.servletpath=wiki | ||
| 753 | |||
| 754 | #--------------------------------------- | ||
| 755 | # URLs | ||
| 756 | # | ||
| 757 | |||
| 758 | #-# The domain name to use when creating URLs to the default wiki. If set, the generated URLs will point to this server | ||
| 759 | #-# instead of the requested one. It should contain schema, domain and (optional) port, and the trailing /. For example: | ||
| 760 | #-# xwiki.home=http://www.xwiki.org/ | ||
| 761 | #-# xwiki.home=http://wiki.mycompany.net:8080/ | ||
| 762 | # xwiki.home= | ||
| 763 | |||
| 764 | #-# The name of the default URL factory that should be used. | ||
| 765 | # xwiki.urlfactory.serviceclass=com.xpn.xwiki.web.XWikiURLFactoryServiceImpl | ||
| 766 | |||
| 767 | #-# Force the protocol to use in the generated URLs. The right value is taken from the request URL, so setting this | ||
| 768 | #-# is not recommended in most cases. | ||
| 769 | #-# For example: | ||
| 770 | #-# xwiki.url.protocol=https | ||
| 771 | # xwiki.url.protocol= | ||
| 772 | #-# The name of the webapp to use in the generated URLs. The right value is taken from the request URL, so setting this | ||
| 773 | #-# is not recommended in most cases. If set, the value should contain a trailing /, but not a leading one. For example: | ||
| 774 | #-# xwiki.webapppath=xwiki/ | ||
| 775 | # xwiki.webapppath= | ||
| 776 | #-# The default servlet mapping name to use in the generated URLs. The right value is taken from the request URL, | ||
| 777 | #-# preserving the requested servlet mapping, so setting this is not recommended in most cases. If set, the value should | ||
| 778 | #-# contain a trailing /, but not a leading one. For example: | ||
| 779 | #-# xwiki.servletpath=bin/ | ||
| 780 | # xwiki.servletpath= | ||
| 781 | #-# The fallback servlet mapping name to use in the generated URLs. Unlike xwiki.servletpath, this is the value used when | ||
| 782 | #-# the correct setting could not be determined from the request URL. A good way to use this setting is to achieve short | ||
| 783 | #-# URLs, see http://platform.xwiki.org/xwiki/bin/Main/ShortURLs | ||
| 784 | # xwiki.defaultservletpath=bin/ | ||
| 785 | |||
| 786 | #-# Whether the /view/ part of the URL should be included if the target action is 'view'. | ||
| 787 | # xwiki.showviewaction=1 | ||
| 788 | #-# The name of the default space. This is displayed when the URL specifies a document, but not a space, or neither. | ||
| 789 | # xwiki.defaultweb=Main | ||
| 790 | #-# Hide the /Space/ part of the URL when the space is the default one. Warning: use 1 to hide, 0 to show. | ||
| 791 | # xwiki.usedefaultweb=0 | ||
| 792 | #-# The name of the default page of a space. This is displayed when the URL specifies a space, but not a document, or neither. | ||
| 793 | # xwiki.defaultpage=WebHome | ||
| 794 | #-# Hide the /WebHome part of the URL when the document is the default one. Use 0 to hide, 1 to show. | ||
| 795 | # xwiki.usedefaultaction=0 | ||
| 796 | |||
| 797 | |||
| 798 | #--------------------------------------- | ||
| 799 | # Users | ||
| 800 | # | ||
| 801 | |||
| 802 | xwiki.inactiveuser.allowedpages= | ||
| 803 | |||
| 804 | |||
| 805 | #--------------------------------------- | ||
| 806 | # Authentication and authorization | ||
| 807 | # | ||
| 808 | |||
| 809 | #-# Enable to allow superadmin. It is disabled by default as this could be a | ||
| 810 | #-# security breach if it were set and you forgot about it. Should only be enabled | ||
| 811 | #-# for recovering the Wiki when the rights are completely messed. | ||
| 812 | # xwiki.superadminpassword=system | ||
| 813 | |||
| 814 | #-# Authentication type. You can use 'basic' to always use basic authentication. | ||
| 815 | # xwiki.authentication=form | ||
| 816 | |||
| 817 | #-# Indicate if the authentication has do be done for each request | ||
| 818 | #-# 0: the default value, authentication is done only once by session. | ||
| 819 | #-# 1: the authentication is done for each request. | ||
| 820 | # xwiki.authentication.always=0 | ||
| 821 | |||
| 822 | #-# Cookie encryption keys. You SHOULD replace these values with any random string, | ||
| 823 | #-# as long as the length is the same. | ||
| 824 | xwiki.authentication.validationKey=totototototototototototototototo | ||
| 825 | xwiki.authentication.encryptionKey=titititititititititititititititi | ||
| 826 | |||
| 827 | #-# Comma separated list of domains for which authentication cookies are set. This | ||
| 828 | #-# concerns mostly wiki farms. The exact meaning is that when a user logs in, if | ||
| 829 | #-# the current domain name corresponding to the wiki ends with one of the entries | ||
| 830 | #-# in this parameter, then the cookie is set for the larger domain. Otherwise, it | ||
| 831 | #-# is set for the exact domain name of the wiki. | ||
| 832 | #-# | ||
| 833 | #-# For example, suppose the cookiedomains is set to "mydomain.net". If I log in | ||
| 834 | #-# on wiki1.xwiki.com, then the cookie will be set for the entire mydomain.net | ||
| 835 | #-# domain, and if I visit wiki2.xwiki.com I will still be authenticated. If I log | ||
| 836 | #-# in on wiki1.otherdomain.net, then I will only be authenticated on | ||
| 837 | #-# wiki1.otherdomain.net, and not on wiki2.otherdomain.net. | ||
| 838 | #-# | ||
| 839 | #-# So you need this parameter set only for global authentication in a | ||
| 840 | #-# farm, there's no need to specify your domain name otherwise. | ||
| 841 | #-# | ||
| 842 | #-# Example: xwiki.authentication.cookiedomains=xwiki.org,myxwiki.org | ||
| 843 | xwiki.authentication.cookiedomains= | ||
| 844 | |||
| 845 | #-# This allows logout to happen for any page going through the /logout/ action, regardless of the document or the servlet. | ||
| 846 | #-# Comment-out if you want to enable logout only for /bin/logout/XWiki/XWikiLogout | ||
| 847 | #-# Currently accepted patterns: | ||
| 848 | #-# - /StrutsServletName/logout/ (this is usually /bin/logout/ and is the default setup) | ||
| 849 | #-# - /logout/ (this works with the short URLs configuration) | ||
| 850 | #-# - /wiki/SomeWikiName/logout/ (this works with path-based virtual wikis) | ||
| 851 | xwiki.authentication.logoutpage=(/|/[^/]+/|/wiki/[^/]+/)logout/* | ||
| 852 | |||
| 853 | #-# The group management class. | ||
| 854 | # xwiki.authentication.groupclass=com.xpn.xwiki.user.impl.xwiki.XWikiGroupServiceImpl | ||
| 855 | #-# Default value for exo: | ||
| 856 | # xwiki.authentication.groupclass=com.xpn.xwiki.user.impl.exo.ExoGroupServiceImpl | ||
| 857 | |||
| 858 | #-# The authentication management class. | ||
| 859 | # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.XWikiAuthServiceImpl | ||
| 860 | #-# Default value for exo: | ||
| 861 | # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.exo.ExoAuthServiceImpl | ||
| 862 | #-# Default value for LDAP: | ||
| 863 | # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl | ||
| 864 | |||
| 865 | #-# The authorization management class. | ||
| 866 | # xwiki.authentication.rightsclass=com.xpn.xwiki.user.impl.xwiki.XWikiRightServiceImpl | ||
| 867 | |||
| 868 | #-# If an unauthenticated user (guest) tries to perform a restricted action, by default the wiki redirects to the login | ||
| 869 | #-# page. Enable this to simply display an "unauthorized" message instead, to hide the login form. | ||
| 870 | # xwiki.hidelogin=false | ||
| 871 | |||
| 872 | #-# HTTP status code to sent when the authentication failed. | ||
| 873 | xwiki.authentication.unauthorized_code=200 | ||
| 874 | |||
| 875 | |||
| 876 | #--------------------------------------- | ||
| 877 | # Rendering | ||
| 878 | # | ||
| 879 | |||
| 880 | #-# Disable particular renderers (in the old rendering engine). | ||
| 881 | #-# Macro mapping | ||
| 882 | # xwiki.render.macromapping=1 | ||
| 883 | #-# Velocity interpreter | ||
| 884 | # xwiki.render.velocity=1 | ||
| 885 | #-# Groovy interpreter | ||
| 886 | # xwiki.render.groovy=1 | ||
| 887 | #-# Plugin rendering | ||
| 888 | # xwiki.render.plugin=1 | ||
| 889 | #-# Radeox wiki renderer | ||
| 890 | # xwiki.render.wiki=1 | ||
| 891 | #-# Simple wiki syntax rendering | ||
| 892 | # xwiki.render.wikiwiki=0 | ||
| 893 | |||
| 894 | #-# Maximum number of documents to keep in the rendered cache | ||
| 895 | # xwiki.render.cache.capacity=100 | ||
| 896 | |||
| 897 | #-# Default target for external links. Use _blank to open external links in a new tab/window. | ||
| 898 | # xwiki.render.externallinks.defaulttarget= | ||
| 899 | |||
| 900 | |||
| 901 | #--------------------------------------- | ||
| 902 | # Editing | ||
| 903 | # | ||
| 904 | |||
| 905 | #-# Minor edits don't participate in notifications. | ||
| 906 | # xwiki.minoredit=1 | ||
| 907 | |||
| 908 | #-# Use edit comments | ||
| 909 | xwiki.editcomment=1 | ||
| 910 | |||
| 911 | #-# Hide editcomment field and only use Javascript | ||
| 912 | # xwiki.editcomment.hidden=0 | ||
| 913 | |||
| 914 | #-# Make edit comment mandatory | ||
| 915 | xwiki.editcomment.mandatory=0 | ||
| 916 | |||
| 917 | #-# Make edit comment suggested (asks 1 time if the comment is empty. | ||
| 918 | #-# 1 shows one popup if comment is empty. | ||
| 919 | #-# 0 means there is no popup. | ||
| 920 | #-# This setting is ignored if mandatory is set | ||
| 921 | # xwiki.editcomment.suggested=0 | ||
| 922 | |||
| 923 | |||
| 924 | #------------------------------------------------------------------------------------- | ||
| 925 | # LDAP | ||
| 926 | #------------------------------------------------------------------------------------- | ||
| 927 | |||
| 928 | #-# new LDAP authentication service | ||
| 929 | # xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl | ||
| 930 | |||
| 931 | #-# Turn LDAP authentication on - otherwise only XWiki authentication | ||
| 932 | #-# 0: disable | ||
| 933 | #-# 1: enable | ||
| 934 | # xwiki.authentication.ldap=1 | ||
| 935 | |||
| 936 | #-# LDAP Server (Active Directory, eDirectory, OpenLDAP, etc.) | ||
| 937 | xwiki.authentication.ldap.server=127.0.0.1 | ||
| 938 | xwiki.authentication.ldap.port=389 | ||
| 939 | |||
| 940 | #-# LDAP login, empty = anonymous access, otherwise specify full dn | ||
| 941 | #-# {0} is replaced with the username, {1} with the password | ||
| 942 | xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP | ||
| 943 | xwiki.authentication.ldap.bind_pass={1} | ||
| 944 | |||
| 945 | #-# Force to check password after LDAP connection | ||
| 946 | #-# 0: disable | ||
| 947 | #-# 1: enable | ||
| 948 | xwiki.authentication.ldap.validate_password=0 | ||
| 949 | |||
| 950 | #-# only members of the following group will be verified in the LDAP | ||
| 951 | #-# otherwise only users that are found after searching starting from the base_DN | ||
| 952 | # xwiki.authentication.ldap.user_group=cn=developers,ou=groups,o=MegaNova,c=US | ||
| 953 | |||
| 954 | #-# [Since 1.5RC1, XWikiLDAPAuthServiceImpl] | ||
| 955 | #-# only users not member of the following group can autheticate | ||
| 956 | # xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US | ||
| 957 | |||
| 958 | #-# base DN for searches | ||
| 959 | xwiki.authentication.ldap.base_DN= | ||
| 960 | |||
| 961 | #-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name (default=cn) | ||
| 962 | # xwiki.authentication.ldap.UID_attr=cn | ||
| 963 | |||
| 964 | #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl] | ||
| 965 | #-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password" is set to 1 | ||
| 966 | # xwiki.authentication.ldap.password_field=userPassword | ||
| 967 | |||
| 968 | #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl] | ||
| 969 | #-# The potential LDAP groups classes. Separated by commas. | ||
| 970 | # xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList | ||
| 971 | |||
| 972 | #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl] | ||
| 973 | #-# The potential names of the LDAP groups fields containings the members. Separated by commas. | ||
| 974 | # xwiki.authentication.ldap.group_memberfields=member,uniqueMember | ||
| 975 | |||
| 976 | #-# retrieve the following fields from LDAP and store them in the XWiki user object (xwiki-attribute=ldap-attribute) | ||
| 977 | xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,email=mail | ||
| 978 | |||
| 979 | #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl] | ||
| 980 | #-# on every login update the mapped attributes from LDAP to XWiki otherwise this happens only once when the XWiki account is created. | ||
| 981 | xwiki.authentication.ldap.update_user=1 | ||
| 982 | |||
| 983 | #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl] | ||
| 984 | #-# mapps XWiki groups to LDAP groups, separator is "|" | ||
| 985 | # xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=AdminRole,ou=groups,o=MegaNova,c=US|\ | ||
| 986 | # XWiki.Organisation=cn=testers,ou=groups,o=MegaNova,c=US | ||
| 987 | |||
| 988 | #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl] | ||
| 989 | #-# time in s after which the list of members in a group is refreshed from LDAP (default=3600*6) | ||
| 990 | # xwiki.authentication.ldap.groupcache_expiration=21800 | ||
| 991 | |||
| 992 | #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl] | ||
| 993 | #-# - create : synchronize group membership only when the user is first created | ||
| 994 | #-# - always: synchronize on every login | ||
| 995 | # xwiki.authentication.ldap.mode_group_sync=always | ||
| 996 | |||
| 997 | #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl] | ||
| 998 | #-# if ldap authentication fails for any reason, try XWiki DB authentication with the same credentials | ||
| 999 | xwiki.authentication.ldap.trylocal=1 | ||
| 1000 | |||
| 1001 | #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl] | ||
| 1002 | #-# SSL connection to LDAP server | ||
| 1003 | #-# 0: normal | ||
| 1004 | #-# 1: SSL | ||
| 1005 | # xwiki.authentication.ldap.ssl=0 | ||
| 1006 | |||
| 1007 | #-# [Since 1.3M2, XWikiLDAPAuthServiceImpl] | ||
| 1008 | #-# The keystore file to use in SSL connection | ||
| 1009 | # xwiki.authentication.ldap.ssl.keystore= | ||
| 1010 | |||
| 1011 | #-# [Since 1.5M1, XWikiLDAPAuthServiceImpl] | ||
| 1012 | #-# The java secure provider used in SSL connection | ||
| 1013 | # xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider | ||
| 1014 | |||
| 1015 | |||
| 1016 | #--------------------------------------- | ||
| 1017 | # Cache | ||
| 1018 | # [DEPRECATED since 1.7M1: this way to configure cache provider is deprecated, you should use xwiki.properties instead.] | ||
| 1019 | #--------------------------------------- | ||
| 1020 | |||
| 1021 | #-# [Since 1.5M2] | ||
| 1022 | #-# The cache component implementation to use as "normal" (can be local or distributed depending on the implementation) | ||
| 1023 | #-# cache component. | ||
| 1024 | # xwiki.cache.cachefactory.hint=jbosscache | ||
| 1025 | |||
| 1026 | #-# [Since 1.5M2] | ||
| 1027 | #-# The cache component to use as local cache component. | ||
| 1028 | # xwiki.cache.cachefactory.local.hint=jbosscache/local | ||
| 1029 | |||
| 1030 | |||
| 1031 | #--------------------------------------- | ||
| 1032 | # WYSIWYG Editor configuration | ||
| 1033 | # | ||
| 1034 | |||
| 1035 | #-# You can configure the toolbars you wish to see in the WYSIWYG editor by defining the | ||
| 1036 | #-# xwiki.wysiwyg.toolbars property. | ||
| 1037 | #-# When not defined it defaults to: | ||
| 1038 | # xwiki.wysiwyg.toolbars=texttoolbar, listtoolbar, indenttoolbar, undotoolbar, titletoolbar, \ | ||
| 1039 | # styletoolbar, horizontaltoolbar, attachmenttoolbar, macrostoolbar, \ | ||
| 1040 | # tabletoolbar, tablerowtoolbar, tablecoltoolbar, linktoolbar | ||
| 1041 | #-# The full list of toolbars includes the one defined above and the following ones: | ||
| 1042 | #-# subtoolbar, findtoolbar, symboltoolbar | ||
| 1043 | |||
| 1044 | |||
| 1045 | #--------------------------------------- | ||
| 1046 | # Skins & Templates configuration | ||
| 1047 | # | ||
| 1048 | |||
| 1049 | #-# The default skin to use when there's no value specified in the wiki preferences document. Note that the default | ||
| 1050 | #-# wiki already specifies a skin, so this setting is only valid for empty wikis. | ||
| 1051 | xwiki.defaultskin=colibri | ||
| 1052 | |||
| 1053 | #-# The default base for skins that don't specify a base skin. This is also the last place where a skin file is searched | ||
| 1054 | #-# if not found in the more specific skins. | ||
| 1055 | xwiki.defaultbaseskin=albatross | ||
| 1056 | |||
| 1057 | #-# Defines whether title handling should be using the compatibility mode or not. When the compatibility | ||
| 1058 | #-# mode is active, if the document's content first header (level 1 or level 2) matches the document's title | ||
| 1059 | #-# the first header is stripped. | ||
| 1060 | xwiki.title.compatibility=1 | ||
| 1061 | |||
| 1062 | #--------------------------------------- | ||
| 1063 | # Extensions | ||
| 1064 | # | ||
| 1065 | |||
| 1066 | #-# List of active plugins. | ||
| 1067 | xwiki.plugins=\ | ||
| 1068 | com.xpn.xwiki.monitor.api.MonitorPlugin,\ | ||
| 1069 | com.xpn.xwiki.plugin.skinx.JsSkinExtensionPlugin,\ | ||
| 1070 | com.xpn.xwiki.plugin.skinx.JsSkinFileExtensionPlugin,\ | ||
| 1071 | com.xpn.xwiki.plugin.skinx.CssSkinExtensionPlugin,\ | ||
| 1072 | com.xpn.xwiki.plugin.skinx.CssSkinFileExtensionPlugin,\ | ||
| 1073 | com.xpn.xwiki.plugin.feed.FeedPlugin,\ | ||
| 1074 | com.xpn.xwiki.plugin.ldap.LDAPPlugin,\ | ||
| 1075 | com.xpn.xwiki.plugin.google.GooglePlugin,\ | ||
| 1076 | com.xpn.xwiki.plugin.flickr.FlickrPlugin,\ | ||
| 1077 | com.xpn.xwiki.plugin.mail.MailPlugin,\ | ||
| 1078 | com.xpn.xwiki.plugin.packaging.PackagePlugin,\ | ||
| 1079 | com.xpn.xwiki.plugin.query.QueryPlugin,\ | ||
| 1080 | com.xpn.xwiki.plugin.svg.SVGPlugin,\ | ||
| 1081 | com.xpn.xwiki.plugin.charts.ChartingPlugin,\ | ||
| 1082 | com.xpn.xwiki.plugin.fileupload.FileUploadPlugin,\ | ||
| 1083 | com.xpn.xwiki.plugin.image.ImagePlugin,\ | ||
| 1084 | com.xpn.xwiki.plugin.userdirectory.UserDirectoryPlugin,\ | ||
| 1085 | com.xpn.xwiki.plugin.usertools.XWikiUserManagementToolsImpl,\ | ||
| 1086 | com.xpn.xwiki.plugin.zipexplorer.ZipExplorerPlugin,\ | ||
| 1087 | com.xpn.xwiki.plugin.autotag.AutoTagPlugin,\ | ||
| 1088 | com.xpn.xwiki.plugin.lucene.LucenePlugin,\ | ||
| 1089 | com.xpn.xwiki.plugin.diff.DiffPlugin,\ | ||
| 1090 | com.xpn.xwiki.plugin.rightsmanager.RightsManagerPlugin,\ | ||
| 1091 | com.xpn.xwiki.plugin.jodatime.JodaTimePlugin,\ | ||
| 1092 | com.xpn.xwiki.plugin.scheduler.SchedulerPlugin,\ | ||
| 1093 | com.xpn.xwiki.plugin.mailsender.MailSenderPlugin,\ | ||
| 1094 | com.xpn.xwiki.plugin.activitystream.plugin.ActivityStreamPlugin, \ | ||
| 1095 | com.xpn.xwiki.plugin.watchlist.WatchListPlugin, \ | ||
| 1096 | com.xpn.xwiki.wysiwyg.server.plugin.WysiwygPlugin, \ | ||
| 1097 | com.xpn.xwiki.plugin.tag.TagPlugin | ||
| 1098 | |||
| 1099 | #-# Enable light monitoring of the wiki performance. Records various statistics, like number of requests processed, | ||
| 1100 | #-# time spent in rendering or in the database, medium time for a request, etc. Disable for a minor increase of | ||
| 1101 | #-# performance and a bit of memory. | ||
| 1102 | # xwiki.monitor=1 | ||
| 1103 | |||
| 1104 | #-# Maximum number of last requests to remember. | ||
| 1105 | # xwiki.monitor.lastlistsize=20 | ||
| 1106 | |||
| 1107 | #-# Stats configuration allows to globally activate/deactivate stats module (launch storage thread, register events...). | ||
| 1108 | #-# Enabled by default. | ||
| 1109 | # xwiki.stats=1 | ||
| 1110 | #-# When statistics are globally enabled, storage can be enabled/disabled by wiki using the XWikiPreference property "statistics". | ||
| 1111 | #-# Note: Statistics are disabled by default for improved performances/space. | ||
| 1112 | xwiki.stats.default=0 | ||
| 1113 | #-# It is also possible to choose a different stats service to record statistics separately from XWiki. | ||
| 1114 | # xwiki.stats.class=com.xpn.xwiki.stats.impl.XWikiStatsServiceImpl | ||
| 1115 | |||
| 1116 | #-# This parameter will activate the eXo Platform integration | ||
| 1117 | xwiki.exo=0 | ||
| 1118 | |||
| 1119 | #-# GraphViz plugin configuration. The GraphViz plugin is not configured by default. | ||
| 1120 | #-# To enable it, add "com.xpn.xwiki.plugin.graphviz.GraphVizPlugin" to the list of plugins | ||
| 1121 | #-# in the xwiki.plugins property. | ||
| 1122 | #-# Uncomment and set the locations of the Dot and Neato executables | ||
| 1123 | # xwiki.plugin.graphviz.dotpath=c:/Program Files/ATT/GraphViz/bin/dot.exe | ||
| 1124 | # xwiki.plugin.graphviz.neatopath=c:/Program Files/ATT/GraphViz/bin/neato.exe | ||
| 1125 | |||
| 1126 | xwiki.plugin.laszlo.baseurl=/openlaszlo/xwiki/ | ||
| 1127 | xwiki.plugin.laszlo.path=c:/Program Files/Apache Software Foundation/Tomcat 5.0/webapps/openlaszlo/xwiki/ | ||
| 1128 | |||
| 1129 | xwiki.plugin.image.cache.capacity=30 | ||
| 1130 | |||
| 1131 | #-# Calendar Prev/Next Month bounds. | ||
| 1132 | #-# The calendar generates links to the previous/next months for a limited range, by default 6 months back and 12 months | ||
| 1133 | #-# after. A value of 0 means that there is no limit in that direction. | ||
| 1134 | # xwiki.calendar.bound.prev=6 | ||
| 1135 | # xwiki.calendar.bound.next=12 | ||
| 1136 | |||
| 1137 | #-# Lucene search engine | ||
| 1138 | #-# Location where to place the lucene index files. The default is the "lucene" subdirectory in the container's "work" | ||
| 1139 | #-# diectory. Change it if you want to store indexes in another place. | ||
| 1140 | # xwiki.plugins.lucene.indexdir=/usr/local/xwiki/lucene | ||
| 1141 | #-# The text analyzer to use for indexing. | ||
| 1142 | # xwiki.plugins.lucene.analyzer=org.apache.lucene.analysis.standard.StandardAnalyzer | ||
| 1143 | #-# The number of seconds to wait between reindexes. A smaller value ensures that new documents will be indexed faster, | ||
| 1144 | #-# but with a minor performance reduction. Adjust according to your wiki load. | ||
| 1145 | # xwiki.plugins.lucene.indexinterval=20 | ||
| 1146 | #-# The maximum size of the indexing queue. After this limit is reached, the reindex thread will have to wait until the | ||
| 1147 | #-# queue is consumed. Note that this does not affect documents submitted through the notification mechanism, only the | ||
| 1148 | #-# full reindex option. | ||
| 1149 | # xwiki.plugins.lucene.maxQueueSize=1000 | ||
| 1150 | |||
| 1151 | #-# [Since 2.0RC1] | ||
| 1152 | #-# Activity Stream plugin. | ||
| 1153 | #-# The Activity Stream plugin stores data in a dedicated table in the database. In virtual mode each wiki has it's own | ||
| 1154 | #-# database, the plugin can be configured to store its data into the database corresponding to the wiki, into the main | ||
| 1155 | #-# database (default: xwiki) or both. If the wiki is not running in virtual mode these options will not have any | ||
| 1156 | #-# effect. These options should not be both set to 0 (in this case the local store will be forced). | ||
| 1157 | #-# Important note: disabling storage in the main store will prevent the watchlist from retrieving events from subwikis. | ||
| 1158 | #-# | ||
| 1159 | #-# Default: 1 | ||
| 1160 | # xwiki.plugin.activitystream.uselocalstore=1 | ||
| 1161 | #-# | ||
| 1162 | #-# Default: 1 | ||
| 1163 | # xwiki.plugin.activitystream.usemainstore=1 | ||
| 1164 | #-# | ||
| 1165 | #-# Number of days the events should be kept (0 or any negative value: infinite duration) | ||
| 1166 | #-# Note: if this value is greater than 0 a scheduler job will be created, this job will then be fired every week to | ||
| 1167 | #-# delete events older than the configured value. | ||
| 1168 | #-# Default: 0 | ||
| 1169 | # xwiki.plugin.activitystream.daystokeepevents=0 | ||
| 1170 | {{/code}} | ||
| 1171 | |||
| 1172 | = Sample xwiki.properties = | ||
| 1173 | |||
| 1174 | {{code language="none"}} | ||
| 1175 | # This is the new XWiki configuration file. In the future it'll replace the old | ||
| 1176 | # xwiki.cfg file. However right now it's only used by some XWiki components. | ||
| 1177 | # As time progresses more and more component will get their configurations from | ||
| 1178 | # this file. | ||
| 1179 | |||
| 1180 | #------------------------------------------------------------------------------------- | ||
| 1181 | # Core | ||
| 1182 | #------------------------------------------------------------------------------------- | ||
| 1183 | |||
| 1184 | #-# [Since 1.8RC2] | ||
| 1185 | #-# Specifies the default syntax to use when creating new documents. | ||
| 1186 | #-# Default value is xwiki/2.0. | ||
| 1187 | # core.defaultDocumentSyntax = xwiki/1.0 | ||
| 1188 | |||
| 1189 | #------------------------------------------------------------------------------------- | ||
| 1190 | # Rendering | ||
| 1191 | #------------------------------------------------------------------------------------- | ||
| 1192 | |||
| 1193 | #-# [Since 1.8RC2] | ||
| 1194 | #-# Specifies how links labels are displayed when the user doesn't specify the label explicitely. | ||
| 1195 | #-# Valid values: | ||
| 1196 | #-# %w: wiki name | ||
| 1197 | #-# %s: space name | ||
| 1198 | #-# %p: page name | ||
| 1199 | #-# %P: page name with spaces between camel case words, i.e. "My Page" iff the page name is "MyPage" | ||
| 1200 | #-# %t: page title | ||
| 1201 | #-# | ||
| 1202 | #-# Note that if the page title is empty or not defined then it defaults to %p. This is also the case | ||
| 1203 | #-# if the title cannot be retrieved for the document. | ||
| 1204 | #-# | ||
| 1205 | #-# The default is "%p". Some examples: "%s.%p", "%w:%s.%p". | ||
| 1206 | # rendering.linkLabelFormat = %p | ||
| 1207 | |||
| 1208 | #-# [Since 2.0M3] | ||
| 1209 | #-# Overrides default macro categories (Each macro has a default category already defined, for example | ||
| 1210 | #-# "presentation" for the Table of Contents Macro). | ||
| 1211 | #-# | ||
| 1212 | #-# Ex: To redefine the macro category for the TOC macro so that it'd be in the "My Category" category + | ||
| 1213 | #-# redefine the category for the Script Macro to be "My Other Category", you'd use: | ||
| 1214 | # rendering.macroCategories = toc:My Category | ||
| 1215 | # rendering.macroCategories = script:My Other Category | ||
| 1216 | |||
| 1217 | #------------------------------------------------------------------------------------- | ||
| 1218 | # Cache | ||
| 1219 | #------------------------------------------------------------------------------------- | ||
| 1220 | |||
| 1221 | #-# [Since 1.7M1] | ||
| 1222 | #-# The standard cache component implementation to use (can be local or distributed depending on the implementation). | ||
| 1223 | #-# The default standard cache implementation is JBoss Cache. | ||
| 1224 | # cache.defaultCache=jbosscache | ||
| 1225 | |||
| 1226 | #-# [Since 1.7M1] | ||
| 1227 | #-# The local cache implementation to use. | ||
| 1228 | #-# The default local cache implementation is JBoss Cache. | ||
| 1229 | # cache.defaultLocalCache=jbosscache/local | ||
| 1230 | |||
| 1231 | #---------------------------------------------------------------------------------- | ||
| 1232 | # Settings for the OpenOffice server instance consumed by the OfficeImporter plugin | ||
| 1233 | #---------------------------------------------------------------------------------- | ||
| 1234 | |||
| 1235 | #-# [Since 1.9M2] | ||
| 1236 | #-# Type of the openoffice server instance used by officeimporter plugin. | ||
| 1237 | #-# 0 - Internally managed server instance. (Default) | ||
| 1238 | #-# 1 - Externally managed (local) server instance. | ||
| 1239 | # openoffice.serverType=0 | ||
| 1240 | |||
| 1241 | #-# [Since 1.9M2] | ||
| 1242 | #-# Port number used for connecting to the openoffice server instance. | ||
| 1243 | #-# Default port is 8100 | ||
| 1244 | # openoffice.serverPort=8100 | ||
| 1245 | |||
| 1246 | #-# [Since 1.9M2] | ||
| 1247 | #-# If the openoffice server should be started / connected upon XE start. | ||
| 1248 | #-# Default value is false | ||
| 1249 | # openoffice.autoStart=false | ||
| 1250 | |||
| 1251 | #-# [Since 1.8RC3] | ||
| 1252 | #-# Path to openoffice installation (serverType:0 only). | ||
| 1253 | #-# If no path is provided, a default value will be calculated based on the operating environment. | ||
| 1254 | # openoffice.homePath=/opt/openoffice.org3/ | ||
| 1255 | |||
| 1256 | #-# [Since 1.8RC3] | ||
| 1257 | #-# Path to openoffice execution profile (serverType:0 only). | ||
| 1258 | #-# If no path is provided, a default value will be calculated based on the operating environment. | ||
| 1259 | # openoffice.profilePath=/home/user/.openoffice.org/3 | ||
| 1260 | |||
| 1261 | #-# [Since 1.8RC3] | ||
| 1262 | #-# Maximum number of simultaneous conversion tasks to be handled by a single openoffice process (serverType:0 only). | ||
| 1263 | #-# Default value is 50 | ||
| 1264 | # openoffice.maxTasksPerProcess=50 | ||
| 1265 | |||
| 1266 | #-# [Since 1.8RC3] | ||
| 1267 | #-# Timeout for conversion tasks (in miliseconds) (serverType:0 only). | ||
| 1268 | #-# Default value is 30 seconds | ||
| 1269 | # openoffice.taskExecutionTimeout=30000 | ||
| 1270 | |||
| 1271 | #------------------------------------------------------------------------------------- | ||
| 1272 | # Velocity | ||
| 1273 | #------------------------------------------------------------------------------------- | ||
| 1274 | |||
| 1275 | #-# [Since 2.0M1] | ||
| 1276 | #-# Velocity Tools that will be available from your scripts. The format is | ||
| 1277 | #-# velocity.tools.<name under which it'll be available in the context> = <class name> | ||
| 1278 | #-# Default values (no need to add them) | ||
| 1279 | #-# velocity.tools = listtool = org.apache.velocity.tools.generic.ListTool | ||
| 1280 | #-# velocity.tools = numbertool = org.apache.velocity.tools.generic.NumberTool | ||
| 1281 | #-# velocity.tools = datetool = org.apache.velocity.tools.generic.DateTool | ||
| 1282 | #-# velocity.tools = mathtool = org.apache.velocity.tools.generic.MathTool | ||
| 1283 | #-# velocity.tools = sorttool = org.apache.velocity.tools.generic.SortTool | ||
| 1284 | #-# velocity.tools = escapetool = org.apache.velocity.tools.generic.EscapeTool | ||
| 1285 | #-# velocity.tools = regextool = org.xwiki.velocity.tools.RegexTool | ||
| 1286 | |||
| 1287 | #-# [Since 2.0M1] | ||
| 1288 | #-# Velocity configuration properties. The format is | ||
| 1289 | #-# velocity.property.<Velocity property name> = <value> | ||
| 1290 | #-# Default values (no need to add them) | ||
| 1291 | #-# velocity.properties = resource.loader = webapp | ||
| 1292 | #-# velocity.properties = directive.set.null.allowed = true | ||
| 1293 | #-# velocity.properties = webapp.resource.loader.class = org.apache.velocity.tools.view.servlet.WebappLoader | ||
| 1294 | #-# velocity.properties = velocimacro.messages.on = false | ||
| 1295 | #-# velocity.properties = resource.manager.logwhenfound = false | ||
| 1296 | #-# velocity.properties = velocimacro.permissions.allow.inline.local.scope = true | ||
| 1297 | #-# velocity.properties = runtime.introspector.uberspect = org.xwiki.velocity.introspection.ChainingUberspector | ||
| 1298 | #-# velocity.properties = runtime.introspector.uberspect.chainClasses = org.apache.velocity.util.introspection.SecureUberspector,org.xwiki.velocity.introspection.DeprecatedCheckUberspector | ||
| 1299 | |||
| 1300 | #------------------------------------------------------------------------------------- | ||
| 1301 | # Events distribution | ||
| 1302 | #------------------------------------------------------------------------------------- | ||
| 1303 | |||
| 1304 | #-# [Since 2.0M3] | ||
| 1305 | #-# Indicate if the network distribution module is enabled or not. | ||
| 1306 | #-# By default remote events are disabled. | ||
| 1307 | # observation.remote.enabled = false | ||
| 1308 | |||
| 1309 | #-# [Since 2.0M3] | ||
| 1310 | #-# The list of events communication channels to start when the application starts. | ||
| 1311 | #-# By default no channel is configured. | ||
| 1312 | #-# | ||
| 1313 | #-# The default remote event distribution implementation is using JGroups and you'll need to drop your JGroups channel | ||
| 1314 | #-# xml files in the WEB-INF/observation/remote/jgroups/ directory. There's a README file in that directory with more | ||
| 1315 | #-# information. | ||
| 1316 | #-# Example: observation.remote.channels = public, cluster | ||
| 1317 | |||
| 1318 | #-# [Since 2.0M4] | ||
| 1319 | #-# The implementation of network adapter to use. | ||
| 1320 | #-# The default is jgroups. | ||
| 1321 | #-# | ||
| 1322 | #-# 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. | ||
| 1323 | #-# Example: observation.remote.networkadapter = jgroups | ||
| 1324 | |||
| 1325 | #------------------------------------------------------------------------------------- | ||
| 1326 | # Administration | ||
| 1327 | #------------------------------------------------------------------------------------- | ||
| 1328 | |||
| 1329 | #-# [Since 2.2M2] | ||
| 1330 | #-# Enable captcha: true|false | ||
| 1331 | #-# | ||
| 1332 | #-# Captcha is disabled by default. | ||
| 1333 | #-# Example: captcha.enabled = true | ||
| 1334 | {{/code}} |
