Wiki source code of Creating a Multi-tenant environment
Version 17.2 by Manuel Smeria on 2012/12/12
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}}{{toc/}}{{/box}} | ||
| 2 | |||
| 3 | A [[multi-tenant>>http://en.wikipedia.org/wiki/Multitenancy]] setup (a.k.a "virtual mode", "multi-wiki" or "farm mode") allows you to have several wikis running on the same XWiki instance (i.e. in the same JVM). | ||
| 4 | |||
| 5 | Each wiki has its own database schema, thus allowing for a complete data separation between the different wikis in the same instance. | ||
| 6 | |||
| 7 | The main advantage of multi-tenancy is performance optimization. A single XWiki instance on a physical machine (thus a single Servlet Container) will perform much better than having several XWiki instances running on the same machine, which wouldn't scale. As an example known XWiki multi-tenant instances host several thousands hundreds to several thousands wikis on a single XWiki instance. | ||
| 8 | |||
| 9 | = Requirements = | ||
| 10 | |||
| 11 | The multi-tenancy feature currently works only on some databases: | ||
| 12 | * Databases known to work are: MySQL, Oracle and HSQLDB (starting with XWiki 4.3M1) | ||
| 13 | * PostgreSQL is currently not supported as the JDBC driver doesn't support setCatalog() for changing databases. That's because PostgreSQL connections are pointed to a specific database at connection time (see jira issue [[XWIKI-1960>>http://jira.xwiki.org/jira/browse/XWIKI-1960]]) | ||
| 14 | * [[Derby is currently not supported>>http://jira.xwiki.org/browse/XWIKI-8244]] | ||
| 15 | |||
| 16 | In addition to having a supported database you'll also need: | ||
| 17 | * Choosing one instance of XWiki that has been installed on your network. The database name for this wiki should be ##xwiki##. If you've still got to install the XWiki instance, please refer to [[the installation guide>>AdminGuide.Installation]] and install XWiki Enterprise first | ||
| 18 | * Admin privileges on this XWiki instance | ||
| 19 | * You need to be sure that the ##xwiki## user used to create the main database has the correct permissions to be able to create other schemas since each subwiki will create a new database schema | ||
| 20 | * You need to be able to restart the java container (e.g. Tomcat or Jetty), or can have this restarted on demand. | ||
| 21 | ** The ##xwiki.cfg## file will also have to be modified, so you will need to have write access to this file on the server | ||
| 22 | |||
| 23 | = Set up = | ||
| 24 | |||
| 25 | * Stop your XWiki instance, edit the ##WEB-INF/xwiki.cfg## file, look for the ##xwiki.virtual## property and set it to ##1##: {{code}}xwiki.virtual=1{{/code}} | ||
| 26 | * Restart your XWiki instance | ||
| 27 | * Install the [[Wiki Manager Application>>extensions:Extension.Wiki Manager Application]] | ||
| 28 | |||
| 29 | Starting with XWiki Enterprise 3.3 you can easily install the Wiki Manager Application using the Extension Manager by following these steps: | ||
| 30 | * Go to the administration page and click on "Add Extensions" under "Extension Manager" | ||
| 31 | * Click on "Advanced search" and enter the following information: | ||
| 32 | ** extension id: ##org.xwiki.platform:xwiki-platform-wiki-manager-ui## | ||
| 33 | ** extension version: ##4.3## (adapt to the version you wish to install; make it match the version of the XWiki Enterprise you're using) | ||
| 34 | * Click "Search" | ||
| 35 | * Click "Install" | ||
| 36 | * Click "Apply" | ||
| 37 | * Verify that the Wiki Manager extension is correctly installed by navigating to the [[WikiManager WebHome page>>http://localhost:8080/xwiki/bin/view/WikiManager/WebHome]] which should now exist | ||
| 38 | |||
| 39 | You now have a multi-tenant installation and can proceed to use the [[Wiki Manager Application>>extensions:Extension.Wiki Manager Application]] to create subwikis. |
