Wiki source code of Distribution Wizard

Version 20.1 by Marius Dumitru Florea on 2013/09/24

Hide last authors
Sorin Burjan 1.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
Marius Dumitru Florea 16.1 2 {{toc/}}
Sorin Burjan 1.1 3 {{/box}}
4
Marius Dumitru Florea 15.1 5 Starting with XWiki 4.2, the Distribution Wizard (also known as DW) was introduced as an experimental feature which helps users migrate their XWiki instances to newer versions without having to manually import the XAR (wiki pages) corresponding to their new version.
Sorin Burjan 1.1 6
Marius Dumitru Florea 15.1 7 XWiki's Distribution Wizard comes as an aid to ease the migration and installation of the desired user interface (UI, the default set of wiki pages) in your flavour. 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 conection in order to work.
Sorin Burjan 1.1 8
Marius Dumitru Florea 15.1 9 = Clean Install =
Sorin Burjan 1.1 10
Marius Dumitru Florea 15.1 11 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.
Sorin Burjan 1.1 12
Marius Dumitru Florea 15.1 13 == Welcome Step ==
Sorin Burjan 1.1 14
15 Upon first access, you will be greeted by the Distribution Wizard, offering you the 3 possible options:
Marius Dumitru Florea 15.1 16
Sorin Burjan 1.1 17 * **Continue** - when choosing this option, you will move to the next step of the Distribution Wizard
18 * **Skip** - DW will prompt you again after XWiki is restarted. This option is available from all the steps within DW.
19 * **Cancel** - Cancels the DW and you will have to manually import the XAR. This option is available from all the steps within DW.
20
Marius Dumitru Florea 19.1 21 {{image reference="dw-welcomeStep.png"/}}
Sorin Burjan 1.1 22
Marius Dumitru Florea 15.1 23 == User Interface ==
24
Sorin Burjan 1.1 25 The first step will check your XWiki version and will propose a version of the UI which is suited for your version.
26
Marius Dumitru Florea 15.1 27 * Click on **Install** to install the proposed UI. This will resolve the extensions that are going to be installed.(((
Sorin Burjan 13.1 28 {{image reference="DW_Clean_2.png"/}}
Marius Dumitru Florea 15.1 29 )))
30 * Click on the **Continue** button. This will start the actual installation of the previously resolved extensions.(((
Sorin Burjan 1.1 31 [[image:DW_Clean_3.png]]
Marius Dumitru Florea 15.1 32 )))
33 * You will be prompted to insert credentials for the Administrator, which are **Admin/admin**.(((
Sorin Burjan 13.1 34 {{image reference="DW_Clean_4.png"/}}
Marius Dumitru Florea 15.1 35 )))
Sorin Burjan 1.1 36 * After the instalation is complete, you can click on the Continue button to proceed to the next step.
Marius Dumitru Florea 15.1 37 * Since this is a clean install, steps 2 and 3 are skipped.
Sorin Burjan 1.1 38
Marius Dumitru Florea 20.1 39 = Upgrade =
Sorin Burjan 1.1 40
41 Distribution Wizard also allows you to perform an upgrade without having to manually import the XAR file.
42
Marius Dumitru Florea 15.1 43 == User Interface ==
Sorin Burjan 1.1 44
Marius Dumitru Florea 15.1 45 * The Distribution Wizard detects that the UI version is not the latest and proposes to upgrade. Click on the **Upgrade** button.(((
Sorin Burjan 13.1 46 {{image reference="DW_Upgrade_2.png"/}}
Marius Dumitru Florea 15.1 47 )))
48 * After resolving the required dependencies, click **Continue** button to begin the actual instalation of the new UI(((
Sorin Burjan 13.1 49 {{image reference="DW_Upgrade_3.png"/}}
Marius Dumitru Florea 15.1 50 )))
51 * During the instalation you might get merge conflicts. Althrough XWiki does automatically a 3 way merge, sometimes the merge might fail. Solve your conflict and click on **Continue**(((
Sorin Burjan 13.1 52 {{image reference="DW_Upgrade_4.png"/}}
Marius Dumitru Florea 15.1 53 )))
Marius Dumitru Florea 20.1 54
55 == Upgrade Mode ==
56
57 If you have several wikis you can migrate them all from one click, without having to do so manually
58
Sorin Burjan 13.1 59 {{image reference="DW_Upgrade_5.png"/}}
Marius Dumitru Florea 20.1 60
61 == Wikis ==
62
63 == Extensions ==

Get Connected