Wiki source code of Distribution Wizard

Last modified by Thomas Mortagne on 2023/10/10

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
5 The Distribution Wizard (also known as DW) is a feature which has several purposes:
7 * It allows provisioning an empty wiki by allowing the administrator to select a [[Flavor>>Applications||anchor="#HFlavors"]] on the first run of XWiki
8 * It allows to create an administration user account in the wiki.
9 * It also allows upgrading an existing XWiki instance to a new version by upgrading all required Extensions
11 It works using XWiki's Extension Manager to automatically detect your XWiki version to search, resolve, download and install the UI corresponding to your version. It requires an internet connection in order to work.
13 = Clean Install =
15 After putting your XWiki WAR inside your Servlet Container (Tomcat, Jetty, etc.) you start XWiki. When XWiki is first accessed, it will trigger the Distribution Wizard and you can access if either the wiki is empty (first install) or you are logged with a user having ADMIN right (upgrade). If the wizard fails to appear check the [[troubleshooting section>>||anchor="troubleshooting"]].
17 == Welcome Step ==
19 Upon first access, you will be greeted by the Distribution Wizard, offering you the 3 possible options:
21 * **Continue**: when choosing this option, you will move to the next step of the Distribution Wizard
22 * **Later**: DW will prompt you again after XWiki is restarted; note that the Later button has a sub-option "Replay recorded actions" that has the same effect on the Distribution Wizard, but instead of redirecting you to the page that was requested initially, it redirects you to the [[Extension History>>extensions:Extension.Extension Manager Application||anchor="HExtensionHistory"]] where you can upload and replay a history file (e.g. you can replay an install or upgrade performed on a different wiki). If the database is empty you'll have to login with the ##superadmin## user.
23 * **Never**: Discards the DW and you will have to manually import the XAR
25 {{image reference="dw-welcomeStep.png"/}}
27 == Admin user ==
29 Since 8.0 the first step allows you to register the owner of the wiki. You will then be automatically registered with it and it will be used to install anything that need to be installed.
31 {{image reference="dw-firstadminuserStep.png"/}}
33 == User Interface ==
35 Since 7.1 there is two modes for the Distribution Wizard: **Flavor** and **Default User Interface**.
37 Since 9.5 the default mode is **Flavor**.
39 To switch to **Default User Interface** mode you can do one of the following:
41 * [since 10.2] have the following properties set properly in the file ##WEB-INF/ of the web app:
42 ** ##distribution.defaultUI##: the extension ID[/version] of the application to use on the main wiki
43 ** ##distribution.defaultWikiUI##: the extension ID[/version] of the application to use on other wikis
44 * [since 8.4] have the following properties set properly in the file ##META-INF/extension.xed## of the web app:
45 ** ##xwiki.extension.distribution.ui##: the extension ID of the application to use on the main wiki
46 ** ##xwiki.extension.distribution.ui.version##: the version of the application to use on the main wiki
47 ** ##xwiki.extension.distribution.wikiui##: the extension ID of the application to use on other wikis
48 ** ##xwiki.extension.distribution.wikiui.version##: the version of the application to use on other wikis
49 * [only when no extension.xed exist] have the following properties set properly in the file ##META-INF/maven/org.xwiki.enterprise/xwiki-enterprise-web/pom.xml## of the web app:
50 ** ##xwiki.extension.distribution.ui##: the extension ID of the application to use on the main wiki
51 ** ##xwiki.extension.distribution.ui.version##: the version of the application to use on the main wiki
52 ** ##xwiki.extension.distribution.wikiui##: the extension ID of the application to use on other wikis
53 ** ##xwiki.extension.distribution.wikiui.version##: the version of the application to use on other wikis
55 If you build a custom WAR using Maven, you will set those properties in your project pom and let the Extension plugin generate the right extension.xed file.
57 === Flavor step ===
59 If there is no default UI set as explained just above, you will have the Flavor Step. A flavor is a collection of applications according to different needs. You can have a flavor for a knowledge base or a public website, for example.
61 {{image reference="dw-flavor-step1.png"/}}
63 * Select a flavor in the list of flavors.
64 * Click on "install flavor".(((
65 {{image reference="dw-flavor-step2.png"/}}
66 )))
67 * You can also select to let the wiki be empty.(((
68 {{image reference="dw-noflavor.png"/}}
69 )))
70 * In the case you have selected a flavor, the following steps are similar to those described in the previous section (User Interface).
72 === Default User Interface ===
74 The first step will check your XWiki version and will propose a version of the UI which is suited for your version.
76 * Click on **Install** to install the proposed UI. This will resolve the extensions that are going to be installed.(((
77 {{image reference="dw-uiStep.png"/}}
78 )))
79 * Click on the **Continue** button. This will start the actual installation of the previously resolved extensions.(((
80 {{image reference="dw-uiStep-installPlan.png"/}}
81 )))
82 * You will be prompted to insert credentials for the Administrator, which are **Admin/admin**.(((
83 {{image reference="dw-uiStep-login.png"/}}
84 )))
85 * After the instalation is complete, you can click on the Continue button to proceed to the next step.
86 * Since this is a clean install, steps 2 and 3 are skipped.
88 == Report step ==
90 {{info}}
91 Since 5.4
92 {{/info}}
94 The last step display all changes brought to the wiki.
96 {{image reference="dw-report.png"/}}
98 = Upgrade =
100 Distribution Wizard also allows you to perform an upgrade without having to manually import the XAR file.
102 {{include reference="" section="HUserInterface"/}}
104 == Orphaned dependencies step ==
106 {{info}}
107 Since 11.10
108 {{/info}}
110 {{image reference="orphaned.png"/}}
112 This step is executed right after the Flavor step.
114 Its job is to make sure no orphaned dependency (extension installed as dependency but which don't have any backward dependency left) is left in the installed extensions. The step suggest to uninstalled the invalid ones by default and make the others top level extensions (i.e. taken into account by the upgrade job).
116 == Wikis ==
118 {{info}}
119 Since 5.3 and only if there is a default UI configured.
120 {{/info}}
122 Distribution Wizard list all the existing wikis with the recommended user interface version that needs to be installed in order to update the default set of wiki pages.
124 {{image reference="dw-wikisStep.png"/}}
126 == Extensions ==
128 {{image reference="dw-extensionsStep-checkForUpdates.png"/}}
130 In the last step you can upgrade the extensions that you may have installed on your wikis. If you are on a subwiki then you can only check for updates for the extensions installed on that subwiki. On the main wiki global administrators can choose between:
132 * computing the upgrade plan only for the main wiki + global namespace
133 * computing the upgrade plan for the entire farm (all wikis + global namespace)
135 The first option is suited when each wiki in the farm is managed by a different entity while the second option is suited when the farm is managed by a single entity. Obviously computing the upgrade plan for the entire farm takes longer (with the number of wikis) than computing the upgrade plan only for the main wiki.
137 {{image reference="dw-extensionsStep-computingUpgradePlan.png"/}}
139 After the upgrade plan is computed there are two categories of extensions listed, as you can see in the image below:
141 * invalid: they don't work with the current XWiki version so they must be upgraded
142 * outdated: they should work with the current XWiki version but there is a newer version available that probably has bug fixes, improvements or new features
144 Under each category, the extensions are sorted by their name, grouped by the namespace (wiki) where they are installed and paginated. In order to complete this step you have to upgrade the invalid extensions. Upgrading the outdated extensions is optional as you can do it later from the [[Extension Updater>>doc:extensions:Extension.Extension Manager Application||anchor="HExtensionUpdater"]] section in the administration.
146 {{image reference="dw-extensionsStep.png"/}}
148 = Upgrade with Repair =
150 In order to be able to do 3-way automatic merges, the Extension Manager, used by the Distribution Wizard, needs to know the user interface version (i.e. default set of wiki pages) that was previously installed. When this information is not available the Distribution Wizard asks the user. This can happen for instance when you upgrade from a very old XWiki version where the default set of wiki pages wasn't installed through the Extension Manager. First you need to tell the Distribution Wizard if you are performing an upgrade or not.
152 {{image reference="dw-uiStep-repair-upgradeQuestion.png"/}}
154 Then you need to select the previous version. You should find your version in the provided list. Otherwise you can click on the pencil icon to enter a different version.
156 {{image reference="dw-uiStep-repair-selectPreviousVersion.png"/}}
158 Once you select a version the Distribution Wizard shows you the extension id that corresponds to that version. Make sure it is the right id.
160 {{image reference="dw-uiStep-repair-suggestPreviousId.png"/}}
162 If it's not the right extension id then you should click on the pencil icon to change it.
164 {{image reference="dw-uiStep-repair-editPreviousId.png"/}}
166 Next you need to repair the previous UI extension. Just click on the Repair button.
168 {{image reference="dw-uiStep-repair.png"/}}
170 Finally you should be able to upgrade the default set of wiki pages like in a normal upgrade.
172 If you have multiple wikis, then the **Wikis** step will allow you to repair the user interface on each of the available wikis. The process is the same as for the main wiki, the one described above.
174 {{image reference="dw-wikisStep-repairPreviousUI.png"/}}
176 {{id name="troubleshooting"/}}
178 = Replay Install or Upgrade =
180 Starting with version 7.1 you can record an install or upgrade and replay it on a different wiki:
182 * You start by following the steps described in the [[Clean Install>>||anchor="HCleanInstall"]], [[Upgrade>>||anchor="HUpgrade"]] or [[Upgrade with Repair>>||anchor="HUpgradewithRepair"]] sections. The decisions you take (e.g. which extension to repair, which extensions to upgrade, merge conflict resolution, page cleanup) are automatically recorded (the XWiki WAR must have version 7.1+).
183 * After you finished with the install/upgrade of the default/recommended UI (XAR), you can install/upgrade additional extensions.
184 * Then you go to the [[Extension History>>extensions:Extension.Extension Manager Application||anchor="HExtensionHistory"]] section in the [[wiki administration>>extensions:Extension.Administration Application]] and export the actions that you wish to be replayed on a different wiki
185 * Access the wiki where you want to replay the recorded actions. When the Distribution Wizard appears, skip it by choosing the "Replay recorded actions" sub-option of the "Later" button from the Welcome step.(((
186 {{image reference="dw-welcomeStep-replayRecordedActions.png"/}}
187 )))
188 * This will take you to the Extension History (works even if the database is empty, but in this case you'll have to login with the ##superadmin## user)(((
189 {{image reference="extensionHistory.png"/}}
190 )))
191 * Import the history file you have previously exported, select the records to replay and replay them. Note that you can replay on multiple wikis at the same time, if you have Programming Rights. If there are questions (e.g. a merge conflict) that don't have an answer in the recorded history file then you will be prompted to answer them.
192 * The Distribution Wizard should not appear next time you restart XWiki, but if it does, just click continue.
194 = Automatic mode =
196 By default you get a wizard when there is things to finish (usually install the user interface) but it's also possible to disable the interactive mode and let the Distribution job runs and take decision automatically.
198 The is several ways to do it:
200 * since 10.2RC1 it's possible to disable interactive more in using the ##distribution.job.interactive## and properties
201 * since 9.1RC1 it's possible start the ##distribution## job trough [[the Job REST API>>Documentation.UserGuide.Features.XWikiRESTfulAPI||anchor="HJobresources"]]
203 {{info}}
204 If you enable automatic mode you might also want to indicate a default UI since the default mode (flavors) won't do much (because it does not know which flavor you want). See [[User Interface>>||anchor="HUserInterface"]] for more details.
205 {{/info}}
207 = Troubleshooting =
209 == The wizard fails to appear at startup ==
211 If you're doing a first time install and the Distribution Wizard doesn't appear it's probably because you've copied some directories from an existing install. Namely, the Distribution Wizard looks for status files located in your permanent directory (the ##environment.permanentDirectory## property in
213 In this case only, you can remove the ##.../jobs/status/distribution/ file located inside your permanent directory (##/var/lib/xwiki/data/...## for [[APT installation>>Documentation.AdminGuide.InstallationViaAPT]] or ##/var/lib/tomcatX/webapps/...## for [[WAR installation>>Documentation.AdminGuide.InstallationWAR]]).
215 {{version before="13.7RC1"}}
216 The status file was not zipped and named: ##.../jobs/status/distribution/status.xml##.
217 {{/version}}
219 Now, if you have done an upgrade of the XWiki WAR, you'll need to be logged with a user having Admin rights to see the Distribution Wizard appear.
221 {{warning}}
222 In order for the Distribution Wizard to be triggered, you have to log in as administrator (or superadmin if database is empty).
223 {{/warning}}
225 == Setting up new XWiki instance without reinstalling ==
227 To set up empty/new XWiki instance you need to clear its database and local file storage.
229 1. (((
230 Empty the main database.
231 For example with MySQL server, you can execute the command:
233 {{code language="none"}}
234 mysql -uroot -p -e "drop database xwiki; CREATE DATABASE xwiki CHARACTER SET utf8 COLLATE utf8_general_ci; GRANT ALL PRIVILEGES ON xwiki.* TO 'xwiki'@'localhost' IDENTIFIED BY 'password';"
235 {{/code}}
237 where ##'password'## is password for xwiki user in MySQL database.
239 You should also delete the subwikis databases if any.
240 )))
241 1. (((
242 To clear local data in filesystem empty or remove the permanent directory (see environment.permanentDirectory property in file).
244 For example if you have installed XWiki using [[APT>>Documentation.AdminGuide.InstallationViaAPT]], execute command:
246 {{code language="none"}}
247 sudo rm -fr /var/lib/xwiki/data /var/cache/tomcat7/Catalina/localhost/xwiki/
248 {{/code}}
249 )))
250 1. Restart the application server, open e.g. [[http://localhost:8080/xwiki]] and rerun distribution wizard again.
252 == Disable the automatic start of Distribution Wizard {{info}}(Since 7.1RC1){{/info}} ==
254 If, for some reason, you need to disable the Distribution Wizard when you start the wiki for the first time, you can change the configuration in
256 {{code language="cfg"}}
257 #-------------------------------------------------------------------------------------
258 # Distribution Wizard
259 #-------------------------------------------------------------------------------------
261 #-# [Since 7.1RC1] Enable or disable the automatic start of Distribution Wizard on empty/outdated wiki.
262 #-#
263 #-# The default is:
264 # distribution.automaticStartOnMainWiki=true
265 # distribution.automaticStartOnWiki=true
266 {{/code}}
268 You just need to uncomment the above two lines and to set the options to ##false##.

Get Connected