Wiki source code of Distribution Wizard
Last modified by Eleni Cojocariu on 2026/10/01 13:51
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | The Distribution Wizard is the tool XWiki opens in the browser when an instance is not ready to be used yet. It provisions an empty wiki with a [[flavor>>doc:documentation.xs.user.flavors.WebHome]], registers the user who owns the wiki, and brings the wiki content up to date after the [[distribution has been upgraded>>doc:documentation.xs.admin.upgrade.distribution.WebHome]]. | ||
| 2 | |||
| 3 | The wizard carries no content of its own: it drives the [[Extension Manager>>doc:extensions:Extension.Extension Manager Application]], which resolves the extensions matching the running XWiki version and downloads them from the remote repositories. An instance with no access to the Internet needs those extensions [[available locally>>doc:documentation.xs.admin.installation.install-offline.WebHome]] before the wizard can complete. | ||
| 4 | |||
| 5 | Whether the wizard opens, and what it offers once it does, depends on the state of the instance and on its [[configuration>>doc:documentation.xs.admin.distribution-wizard.configuration.WebHome]]: | ||
| 6 | |||
| 7 | {{plantuml}} | ||
| 8 | @startuml | ||
| 9 | !theme bluegray | ||
| 10 | start | ||
| 11 | :XWiki starts; | ||
| 12 | if (Interactive mode?) then (no) | ||
| 13 | :The distribution job runs at once,\\nfirst on the main wiki then on the other\\nwikis, and takes the decisions on its own; | ||
| 14 | stop | ||
| 15 | endif | ||
| 16 | :A user allowed to run the wizard\\nrequests a page; | ||
| 17 | if (Automatic start enabled\\nfor this wiki?) then (no) | ||
| 18 | :The wizard stays closed; | ||
| 19 | stop | ||
| 20 | endif | ||
| 21 | if (Default user interface\\nconfigured?) then (yes) | ||
| 22 | :Default user interface mode:\\nthe "User Interface" step, and "Wikis"\\nfor the other wikis of the farm; | ||
| 23 | else (no) | ||
| 24 | :Flavor mode:\\nthe "Flavor" step; | ||
| 25 | endif | ||
| 26 | if (Any step with something to do?) then (no) | ||
| 27 | :The wizard stays closed; | ||
| 28 | stop | ||
| 29 | endif | ||
| 30 | :The wizard opens in the browser,\\nfrom "Welcome" to "Report"; | ||
| 31 | stop | ||
| 32 | @enduml | ||
| 33 | {{/plantuml}} | ||
| 34 | |||
| 35 | Every run walks through the same sequence of [[steps>>doc:documentation.xs.admin.distribution-wizard.steps.WebHome]]. What the run achieves is the reason it was started: | ||
| 36 | |||
| 37 | * [[Install the Flavor Using the Distribution Wizard>>doc:documentation.xs.admin.distribution-wizard.install-flavor.WebHome]], on the first start of a freshly installed instance. | ||
| 38 | * [[Upgrade the Standard Flavor of the Wiki Using the Distribution Wizard>>doc:documentation.xs.admin.upgrade.flavor.upgrade-distribution-wizard.WebHome]], on the first start after the distribution was upgraded. | ||
| 39 | * [[Repair the Previously Installed Flavor>>doc:documentation.xs.admin.distribution-wizard.repair-previous-flavor.WebHome]], when the Extension Manager has no record of the user interface that was installed before and the wizard asks for it. | ||
| 40 | * [[Replay a Recorded Install or Upgrade>>doc:documentation.xs.admin.distribution-wizard.replay-recorded-actions.WebHome]], to apply on another wiki the decisions taken during one of the runs above. | ||
| 41 | * [[Rerun the Distribution Wizard on an Empty Instance>>doc:documentation.xs.admin.distribution-wizard.rerun-empty-instance.WebHome]], to start over on a wiki that has already been set up. | ||
| 42 | |||
| 43 | If the wizard does not open when you expect it, see [[Distribution Wizard Does Not Appear at Startup>>doc:documentation.xs.admin.distribution-wizard.not-appearing-startup.WebHome]]. |
