# --------------------------------------------------------------------------- # See the NOTICE file distributed with this work for additional # information regarding copyright ownership. # # This is free software; you can redistribute it and/or modify it # under the terms of the GNU Lesser General Public License as # published by the Free Software Foundation; either version 2.1 of # the License, or (at your option) any later version. # # This software is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public # License along with this software; if not, write to the Free # Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA # 02110-1301 USA, or see the FSF site: http://www.fsf.org. # --------------------------------------------------------------------------- # This is the new XWiki configuration file. In the future it'll replace the old # xwiki.cfg file. However right now it's only used by some XWiki components. # As time progresses more and more component will get their configurations from # this file. # # This file come from one of those locations (in this order): # * [since 9.3] /etc/xwiki/xwiki.properties # * /WEB-INF/xwiki.properties in the web application resources #------------------------------------------------------------------------------------- # Core #------------------------------------------------------------------------------------- #-# [Since 1.8RC2] #-# Specifies the default syntax to use when creating new documents. #-# Default value is xwiki/2.1. # core.defaultDocumentSyntax = xwiki/2.1 #-# [Since 2.4M1] #-# Indicate if the rendering cache is enabled. #-# Default value is false. # core.renderingcache.enabled=true #-# [Since 2.4M1] #-# A list of Java regex patterns matching full documents reference. # core.renderingcache.documents=wiki:Space\.Page # core.renderingcache.documents=wiki:Space\..* # core.renderingcache.documents=Space\.PageOnWhateverWiki #-# [Since 2.4M1] #-# The time (in seconds) after which data should be removed from the cache when not used. #-# Default value is 300 (5 min). # core.renderingcache.duration=300 #-# [Since 2.4M1] #-# The size of the rendering cache. Not that it's not the number of cached documents but the number of cached results. #-# (For a single document several cache entries are created, because each action, language and request query string #-# produces a unique rendering result) #-# Default value is 100. # core.renderingcache.size=100 #-# [Since 7.2M2] #-# Define which hierarchy is used between pages (for example inside the breadcrumb). #-# Possible values are "reference" (default) or "parentchild". #-# If "parentchild" is used, the hierachy is based on the parent/child relationship, which means that any document #-# could be defined as the parent of an other document. #-# If "reference" is used, then the children of a document must be placed inside this document. It's less flexible but #-# more clear. # core.hierarchyMode=reference #------------------------------------------------------------------------------------- # Environment #------------------------------------------------------------------------------------- #-# [Since 3.5M1, replaces the container.persistentDirectory property] #-# The directory used to store persistent data (data that should persist across server restarts). This is an #-# important directory containing important data and thus it should never be deleted (it should be backed-up along #-# with the database). #-# For example this is where the Extension Manager stores downloaded extensions if the extension.localRepository #-# property isn't configured. #-# #-# You can set: #-# * an absolute path (recommended) #-# * a relative path (not recommended at all)but in this case the directory will be relative to where the XWiki server #-# is started and thus the user under which XWiki is started will need write permissions for the current directory #-# #-# Note if the system property xwiki.data.dir is set then this property is not used. #-# If neither the system property nor this configuration value here are set then the Servlet container's temporary #-# directory is used; This is absolutely not recommended since that directory could be wiped out at any time and you #-# should specify a value. environment.permanentDirectory=/var/lib/xwiki/data #------------------------------------------------------------------------------------- # Rendering #------------------------------------------------------------------------------------- #-# [Since 1.8RC2] #-# Specifies how links labels are displayed when the user doesn't specify the label explicitly. #-# Valid values: #-# %w: wiki name #-# %s: full space name (e.g. space1.space2) #-# Note: Prior to 7.4.2/8.0M2 this was only displaying the last space name #-# %ls: last space name. New in 7.4.2/8.0M2 #-# %p: page name #-# %np: nested page name (i.e. will display the space name for Nested Pages). New in 7.4.2/8.0M2 #-# %P: page name with spaces between camel case words, i.e. "My Page" if the page name is "MyPage" #-# %NP: nested page name with spaces between camel case words, i.e. "My Page" if the page name is "MyPage". #-# New in 7.4.2/8.0M2 #-# %t: page title #-# #-# Note that if the page title is empty or not defined then it defaults to %np. This is also the case #-# if the title cannot be retrieved for the document. #-# #-# The default is "%np". Some examples: "%s.%p", "%w:%s.%p". # rendering.linkLabelFormat = %np #-# [Since 2.0M3] #-# Overrides default macro categories (Each macro has a default category already defined, for example #-# "presentation" for the Table of Contents Macro). #-# #-# Ex: To redefine the macro category for the TOC macro so that it'd be in the "My Category" category + #-# redefine the category for the Script Macro to be "My Other Category", you'd use: # rendering.macroCategories = toc:My Category # rendering.macroCategories = script:My Other Category #-# [Since 2.5M2] #-# Specify whether the image dimensions should be extracted from the image parameters and included in the image URL #-# or not. When image dimensions are included in the image URL the image can be resized on the server side before being #-# downloaded, improving thus the page loading speed. #-# #-# Default value is true. # rendering.imageDimensionsIncludedInImageURL = true #-# [Since 2.5M2] #-# One way to improve page load speed is to resize images on the server side just before rendering the page. The #-# rendering module can use the image width provided by the user to scale the image (See #-# rendering.includeImageDimensionsInImageURL configuration parameter). When the user doesn't specify the image width #-# the rendering module can limit the width of the image based on this configuration parameter. #-# #-# The default value is -1 which means image width is not limited by default. Use a value greater than 0 to limit the #-# image width (pixels). Note that the aspect ratio is kept even when both the width and the height of the image are #-# limited. # rendering.imageWidthLimit = 1024 # rendering.imageWidthLimit = -1 #-# [Since 2.5M2] #-# See rendering.imageWidthLimit # rendering.imageHeightLimit = 768 # rendering.imageHeightLimit = -1 #-# [Since 2.5M2] #-# InterWiki definitions in the format alias=URL #-# See http://en.wikipedia.org/wiki/Interwiki_links for a definition of an InterWiki link # Some examples: # rendering.interWikiDefinitions = wikipedia = http://en.wikipedia.org/wiki/ # rendering.interWikiDefinitions = definition = http://www.yourdictionary.com/ #-# [Since 2.4M1] #-# Change the Pygments style used in the code macro (see http://pygments.org/docs/styles/) #-# If not set "default" style is used. # rendering.macro.code.pygments.style=vs #------------------------------------------------------------------------------------- # Rendering Transformations #------------------------------------------------------------------------------------- #-# [Since 2.6RC1] #-# Controls what transformations will be executed when rendering content. #-# A transformation modifies the parsed content. For example the Icon transformation replaces some characters with #-# icons, a WikiWord transformation will automatically create links when it finds wiki words, etc. #-# Note that the Macro transformation is a special transformation that replaces macro markers by the result of the #-# macro execution. If you don't list it, macros won't get executed. #-# The default value is: macro, icon # rendering.transformations = macro, icon #-# [Since 2.6RC1] #-# Icon Transformation Configuration #-# Defines mappings between suite of characters and the icon to display when those characters are found. #-# The format is: rendering.transformation.icon.mappings = = #-# The following mappings are already predefined and you don't need to redefine them unless you wish to override them #-# [Since 9.3RC1/8.4.5] To disable a default mapping, define it with an empty value. For example: #-# rendering.transformation.icon.mappings = (n) = #-# #-# rendering.transformation.icon.mappings = :) = emoticon_smile #-# rendering.transformation.icon.mappings = :( = emoticon_unhappy #-# rendering.transformation.icon.mappings = :P = emoticon_tongue #-# rendering.transformation.icon.mappings = :D = emoticon_grin #-# rendering.transformation.icon.mappings = ;) = emoticon_wink #-# rendering.transformation.icon.mappings = (y) = thumb_up #-# rendering.transformation.icon.mappings = (n) = thumb_down #-# rendering.transformation.icon.mappings = (i) = information #-# rendering.transformation.icon.mappings = (/) = accept #-# rendering.transformation.icon.mappings = (x) = cancel #-# rendering.transformation.icon.mappings = (!) = error #-# rendering.transformation.icon.mappings = (+) = add #-# rendering.transformation.icon.mappings = (-) = delete #-# rendering.transformation.icon.mappings = (?) = help #-# rendering.transformation.icon.mappings = (on) = lightbulb #-# rendering.transformation.icon.mappings = (off) = lightbulb_off #-# rendering.transformation.icon.mappings = (*) = star #------------------------------------------------------------------------------------- # LinkChecker Transformation #------------------------------------------------------------------------------------- #-# [Since 3.3M2] #-# Defines the time (in ms) after which an external link should be checked again for validity. #-# the default configuration is: # rendering.transformation.linkchecker.timeout = 3600000 #-# [Since 5.3RC1] #-# List of document references that are excluded from link checking, specified using regexes. #-# the default configuration is: # rendering.transformation.linkchecker.excludedReferencePatterns = .*:XWiki\.ExternalLinksJSON #------------------------------------------------------------------------------------- # Rendering Macros #------------------------------------------------------------------------------------- #-# Velocity Macro #-# [Since 2.0M1] #-# Defines which Velocity Filter to use by default. This offers the possibility to filter the Velocity macro content #-# before and after the Velocity Engine execution. #-# The following filters are available: #-# - indent (the default): Remove all first whites spaces of lines to support source code indentation without #-# generating whitespaces in the resulting XDOM. #-# - none: Doesn't change the content #-# - html: Removes all leading and trailing white spaces and new lines. If you need a space you'll need to use #-# \$sp and if you need a new line you'll need to use \$nl #-# rendering.macro.velocity.filter = indent #------------------------------------------------------------------------------------- # Cache #------------------------------------------------------------------------------------- #-# [Since 1.7M1] #-# The standard cache component implementation to use (can be local or distributed depending on the implementation). #-# The default standard cache implementation is Infinispan. # cache.defaultCache=infinispan #-# [Since 1.7M1] #-# The local cache implementation to use. #-# The default local cache implementation is Infinispan. # cache.defaultLocalCache=infinispan/local #------------------------------------------------------------------------------------- # Settings for the OpenOffice server instance consumed by the OfficeImporter component #------------------------------------------------------------------------------------- #-# [Since 1.9M2] #-# Type of the openoffice server instance used by officeimporter component. #-# 0 - Internally managed server instance. (Default) #-# 1 - Externally managed (local) server instance. openoffice.serverType=0 #-# [Since 1.9M2] #-# Port number used for connecting to the openoffice server instance. #-# Default port is 8100 openoffice.serverPort=8100 #-# [Since 1.9M2] #-# If the openoffice server should be started / connected upon XE start. #-# Default value is false openoffice.autoStart=true #-# [Since 1.8RC3] #-# Path to openoffice installation (serverType:0 only). #-# If no path is provided, a default value will be calculated based on the operating environment. openoffice.homePath=/opt/openoffice4 #-# [Since 1.8RC3] #-# Path to openoffice execution profile (serverType:0 only). #-# If no path is provided, a default value will be calculated based on the operating environment. # openoffice.profilePath=/home/user/.openoffice.org/3 #-# [Since 1.8RC3] #-# Maximum number of simultaneous conversion tasks to be handled by a single openoffice process (serverType:0 only). #-# Default value is 50 openoffice.maxTasksPerProcess=50 #-# [Since 1.8RC3] #-# Timeout for conversion tasks (in milliseconds) (serverType:0 only). #-# Default value is 30 seconds openoffice.taskExecutionTimeout=30000 #------------------------------------------------------------------------------------- # Velocity #------------------------------------------------------------------------------------- #-# [Since 2.0M1] #-# Velocity Tools that will be available from your scripts. The format is #-# velocity.tools = = #-# Default values (no need to add them) #-# velocity.tools = listtool = org.apache.velocity.tools.generic.ListTool #-# velocity.tools = numbertool = org.apache.velocity.tools.generic.NumberTool #-# velocity.tools = datetool = org.apache.velocity.tools.generic.ComparisonDateTool #-# velocity.tools = mathtool = org.apache.velocity.tools.generic.MathTool #-# velocity.tools = sorttool = org.apache.velocity.tools.generic.SortTool #-# velocity.tools = escapetool = org.apache.velocity.tools.generic.EscapeTool #-# velocity.tools = regextool = org.xwiki.velocity.tools.RegexTool #-# velocity.tools = collectionstool = org.xwiki.velocity.tools.CollectionsTool #-# velocity.tools = stringtool = org.apache.commons.lang3.StringUtils #-# velocity.tools = jsontool = org.xwiki.velocity.tools.JSONTool #-# velocity.tools = urltool = org.xwiki.velocity.tools.URLTool #-# velocity.tools = cookietool = org.apache.velocity.tools.view.CookieTool #-# velocity.tools = exceptiontool = org.apache.commons.lang3.exception.ExceptionUtils #-# [Since 2.0M1] #-# Velocity configuration properties. The format is #-# velocity.properties = = #-# Default values (no need to add them) #-# velocity.properties = resource.loader = webapp #-# velocity.properties = directive.set.null.allowed = true #-# velocity.properties = webapp.resource.loader.class = org.apache.velocity.tools.view.servlet.WebappLoader #-# velocity.properties = velocimacro.messages.on = false #-# velocity.properties = resource.manager.logwhenfound = false #-# velocity.properties = velocimacro.permissions.allow.inline.local.scope = true #-# velocity.properties = runtime.introspector.uberspect = org.xwiki.velocity.introspection.SecureUberspector\,org.xwiki.velocity.introspection.DeprecatedCheckUberspector\,org.xwiki.velocity.introspection.MethodArgumentsUberspector #------------------------------------------------------------------------------------- # Groovy #------------------------------------------------------------------------------------- #-# [Since 4.1M1] #-# Allows to specify Compiler customization for the Groovy execution engine. #-# There's no customizers defined by default. Available customizer ids: #-# - timedinterrupt: interrupt script execution if it takes longer than a given time (default to 1 minute) #-# - secure: runs Groovy in a security sandbox #-# groovy.compilationCustomizers= #-# Timed Interrupt Customizer #-# [Since 4.1M1] #-# Default execution time for a script before a timeout occurs, in seconds. #-# groovy.customizer.timedInterrupt.timeout=60 #------------------------------------------------------------------------------------- # Events distribution #------------------------------------------------------------------------------------- #-# [Since 2.0M3] #-# Indicate if the network distribution module is enabled or not. #-# By default remote events are disabled. # observation.remote.enabled = false #-# [Since 2.0M3] #-# The list of events communication channels to start when the application starts. #-# By default no channel is configured. #-# #-# The default remote event distribution implementation is using JGroups and you'll need to either use embedded JGroups configuration #-# files or drop your custom configuration in the WEB-INF/observation/remote/jgroups/ directory. #-# There's a README file in that directory with more information. #-# Example: observation.remote.channels = public, cluster #-# [Since 2.0M4] #-# The implementation of network adapter to use. #-# The default is jgroups. #-# #-# By default only jgroups is provided. To add one implements NetworkAdaptor component interface. The identifier provided in the configuration is matched with the component role hint. #-# Example: observation.remote.networkadapter = jgroups #------------------------------------------------------------------------------------- # CSRF token component #------------------------------------------------------------------------------------- #-# [Since 2.5M2] #-# Controls whether secret token validation mechanism should be used (to prevent CSRF attacks). #-# #-# If enabled, all actions requiring "comment", "edit", "delete", "admin" or "programming" rights #-# will check that the parameter "form_token" with the value of a random secret token is present #-# in the request. #-# #-# Valid values: #-# true : Enabled #-# false: Disabled #-# #-# Default value is true # csrf.enabled = true #------------------------------------------------------------------------------------- # Jobs #------------------------------------------------------------------------------------- #-# [Since 4.0M1] #-# The folder containing job executing status. #-# The default is {environment.permanentDirectory}/jobs/ # job.statusFolder=/var/lib/xwiki/data/jobs/ #-# [Since 7.2M2] #-# The maximum number of entries to put in the job status cache. #-# The default is 50. # job.statusCacheSize=50 #------------------------------------------------------------------------------------- # Extension Manager #------------------------------------------------------------------------------------- #-# [Since 2.5] #-# Repositories to use when searching and downloading extensions. #-# Repositories will be checked in the same order they have in this configuration file. #-# #-# The format is :: where #-# * id can be anything as long as there is only one #-# * type is the type of the repository (maven, xwiki, etc.) #-# * url is the URL or the root of the repository #-# #-# [Since 4.3] It's also possible to associate various properties to each repository. #-# Here are the standard properties: #-# * user: the user to use to authenticate to the repository #-# * password: the password to use to authenticate to the repository #-# #-# And here those for "maven" repositories: #-# * [Since 10.7RC1] checksumPolicy: what to do when checksum validation fail. Possible values are "fail", "warn" (the default) and "ignore" #-# #-# Here is an example: # extension.repositories=privatemavenid:maven:http://host.com/private/maven/ # extension.repositories.privatemavenid.auth.user=someuser # extension.repositories.privatemavenid.auth.password=thepassword #-# #-# Here's an example to add your local Maven Repository # extension.repositories=maven-local:maven:file://${sys:user.home}/.m2/repository #-# #-# And an example to add the XWiki Maven Snapshot Repository # extension.repositories=maven-xwiki-snapshot:maven:http://nexus.xwiki.org/nexus/content/groups/public-snapshots #-# #-# When not set the following is taken (in this order): # extension.repositories=maven-xwiki:maven:http://nexus.xwiki.org/nexus/content/groups/public # extension.repositories=store.xwiki.com:xwiki:https://store.xwiki.com/xwiki/rest/ # extension.repositories=extensions.xwiki.org:xwiki:http://extensions.xwiki.org/xwiki/rest/ #-# #-# To not have any repository enabled (including disabling default repositories) you can explicitly make this list empty: # extension.repositories= #-# [Since 2.5] #-# The directory where extensions are stored after being downloaded. #-# #-# The default is extension/repository in whatever is the general persistent directory. #-# See container.persistentDirectory. # extension.localRepository=extension/repository #-# [Since 3.4] #-# The user agent to use when communication with external services (generally repositories). #-# #-# The default is: # extension.userAgent=XWikiExtensionManager #-# [Since 7.1RC1] #-# Some extensions considered now as flavor but released before the category exists #-# extension.oldflavors=org.xwiki.enterprise:xwiki-enterprise-ui-mainwiki extension.oldflavors=org.xwiki.enterprise:xwiki-enterprise-ui-wiki extension.oldflavors=org.xwiki.manager:xwiki-manager-ui extension.oldflavors=org.xwiki.manager:xwiki-manager-wiki-administrator extension.oldflavors=org.xwiki.manager:xwiki-enterprise-manager-wiki-administrator extension.oldflavors=com.xpn.xwiki.products:xwiki-enterprise-manager-wiki-administrator extension.oldflavors=com.xpn.xwiki.products:xwiki-enterprise-wiki #-# [Since 8.3] #-# Indicate if XWiki should try to find more informations about the core extension in the repositories. #-# #-# The default is: # extension.core.resolve=true #-# [Since 9.6] #-# Indicate a list of pattern extension ids and the corresponding recommended version. #-# This version will be used for dependencies matching the pattern and fallback on the version declared by the extension in case of failure. #-# #-# Here is an example: # extension.recommendedVersions=org.xwiki.commons:.*/[9.6] # extension.recommendedVersions=org.xwiki.rendering:.*/[9.6] # extension.recommendedVersions=org.xwiki.platform:.*/[9.6] # extension.recommendedVersions=com.mygroupid:.*/[1.9] #-# [Since 9.9] #-# Indicate whether the server should automatically check for new available environment versions. #-# #-# The default is: # extension.versioncheck.environment.enabled=false #-# #-# If the version check is enabled (through extension.versioncheck.environment.enabled), the following properties #-# can be used to customize how the version check is performed. #-# #-# Indicate the number of seconds between each check for a new version of the server. #-# The default is: # extension.versioncheck.environment.interval=3600 #-# #-# Indicate a pattern that will be used to filter which version should be considered as a new version. #-# By default, no pattern is given an the pattern is not applied. #-# Example: # extension.versioncheck.environment.allowedVersions=9.* #-# [Since 10.5RC1] #-# Indicate how extension documents are protected. #-# #-# The possible choices are: #-# * none: no protection at all #-# * warning (the default): everyone get a warning when trying to edit a protected document #-# * deny = EDIT/DELETE right is denied for everyone except for admins who just get a warning #-# * forcedDeny = EDIT/DELETE right is denied for everyone, admins can't force edit/delete #-# * denySimple = EDIT/DELETE right is denied for simple users except for simple admins who just get a warning #-# * forcedDenySimple = EDIT/DELETE right is denied for all simple users, simple admins can't force edit/delete # extension.xar.protection=warning #------------------------------------------------------------------------------------- # Distribution Wizard #------------------------------------------------------------------------------------- #-# [Since 7.1RC1] Enable or disable the automatic start of Distribution Wizard on empty/outdated wiki. #-# #-# The default is: # distribution.automaticStartOnMainWiki=true # distribution.automaticStartOnWiki=true #-# [Since 10.2RC1] Control if the Distribution Wizard should be automatic or interactive (the default) #-# #-# On the main wiki # distribution.job.interactive=true #-# On the subwikis # distribution.job.interactive.wiki=true #-# [Since 10.2RC1] Override the default UI indicated in the "environment extension" (usually means the WAR). #-# It usually make more sense to set that at the WAR level (since it's usually synchronized with it). #-# If this is set it also means the Distribution Wizard will switch to default UI mode in which you cannot choose the flavor. #-# #-# The id[/version] of the default UI for the main wiki. If the version is not indicated it will be the version of the environment extension. # distribution.defaultUI=org.my.groupid:artifactid-mainwiki/1.5 #-# The id[/version] default UI for the subwikis. If the version is not indicated it will be the version of the environment extension. # distribution.defaultWikiUI=org.my.groupid:artifactid-wiki/1.5 #------------------------------------------------------------------------------------- # Solr Search #------------------------------------------------------------------------------------- #-# [Since 4.5M1] #-# The Solr server type. Currently accepted values are "embedded" (default) and "remote". # solr.type=embedded #-# [Since 4.5M1] #-# The location where the embedded Solr instance stores its configuration and the indexed data. #-# The default is the subfolder "solr" inside the folder defined by the property "environment.permanentDirectory". # solr.embedded.home=/var/local/xwiki/solr #-# [Since 4.5M1] #-# The URL to use to connect to the remote solr server. #-# The default value assumes that the remote Solr server is started in a different process on the same machine, using the default port. # solr.remote.url=http://localhost:8983/solr #-# [Since 5.1M1] #-# Elements to index are not sent to the Solr server one by one but in batch to improve performances. #-# It's possible to configure this behavior with the following properties: #-# #-# The maximum number of elements sent at the same time to the Solr server #-# The default is 50. # solr.indexer.batch.size=50 #-# The maximum number of characters in the batch of elements to send to the Solr server. #-# The default is 10000. # solr.indexer.batch.maxLength=10000 #-# [Since 5.1M1] #-# The maximum number of elements in the background queue of elements to index/delete #-# The default is 10000. # solr.indexer.queue.capacity=100000 #-# [Since 6.1M2] #-# Indicating if a synchronization between SOLR index and XWiki database should be run at startup. #-# Synchronization can be started from search administration. #-# The default is true. # solr.synchronizeAtStartup=false #------------------------------------------------------------------------------------- # Security #------------------------------------------------------------------------------------- #-# [Since 5.0M2] #-# Define the authorization policies by choosing another implementation of the AuthorizationSettler. This component #-# is solely responsible for settling access decisions based on user, target entity and available security rules. #-# The identifier provided here is matched with the component role hint. #-# #-# The default is: # security.authorization.settler=default #------------------------------------------------------------------------------------- # URL #------------------------------------------------------------------------------------- #-# IMPORTANT: The URL module is a feature still in development and as such should be considered experimental at the #-# moment. The configuration parameters below are used only in some part of the code at the moment. The idea is to #-# progressively refactor more and more till only the new properties are used. For the moment you should continue to #-# use the following old properties located in xwiki.cfg: #-# xwiki.virtual.usepath #-# xwiki.virtual.usepath.servletpath #-# [Since 5.1M1] #-# The id of the URL format to use. This allows to plug in different implementations and thus allows to completely #-# control the format of XWiki URLs. #-# #-# The default is: # url.format=standard #-# [Since 5.1M1] #-# Defines where the wiki part is defined in a URL pointing to a subwiki #-# If true then the wiki part is located in the URL path (a.k.a path-based), for example: #-# http://server/xwiki/wiki/mywiki/view/Space/Page #-# If false then the wiki part is located in the URL host domain (a.k.a domain-based), for example: #-# http://mywiki.domain/xwiki/bin/view/Space/Page #-# #-# The default is: # url.standard.multiwiki.isPathBased=true #-# [Since 5.1M1] #-# For path-based setups, this property defines the path segment before the one identifying the subwiki in the URL. #-# For example if set to "thewiki", then the following URL will point to a subwiki named "mywiki": #-# http://server/xwiki/thewiki/mywiki/view/Space/Page #-# Note that the mapping in web.xml has to be modified accordingly if you don't use the default value: #-# #-# action #-# /wiki/* #-# #-# #-# The default is: # url.standard.multiwiki.wikiPathPrefix=wiki #-# [Since 5.2M1] #-# Defines the URL path prefix used for Entity URLs, i.e. URLs pointing to a Document, Space, Object, etc. #-# For example this is the "bin" part in the following URL: #-# http://server/xwiki/bin/view/space/page #-# Note that this replaces the old xwiki.defaultservletpath property in the xwiki.cfg file. #-# #-# The default is: # url.standard.entityPathPrefix=bin #-# [Since 5.3M1] #-# The action to take when a subwiki is not found (ie there's no wiki descriptor for it). Valid values are: #-# - redirect_to_main_wiki: default to displaying the main wiki #-# - display_error: redirect to a vm to display an error #-# #-# The default is: # url.standard.multiwiki.notFoundBehavior=redirect_to_main_wiki #-# [Since 7.2M1] #-# Whether the "view" action is omitted in URLs (in order to have shorter URLs). #-# Note that this replaces the old xwiki.showviewaction property in the xwiki.cfg file. #-# #-# The default is: # url.standard.hideViewAction=false #-# [Since 11.1RC1] #-# Whether a the last modified date of the file to be loaded should be checked and put in the URL query parameter. #-# Disabling this might improve a bit the performance on some old hard drives, or custom filesystem, however #-# it might imply the need to force-reload some resources in the browser, when migrating. #-# #-# The default is: # url.useResourceLastModificationDate=true #------------------------------------------------------------------------------------- # Attachment #------------------------------------------------------------------------------------- #-# [Since 5.2M2] #-# Define the kind of attachment that can be displayed inline. You can either choose to do it through a whitelist (only #-# the mimetypes defined in this list would be displayed inline) or a blacklist (every mimetype that is not in this list #-# would be displayed inline if possible) #-# #-# By default we use the following whitelist (coma separated list of values). # attachment.download.whitelist=audio/basic,audio/L24,audio/mp4,audio/mpeg,audio/ogg,audio/vorbis,audio/vnd.rn-realaudio,audio/vnd.wave,audio/webm,image/gif,image/jpeg,image/pjpeg,image/png,image/svg+xml,image/tiff,text/csv,text/plain,text/xml,text/rtf,video/mpeg,video/ogg,video/quicktime,video/webm,video/x-matroska,video/x-ms-wmv,video/x-flv #-# #-# If you prefer to use a blacklist instead, you can define the forbidden types here, as a coma separated list of values. #-# We advise you to forbid at least the following mimetypes : text/html, text/javascript # attachment.download.blacklist=text/html,text/javascript #------------------------------------------------------------------------------------- # Active Installs #------------------------------------------------------------------------------------- #-# [Since 5.2M2] #-# The URL of where the Active Installs module should connect to in order to send a ping of activity. This feature #-# regularly sends the following information to xwiki.org about the current instance: #-# - its unique id #-# - the id and versions of all installed extensions) #-# The goal is to count the number of active installs of XWiki out there and provide statistics on xwiki.org #-# #-# The default is: # activeinstalls.pingURL=http://extensions.xwiki.org/activeinstalls #------------------------------------------------------------------------------------- # Wikis #------------------------------------------------------------------------------------- #-# [Since 5.4.4] #-# Add a default suffix to the alias of a new wiki in the wiki creation wizard, only when the path mode is not used #-# (i.e. domain-based, see url.standard.multiwiki.isPathBased). If this value is empty, XWiki will try to compute it #-# automatically from the request URL. #-# #-# eg: if wiki.alias.suffix is "xwiki.org" and the wiki name is "playground" #-# then the computed alias will be: "playground.xwiki.org". #-# #-# The default is: # wiki.alias.suffix= #------------------------------------------------------------------------------------- # Store #------------------------------------------------------------------------------------- #-# [Since 6.1M2] #-# If active, the Filesystem Attachment Store will automatically clear empty directories on startup, #-# in some cases this may create undue load on the server and may need to be disabled. To do that, #-# set the following to false. #-# Note that if you disable this feature, empty directories will accumulate and you are responsible #-# for cleaning them up. # store.fsattach.cleanOnStartup=true #------------------------------------------------------------------------------------- # Mail #------------------------------------------------------------------------------------- #-# [Since 6.1M2] #-# SMTP host when sending emails, defaults to "localhost". #-# This configuration property can be overridden in XWikiPreferences objects, by using the "smtp_server" property name. # mail.sender.host = localhost #-# [Since 6.1M2] #-# SMTP port when sending emails, defaults to 25. #-# This configuration property can be overridden in XWikiPreferences objects, by using the "smtp_port" property name. # mail.sender.port = 25 #-# [Since 6.1M2] #-# From email address to use. Not defined by default and needs to be set up when calling the mail API. #-# This configuration property can be overridden in XWikiPreferences objects, by using the "admin_email" property name. # mail.sender.from = john@doe.com #-# [Since 6.1M2] #-# Username to authenticate on the SMTP server, if needed. By default no authentication is performed. #-# This configuration property can be overridden in XWikiPreferences objects, by using the "smtp_server_username" #-# property name. # mail.sender.username = someuser #-# [Since 6.1M2] #-# Password to authenticate on the SMTP server, if needed. By default no authentication is performed. #-# This configuration property can be overridden in XWikiPreferences objects, by using the "smtp_server_password" #-# property name. # mail.sender.password = somepassword #-# [Since 6.1M2] #-# Extra Java Mail options (see https://javamail.java.net/nonav/docs/api/). #-# This configuration property can be overridden in XWikiPreferences objects, by using the "javamail_extra_props" #-# property name. #-# By default the following properties are set automatically: #-# mail.transport.protocol = smtp #-# mail.smtp.host = #-# mail.smtp.port = #-# mail.smtp.user = #-# mail.smtp.from = #-# Example: # mail.sender.properties = mail.smtp.starttls.enable = true # mail.sender.properties = mail.smtp.socks.host = someserver #-# [Since 6.4M2] #-# Defines which authorization checks are done when sending mails using the Mail Sender Script Service. #-# Example of valid values: #-# - "programmingrights": the current document must have Programming Rights #-# - "alwaysallow": no check is performed. This is useful when running XWiki in a secure environment where we #-# want to allow all users to be able to send emails through the Script Service. #-# The default is: # mail.sender.scriptServiceCheckerHint = programmingrights #-# [Since 6.4M2] #-# optional default email addresses to add to the BCC mail header when sending email. # mail.sender.bcc = john@doe.com,mary@doe.com #-# [Since 6.4RC1] #-# The delay to wait between each mail being sent, in milliseconds. This is done to support mail throttling and not #-# be considered a spammer by mail servers. #-# The default is 8 seconds: # mail.sender.sendWaitTime = 8000 #-# [Since 6.4.1, 7.0M1] #-# When using the Database Mail Listener, whether mail statuses for mails that have been sent successfully must be #-# discarded or not. They could be kept for tracability purpose for example. #-# The default is: # mail.sender.database.discardSuccessStatuses = true #------------------------------------------------------------------------------------- # WatchList #------------------------------------------------------------------------------------- #-# [Since 10.0] #-# [Since 9.11.2] #-# Controls if the notifications feature is enabled. Default value is false. #-# Thanks to this option, you can disable the application without uninstalling it. # watchlist.enabled = false #-# [Since 7.0RC1] #-# Controls if the realtime notifications feature is enabled. Default value is false. #-# This is currently an experimental feature which is not yet ready for producton. Enabling it right now will cause performance issues. #-# Once the feature stabilizes, it will be enabled by default and the option to disabled it will be removed. # watchlist.realtime.enabled = false #-# [Since 8.1M2] #-# Controls if realtime notifications are triggered by remote events. Default value is false. #-# Enable if you don't have watchlist loaded on all instances in cluster. # watchlist.realtime.allowRemote = false #------------------------------------------------------------------------------------- # Debug #------------------------------------------------------------------------------------- #-# [Since 7.0RC1] #-# Indicate if web resources should be loaded minified by default. #-# It's enabled by default which can make js/css hard to read. # debug.minify=false #------------------------------------------------------------------------------------- # LESS CSS #------------------------------------------------------------------------------------- #-# [Since 7.4.2, 8.0M2] #-# The number of LESS compilations that can be performed simultaneously. Put a little number if your resources are #-# limited. #-# #-# The default is: # lesscss.maximumSimultaneousCompilations = 4 #-# [Since 8.0RC1] #-# Generate sourcemaps inline in the CSS files. #-# #-# The default is: # lesscss.generateInlineSourceMaps = false #------------------------------------------------------------------------------------- # Edit #------------------------------------------------------------------------------------- #-# [Since 8.2RC1] #-# Indicate the default editor to use for a specific data type. #-# The editors are components so they are specified using their role hints. #-# Some data types can be edited in multiple ways, by different types of editors. #-# Thus you can also indicate the default editor to use from a specific category (editor type). #-# #-# The format is this: #-# edit.defaultEditor.= #-# edit.defaultEditor.#= #-# #-# The default bindings are: # edit.defaultEditor.org.xwiki.rendering.syntax.SyntaxContent=text # edit.defaultEditor.org.xwiki.rendering.syntax.SyntaxContent#text=text # edit.defaultEditor.org.xwiki.rendering.block.XDOM=text # edit.defaultEditor.org.xwiki.rendering.block.XDOM#text=text #------------------------------------------------------------------------------------- # Notifications #------------------------------------------------------------------------------------- #-# [Since 9.4RC1] #-# Indicates if the notifications module should be enabled on the platform. #-# #-# The default is : # notifications.enabled = true #-# [Since 9.5C1] #-# Indicates if the notifications module can send emails. #-# #-# The default is : # notifications.emails.enabled = true #-# [Since 9.6RC1] #-# Indicate the grace time used when sending live email notifications. #-# When an event is triggered in the wiki (for example, a document update), the platform will wait X minutes #-# before sending live notifications emails. During this time, if events of the same kind are recieved, they will #-# be grouped in the same email. #-# #-# The grace time define the period (in minutes) for which the platform should wait before sending a notification #-# mail after an event. #-# #-# The default is : # notifications.emails.live.graceTime = 10 #-# [Since 9.8RC1] #-# Indicate if the "watched entities" feature is enabled on the platform. #-# This feature mimics what the "Watchlist Application" does so it may not be a good idea to have both on the platform. #-# #-# The default is : # notifications.watchedEntities.enabled = true #-# [Since 9.11.8] #-# [Since 10.6RC1] #-# The automatic watch mode used by default. The value can be changed by an administrator in the wiki's administration #-# or by any user in their own settings. #-# #-# Possible values: #-# #-# - none: no page is added to the list of watched pages automatically. #-# - all: everytime a user makes a change on a page, it is automatically added to her list of watched pages. #-# - major: everytime a user makes a major change on a page, it is automatically added to her list of watched pages. #-# - new: only pages created by a user are added to her list of watched pages. #-# #-# The default is : # notifications.watchedEntities.autoWatch = major #-# [Since 10.11.4] #-# [Since 11.3RC1] #-# The search for notifications in the REST API is done trough a thread pool to limit the impact on the rest of the #-# XWiki instance. #-# This properties controls the size of this pool. Any number lower than 1 disable the thread pool system. #-# #-# The default is : # notifications.rest.poolSize=2 #-# [Since 10.11.4] #-# [Since 11.3RC1] #-# Enable or disable caching of notification search result in the REST API. #-# #-# The default is : # notifications.rest.cache=true #------------------------------------------------------------------------------------- # Event Stream #------------------------------------------------------------------------------------- #-# [Since 11.1RC1] #-# The Event Stream, on which the notifications are based, stores data in a dedicated table in the database. #-# Each wiki has its own database. The feature can be configured to store its data into the database corresponding to #-# the wiki, into the main database (default: xwiki) or both. These options should not be both set to false (in this #-# case the local store will be forced). #-# Important note: disabling storage in the main store will prevent the notifications from retrieving events from #-# subwikis. Moreover, disabling the main store makes impossible for global users to watch pages from subwikis. It is #-# not recommended. #-# #-# This feature was originally implemented by the Activity Stream plugin so these settings might sound familiar to you. #-# #-# The default is : # eventstream.uselocalstore = true #-# #-# The default is : # eventstream.usemainstore = true #-# #-# Number of days the events should be kept (0 or any negative value: infinite duration) #-# Note: if this value is greater than 0 a scheduler job will be created, this job will then be fired every week to #-# delete events older than the configured value. #-# The default is : # eventstream.daystokeepevents = 0