Install XEM from a distribution

This is the easiest way to install XEM.

XEM is directly based on XE and can be installed exactly like it in most part (Installation).

The main differences/restrictions are :

• Uses the XEM WAR and XAR distributions which you can find on the download page (instead of XE ones).
• Currently, XEM only fully supports MySQL and Oracle RDBMS.
• In order for XEM to be able to create new wikis on demand, you will need to give all rights to your database user. For example for MySQL, execute:
  mysql -u root -e "grant all privileges on *.* to [email protected] identified by 'xwiki'"

Tutorials

• Step by step minimum install of XEM based on MySQL

Install XEM using Debian (.DEB) Packages and Extension Manager

• Do a standard XWiki Enterprise Installation using the Debian Package
  • do not forget to give Tomcat enough memory (described in installation page)
  • do not import default XE pages as XAR manually
  • use the new Distribution Manager to gather the default Wiki pages
• Follow instructions on Convert an existing XWiki Enterprise instance with Extension Manager

Convert an existing XWiki Enterprise instance

• In order for XEM to be able to create new wikis on demand, you will need to give all rights to your database user. For example for MySQL, execute:
  mysql -u root -e "grant all privileges on *.* to [email protected] identified by 'xwiki'"

Using Extension Manager

• Go to the Administration page and browse to the Extension Manager
• Choose 'Add Extension' and do an advanced search for the id org.xwiki.manager:xwiki-manager-ui in the preferred version (generally the current XE version)
• Install it
• Go to the main wiki descriptor (http://host/xwiki/bin/view/XWiki/XWikiServerXwiki) and set the right domain name (and add aliases if needed)
• Set your wiki as "virtual" to allow multiple wikis. For this, edit your xwiki.cfg file and set the xwiki.virtual property to 1:
  xwiki.virtual=1
• Restart XWiki
• Go to XemManager.Install page (http://host/xwiki/bin/view/XemManager/Install) and follow instructions

Using Distribution Wizard

• stop XWiki
• replace the war you are using with the XEM one (take care of properly merging any files you might have modified like xwiki.cfg and xwiki.properties)
• when you restart XWiki you will get the Distribution Wizard telling you that you changed the distribution from XE to XEM and asking you to install XEM UI
• Go to XemManager.Install page (http://host/xwiki/bin/view/XemManager/Install) and follow instructions

Manually

In order to transform an existing wiki into XEM you will need to:

• Install the Application Manager plugin (Download) and application (Download).
  • This means downloading the plugin and putting it in WEB-INF/lib
  • For the application, use the Import Tool to import the XAR you have downloaded
• Install the Wiki Manager plugin (Download) and application (Download).
  • Same thing as before: download the plugin and put it in WEB-INF/lib then download the application and import the XAR.

    If you already have an XWiki.XWikiServerClass class document make sure not to overwrite it at import time unless it contains exactly the same properties. Otherwise you could get a conflict in the descriptors of already existing wikis.

• Install the Workspace module (Download) and application (Download).
  • Again, same thing as before: download the component and put it in WEB-INF/lib then download the application and import the XAR.
• [Applicable only for versions older than 3.3] Edit your xwiki.cfg file and add the following entries to activate the plugins:
  xwiki.plugins=\
    [...]
    com.xpn.xwiki.plugin.wikimanager.WikiManagerPlugin,\
    com.xpn.xwiki.plugin.applicationmanager.ApplicationManagerPlugin
• [optional] Import the XEM application xar. This just adds some links, modifies the home page and adds a main wiki default descriptor (since XEM 1.0M3).
• [optional] If your main wiki's domain name does not start with "www" (or will not be accessed by IP or "localhost")
  • if you`ve imported the XEM application, just go to the descriptor (http://host/xwiki/bin/view/XWiki/XWikiServerXwiki) and modify the domain name (and add all needed aliases)
  • if you did not import the XEM application, you will have to create a wiki server descriptor for it: create the XWiki.XWikiServerXwiki page and add an XWiki.XWikiServerClass object in it with the proper domain name.
• set your wiki as "virtual" to allow multiple wikis. For this, edit your xwiki.cfg file and set the xwiki.virtual property to 1:
  xwiki.virtual=1