Distribution Wizard Configuration
Last modified by Eleni Cojocariu on 2026/08/18 15:19
Reference
The Distribution Wizard reads its configuration from the WEB-INF/xwiki.properties file of the web application.
| Property | Default | Description |
|---|---|---|
| distribution.automaticStartOnMainWiki | true | Start the wizard automatically on the main wiki when it has something to do. |
| distribution.automaticStartOnWiki | true | The same, for the other wikis of the farm. |
| distribution.job.interactive | true | Run the wizard in the browser on the main wiki. Set to false, the distribution job runs on its own and takes the decisions automatically, without the "Distribution Wizard" and "Report" steps. |
| distribution.job.interactive.wiki | true | The same, for the other wikis of the farm. |
| distribution.defaultUI | (none) | The id of the extension to install as the user interface of the main wiki, optionally followed by a slash and a version. Setting it switches the wizard to default user interface mode. |
| distribution.defaultWikiUI | (none) | The same, for the other wikis of the farm. |
That mode changes the list of steps, as follows:
When neither property is set, the user interface is the one the WAR declares in its META-INF/extension.xed file:
| Key | Description |
|---|---|
| xwiki.extension.distribution.ui | The id of the extension to install as the user interface of the main wiki. |
| xwiki.extension.distribution.ui.version | Its version. |
| xwiki.extension.distribution.wikiui | The id of the extension to install as the user interface of the other wikis. |
| xwiki.extension.distribution.wikiui.version | Its version. |
A WAR built with Maven declares those keys in its own pom.xml and lets the Extension plugin generate the extension.xed file from them. An id configured in xwiki.properties without a version takes the version of the WAR itself.
The distribution job can also be started without the browser, through the Job REST API:
PUT /rest/jobs?jobType=distribution&async=trueFAQ
Why does the automatic mode install nothing?
Because the default flavor mode has no way to know which flavor you want. Set distribution.defaultUI as well when you disable the interactive mode.
