Wiki source code of Distribution Wizard Configuration
Last modified by Eleni Cojocariu-testing account on 2026/08/21 16:52
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | The [[Distribution Wizard>>doc:documentation.xs.admin.distribution-wizard.WebHome]] reads its configuration from the ##WEB-INF/xwiki.properties## file of the web application. | ||
| 2 | |||
| 3 | |=Property|=Default|=Description | ||
| 4 | |##distribution.automaticStartOnMainWiki##|##true##|Start the wizard automatically on the main wiki when it has something to do. | ||
| 5 | |##distribution.automaticStartOnWiki##|##true##|The same, for the other wikis of the farm. | ||
| 6 | |##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. | ||
| 7 | |##distribution.job.interactive.wiki##|##true##|The same, for the other wikis of the farm. | ||
| 8 | |##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. | ||
| 9 | |##distribution.defaultWikiUI##|(none)|The same, for the other wikis of the farm. | ||
| 10 | |||
| 11 | That mode changes the [[list of steps>>doc:documentation.xs.admin.distribution-wizard.steps.WebHome]], as follows: | ||
| 12 | |||
| 13 | {{image reference="wizard-default-ui-steps.png" size="extra" alt="The Distribution Wizard in default user interface mode, showing the User Interface and Wikis steps instead of the Flavor step"/}} | ||
| 14 | |||
| 15 | When neither property is set, the user interface is the one the WAR declares in its ##META-INF/extension.xed## file: | ||
| 16 | |||
| 17 | |=Key|=Description | ||
| 18 | |##xwiki.extension.distribution.ui##|The id of the extension to install as the user interface of the main wiki. | ||
| 19 | |##xwiki.extension.distribution.ui.version##|Its version. | ||
| 20 | |##xwiki.extension.distribution.wikiui##|The id of the extension to install as the user interface of the other wikis. | ||
| 21 | |##xwiki.extension.distribution.wikiui.version##|Its version. | ||
| 22 | |||
| 23 | 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. | ||
| 24 | |||
| 25 | The distribution job can also be started without the browser, through the [[Job REST API>>doc:Documentation.UserGuide.Features.XWikiRESTfulAPI||anchor="HJobresources"]]: | ||
| 26 | |||
| 27 | {{code language="none"}} | ||
| 28 | PUT /rest/jobs?jobType=distribution&async=true | ||
| 29 | {{/code}} |
