Installation
XWiki is a Java-based wiki and runs on a Servlet Container such as Tomcat, Jetty, JBoss, WebLogic, WebSphere, etc. It also uses a relational database to store its content. It can run on almost any database (HSQL, MySQL, etc) but XWiki and the database need to be setup correctly.
There are 2 solutions when installing XWiki:
- Use the Standalone distribution which already packages a Servlet Container (Jetty) and a database (HSQL). This is the recommended option for first time XWiki users and for users who wish to quickly try out XWiki.
- Use the WAR distribution and configure both your container and your database to work with it.
- Use the .deb package to install last version of XWiki and the dependencies.
If you're instead upgrading an existing XWiki install check the Upgrade instructions page.
Pick one of the trails in the outline on the right to get started.
Once you've finished the installation check the other topics in the Admin Guide for configuring and securing your wiki.
Tutorials
Tutorials are step by step procedures to install XWiki for a specific configuration. You can choose to follow one of them or follow the instructions in the sections below.
- XWiki On Windows (French)
- XWiki On Debian 4 (Etch) - Tomcat - PostgreSQL (or MySQL) (English)
- XWiki On Debian 4 (Etch) - Tomcat - PostgreSQL (or MySQL) (German)
- XWiki On Windows - GlassFish - Oracle (Russian)
- XWiki on OpenSUSE - Tomcat - MySQL (English)
Prerequisites
- Java 6 or greater installed.
- A minimum of 300MB of heap memory and 96MB of permGen. Recommended value are above 512MB for the heap and 128MB for the permGen (-Xmx512m -XX:MaxPermSize=128m)
- Check the Release Notes for the version you're installing to see what Browsers and Databases are supported for it. You can also check our general Support Strategy.
Installation Methods
Using a standalone distribution
It provides a built-in XWiki, with a portable database and a lightweight Java container.
Standalone distribution is not recommended in a production environment. If you need to use it in a production basis, you may look at the two other options
Using .war package (usable for production)
It provides a java application package that have to be installed in a Java container (such as Tomcat). This can be used on almost every operating systems.
Using .deb package (usable for production)
It provides a .deb package that can be used on a Debian-based operating system. It can be installed with dpkg or apt, installation is thus automated.
Troubleshooting
You can verify some basic settings of your XWiki install (on Tomcat, MySQL) using the Admin Tools application. Keep in mind that some of these tools only work in a Linux environment.