Wiki source code of Install and Configure a Relational Database
Last modified by Eleni Cojocariu on 2026/08/25 11:43
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{warning}} | ||
| 2 | WIP: documentation of this topic is being refactored. For full documentation please refer to [[Install and configure a Relational Database>>Documentation.AdminGuide.Installation.InstallationWAR.WebHome||anchor="HInstallandconfigureaRelationalDatabase"]]. | ||
| 3 | {{/warning}} | ||
| 4 | |||
| 5 | To install and configure a relational database for XWiki: | ||
| 6 | |||
| 7 | 1. Install a [[supported relational database>>dev:Community.SupportStrategy.DatabaseSupportStrategy]] management system. | ||
| 8 | 1. Create an XWiki database. | ||
| 9 | 1. Create a user with all privileges on that database. | ||
| 10 | 1. Copy the JDBC driver for your database into the XWiki web application's ##WEB-INF/lib## directory. | ||
| 11 | 1. Configure XWiki to use the database by editing the ##WEB-INF/hibernate.cfg.xml## file, as described in the documentation for each database. | ||
| 12 | 1. Start XWiki. It creates the tables it needs on its first run. | ||
| 13 | 1. [[Add the missing indexes manually>>Documentation.AdminGuide.Performances.Database Administration.WebHome]]. | ||
| 14 | |||
| 15 | Follow the database-specific documentation for the officially supported databases: | ||
| 16 | |||
| 17 | * [[Configure HSQLDB>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.install-relational-database.configure-hsqldb.WebHome]], which runs embedded and is meant for evaluation rather than production. | ||
| 18 | * [[Configure MariaDB>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.install-relational-database.configure-mariadb.WebHome]]. | ||
| 19 | * [[MySQL>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationMySQL.WebHome]]. | ||
| 20 | * [[Configure PostgreSQL Manually>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.install-relational-database.configure-postgresql-manually.WebHome]], or [[Configure PostgreSQL for XWiki in Docker>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.install-relational-database.configure-postgresql-docker.WebHome]]. | ||
| 21 | * [[Configure Oracle Manually>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.install-relational-database.configure-oracle-manually.WebHome]], [[Configure Oracle for XWiki in Docker>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.install-relational-database.configure-oracle-docker.WebHome]], or [[Configure Oracle in a Virtual Machine>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.install-relational-database.configure-oracle-vm.WebHome]]. | ||
| 22 | |||
| 23 | Whichever database you use, XWiki can also take its connections from a [[data source managed by the servlet container>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.install-relational-database.use-container-managed-data-source.WebHome]] instead of opening them itself. | ||
| 24 | |||
| 25 | XWiki uses Hibernate for persistence, so it may also work with the databases below. They receive no consistent testing, and issues are fixed only when they are easy to resolve or a patch is provided: | ||
| 26 | |||
| 27 | * [[H2>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationH2.WebHome]]. | ||
| 28 | * [[IBM DB2>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationDB2.WebHome]]. | ||
| 29 | * [[Apache Derby>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationDerby.WebHome]]. |
