Wiki source code of Installation Methods
Last modified by Eleni Cojocariu on 2026/05/12 10:20
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | If you want to test the features of XWiki, you can [[try XWiki in Cloud>>Hosted.WebHome]]. This is by far the simplest to try XWiki since you don't need to install anything. | ||
| 2 | |||
| 3 | == Installation methods for non-production environments == | ||
| 4 | |||
| 5 | If you want to explore the features, or test new versions in a non-production environment, the following installation methods are highly recommended: | ||
| 6 | |||
| 7 | * [[Install a Standalone (Demo) Distribution>>documentation.xs.admin.installation.methods.install-standalone-demo-distribution.WebHome]].: Provides a built-in XWiki, with a portable database (HSQLDB) and a lightweight Java container (Jetty). | ||
| 8 | * [[Using an official XWiki Docker image>>https://hub.docker.com/_/xwiki/]]: Provides an easy solution to test XWiki, without manually installing or configuring a servlet container. | ||
| 9 | |||
| 10 | == Installation methods for production environments == | ||
| 11 | |||
| 12 | For production environments, where data persistence, reliability, and performance are required, the following methods are recommended: | ||
| 13 | |||
| 14 | * [[Using ##.deb## package>>Documentation.AdminGuide.InstallationViaAPT]]: 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. | ||
| 15 | * [[Using an official XWiki Docker image>>https://hub.docker.com/_/xwiki/]]: You can also use this method in production if you're used to putting Docker images in production. | ||
| 16 | |||
| 17 | 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: | ||
| 18 | |||
| 19 | * [[Using ##.war## package>>Documentation.AdminGuide.InstallationWAR]]: 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. | ||
| 20 | |||
| 21 | Before installing, make sure to check the [[prerequisites>>documentation.xs.admin.installation.prerequisites.WebHome]] of these installation methods. If you encounter troubles, consult the [[troubleshootings>>documentation.xs.admin.installation.troubleshooting.WebHome]]. |
