Wiki source code of XWiki Enterprise Manager Installation

Last modified by Milton Ferreira on 2013/07/09 21:53
Hide line numbers
  1: {{box cssClass="floatinginfobox" title="**Contents**"}}
  2: {{toc/}}
  3: {{/box}}
  4: 
  5: = Install XEM from a distribution =
  6: 
  7: This is the easiest way to install XEM.
  8: 
  9: XEM is directly based on XE and can be installed exactly like it in most part ([[platform:AdminGuide.Installation]]).
 10: 
 11: The main differences/restrictions are :
 12: 
 13: * Uses the XEM WAR and XAR distributions which you can find on the [[download>>Main.Download]] page (instead of XE ones).
 14: * Currently, XEM only fully supports MySQL and Oracle RDBMS.
 15: * 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:(((
 16: {{code language="sql"}}
 17: mysql -u root -e "grant all privileges on *.* to xwiki@127.0.0.1 identified by 'xwiki'"
 18: {{/code}}
 19: )))
 20: 
 21: == Tutorials ==
 22: 
 23: * [[Step by step minimum install of XEM based on MySQL>>AdminGuide.InstallationMySQL]]
 24: 
 25: = Install XEM using Debian (.DEB) Packages and Extension Manager =
 26: 
 27: {{info}}
 28: Supported since Version 4.2
 29: {{/info}}
 30: 
 31: * Do a standard[[ XWiki Enterprise Installation using the Debian Package>>platform:AdminGuide.InstallationViaAPT]]
 32: ** do not forget to give Tomcat enough memory (described in installation page)
 33: ** do not import default XE pages as XAR manually
 34: ** use the new Distribution Manager to gather the default Wiki pages
 35: * Follow instructions on [[Convert an existing XWiki Enterprise instance with Extension Manager>>||anchor="HUsingExtensionManager"]]
 36: 
 37: = Convert an existing XWiki Enterprise instance =
 38: 
 39: * 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:(((
 40: {{code language="sql"}}
 41: mysql -u root -e "grant all privileges on *.* to xwiki@127.0.0.1 identified by 'xwiki'"
 42: {{/code}}
 43: )))
 44: 
 45: == Using Extension Manager ==
 46: 
 47: {{info}}
 48: Supported since Version 4.1
 49: {{/info}}
 50: 
 51: * Go to the Administration page and browse to the Extension Manager
 52: * 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)
 53: * Install it
 54: * Go to the main wiki descriptor (http://host/xwiki/bin/view/XWiki/XWikiServerXwiki) and set the right domain name (and add aliases if needed)
 55: * Set your wiki as "virtual" to allow multiple wikis. For this, edit your ##xwiki.cfg## file and set the ##xwiki.virtual## property to ##1##:(((
 56: {{code language="sql"}}
 57: xwiki.virtual=1
 58: {{/code}}
 59: )))
 60: * Restart XWiki
 61: * Go to //XemManager.Install// page (http://host/xwiki/bin/view/XemManager/Install) and follow instructions
 62: 
 63: == Using Distribution Wizard ==
 64: 
 65: {{info}}
 66: Supported since Version 4.2
 67: {{/info}}
 68: 
 69: * stop XWiki
 70: * 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)
 71: * 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
 72: * Go to //XemManager.Install// page (http://host/xwiki/bin/view/XemManager/Install) and follow instructions
 73: 
 74: == Manually ==
 75: 
 76: In order to transform an existing wiki into XEM you will need to:
 77: 
 78: * Install the Application Manager [[plugin>>extensions:Extension.Application Manager Plugin]] ([[Download>>http://nexus.xwiki.org/nexus/content/groups/public/org/xwiki/platform/xwiki-platform-application-manager-api/||rel="__blank"]]) and [[application>>extensions:Extension.Application Manager Application]] ([[Download>>http://nexus.xwiki.org/nexus/content/groups/public/org/xwiki/platform/xwiki-platform-application-manager-ui/||rel="__blank"]]).
 79: ** This means downloading the plugin and putting it in ##WEB-INF/lib##
 80: ** For the application, use the [[Import Tool>>platform:AdminGuide.ImportExport]] to import the XAR you have downloaded
 81: * Install the Wiki Manager [[plugin>>extensions:Extension.Wiki Manager Plugin]] ([[Download>>http://nexus.xwiki.org/nexus/content/groups/public/org/xwiki/platform/xwiki-platform-wiki-manager-api/||rel="__blank"]]) and [[application>>extensions:Extension.Wiki Manager Application]] ([[Download>>http://nexus.xwiki.org/nexus/content/groups/public/org/xwiki/platform/xwiki-platform-wiki-manager-ui/||rel="__blank"]]).
 82: ** Same thing as before: download the plugin and put it in ##WEB-INF/lib## then download the application and import the XAR.(((
 83: {{warning}}
 84: 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.
 85: {{/warning}}
 86: )))
 87: * Install the Workspace [[module>>extensions:Extension.Workspace Module]] ([[Download>>http://nexus.xwiki.org/nexus/content/groups/public/org/xwiki/platform/xwiki-platform-workspace-ui/]]) and [[application>>extensions:Extension.Workspace Application]] ([[Download>>http://nexus.xwiki.org/nexus/content/groups/public/org/xwiki/platform/xwiki-platform-workspace-api/]]).
 88: ** Again, same thing as before: download the component and put it in ##WEB-INF/lib## then download the application and import the XAR.
 89: * [**Applicable only for versions older than 3.3**] Edit your ##xwiki.cfg## file and add the following entries to activate the plugins:(((
 90: {{code}}
 91: xwiki.plugins=\
 92:   [...]
 93:   com.xpn.xwiki.plugin.wikimanager.WikiManagerPlugin,\
 94:   com.xpn.xwiki.plugin.applicationmanager.ApplicationManagerPlugin
 95: {{/code}}
 96: )))
 97: * [optional] Import the [[XEM application xar>>Main.Download]]. This just adds some links, modifies the home page and adds a main wiki default descriptor (since XEM 1.0M3).
 98: * [optional] If your main wiki's domain name does not start with "www" (or will not be accessed by IP or "localhost")
 99: ** 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)
100: ** 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.
101: * set your wiki as "virtual" to allow multiple wikis. For this, edit your ##xwiki.cfg## file and set the ##xwiki.virtual## property to ##1##:(((
102: {{code language="sql"}}
103: xwiki.virtual=1
104: {{/code}}
105: )))
Wiki source code of XWiki Enterprise Manager Installation

Quick Links

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected
