Wiki source code of Prerequisites
Last modified by Eleni Cojocariu on 2026/05/19 09:34
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | There are some common prerequisites (hardware and software requirements) for all [[methods of installation>>documentation.xs.admin.installation.WebHome]]: | ||
| 2 | |||
| 3 | * A [[supported browser>>dev:Community.BrowserSupportStrategy]] to access XWiki. | ||
| 4 | * Enough memory, check the [[Memory section>>Documentation.AdminGuide.Performances.WebHome||anchor="HMemory"]] of the [[Performance Guide>>Documentation.AdminGuide.Performances.WebHome]]. | ||
| 5 | * Enough [[CPU and RAM>>Documentation.AdminGuide.Performances.WebHome||anchor="HSizing"]]. | ||
| 6 | |||
| 7 | Each [[installation method>>documentation.xs.admin.installation.WebHome]] requires specific prerequisites. Below, there is a list of the installation methods along with the corresponding requirements for each: | ||
| 8 | |||
| 9 | |=Purpose|=Installation method|=Prerequisites | ||
| 10 | |(% rowspan="2" %)Testing|[[Install a Standalone (Demo) Distribution>>documentation.xs.admin.installation.methods.install-standalone-demo-distribution.WebHome]]|((( | ||
| 11 | * A [[supported Java Runtime Environment>>dev:Community.SupportStrategy.JavaSupportStrategy.WebHome]] (JRE). | ||
| 12 | * No external servlet container or database needs to be installed or configured. | ||
| 13 | ))) | ||
| 14 | |[[Using an official XWiki Docker image>>https://hub.docker.com/_/xwiki/]]|((( | ||
| 15 | * [[Docker Engine>>https://docs.docker.com/engine/]] installed on the host system. | ||
| 16 | * No Java installation or external database is required for testing purposes. | ||
| 17 | ))) | ||
| 18 | |(% rowspan="3" %)Production|[[Using ##.deb## package>>Documentation.AdminGuide.InstallationViaAPT]]|((( | ||
| 19 | * A [[Debian-based Linux>>https://wiki.debian.org/]] distribution | ||
| 20 | * Depending on the [[##.deb## package>>Documentation.AdminGuide.InstallationViaAPT]] you choose, you may need a supported database (any database supporting JDBC 4.2, with a JDBC 4.2 driver) and/or a supported servlet container.((( | ||
| 21 | * Database: Any database that supports JDBC 4.2 and provides a JDBC 4.2 driver. However, we recommend using one of the [[supported databases>>dev:Community.DatabaseSupportStrategy]]. | ||
| 22 | * Servlet Container: Any servlet container that supports Servlet 3.1. However, we recommend using one of the [[supported servlet containers>>dev:Community.ServletContainerSupportStrategy.WebHome]]. | ||
| 23 | ))) | ||
| 24 | * Note: The [[Java Runtime Environment>>dev:Community.SupportStrategy.JavaSupportStrategy.WebHome]] (JRE) is automatically installed as a dependency by the package manager. Depending on your selection, the package manager will install all necessary dependencies, including the application server, database, and JRE. If any of these components are not already installed on your system, the package manager may prompt you for additional information during installation. | ||
| 25 | ))) | ||
| 26 | |[[Using an official XWiki Docker image>>https://hub.docker.com/_/xwiki/]]|((( | ||
| 27 | * [[Docker Engine>>https://docs.docker.com/engine/]] installed on the host system. | ||
| 28 | * Any database that supports JDBC 4.2 and a JDBC 4.2 driver for your database. However, we recommend using one of the [[supported databases>>dev:Community.DatabaseSupportStrategy]]. | ||
| 29 | * [[Persistent storage configured>>||anchor="HWhyispersistentstorageneeded3F"]] for XWiki data. | ||
| 30 | ))) | ||
| 31 | |[[Using ##.war## package>>Documentation.AdminGuide.InstallationWAR]]|((( | ||
| 32 | * A [[supported Java Runtime Environment>>dev:Community.SupportStrategy.JavaSupportStrategy.WebHome]] (JRE). | ||
| 33 | * Any Servlet Container that supports Servlet 3.1. However, we recommend using one of the [[supported servlet containers>>dev:Community.ServletContainerSupportStrategy.WebHome]]. | ||
| 34 | * Any database that supports JDBC 4.2 and a JDBC 4.2 driver for your database. However, we recommend using one of the [[supported databases>>dev:Community.DatabaseSupportStrategy]]. | ||
| 35 | ))) |
