Installation Methods
Explanation
If you want to test the features of XWiki, you can try XWiki in Cloud. This is by far the simplest to try XWiki since you don't need to install anything.
Installation methods for non-production environments
If you want to explore the features, or test new versions in a non-production environment, the following installation methods are highly recommended:
- Install a Standalone (Demo) Distribution.: Provides a built-in XWiki, with a portable database (HSQLDB) and a lightweight Java container (Jetty).
- Using an official XWiki Docker image: Provides an easy solution to test XWiki, without manually installing or configuring a servlet container.
Installation methods for production environments
For production environments, where data persistence, reliability, and performance are required, the following methods are recommended:
- Using .deb package: 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.
- Using an official XWiki Docker image: You can also use this method in production if you're used to putting Docker images in production.
You could also manually deploy XWiki as a WAR into the Servlet Container of your choice and on the Database of your choice, if the previous methods were not good enough for your needs. Beware that this requires some technical knowledge about Servlet Container and Databases:
- Using .war package: Requires manual deployment of XWiki into a servlet container (such as Tomcat or Jetty) and explicit configuration of an external database. This requires some technical knowledge about Servlet Container and Databases. The WAR is a Java application package that can run on almost any operating system, provided a compatible Java environment and servlet container are available.
Before installing, make sure to check the prerequisites of these installation methods. If you encounter troubles, consult the troubleshootings.
FAQ
Why do I need to create database indexes manually?
For production installations, XWiki may not automatically create all required database indexes. Administrators must therefore verify that the necessary indexes exist and manually create any missing ones to ensure good performance.
Can I install XWiki offline?
After choosing one of the XWiki installation methods above, if you prefer to continue offline, you can install the XIP package. This package contains an offline extension repository with all the extensions that make up the Standard Flavor, allowing you to set up XWiki without an internet connection.
More
To find more about the current topic, you can search or use the table below and filter the columns to narrow your choices.