XWiki Docker Image Configuration
Last modified by Vincent Massol on 2026/07/27 17:54
Content
Explanation
The XWiki Docker image ships a complete XWiki installation running on Tomcat, and is meant to be configured from outside the container: changing how an instance behaves never requires rebuilding it.
Configuration happens at three levels, from the simplest to the most invasive:
- Environment variables passed to the container are the first level, and the only one most instances need. They cover the database connection, the servlet context path, the Solr endpoint, and JAVA_OPTS for JVM settings such as those used to debug XWiki remotely.
- The configuration files cover everything the environment variables do not expose. They are written on the container's first start and then kept in the permanent directory, so your own changes survive later starts.
- Tomcat's own configuration is the last resort, for connector settings and other servlet-container behaviour that the XWiki configuration does not reach.
Independently of the level, anything that has to outlive the container, namely the permanent directory and the database, belongs on a Docker volume or a bind mount. That is what makes an upgrade a matter of replacing the container while keeping the data.
More
To find more about the current topic, you can search, select an highlighted topic, or use the table below and filter the columns to narrow your choices.
- Environment Variables of the XWiki Docker Image
- Every variable the container reads, and what each one sets.
- Configuration Files in the XWiki Docker Image
- Which files XWiki is configured through, and where they live in the container.
- Docker Volumes Used by XWiki Containers
- What to persist so that data survives replacing the container.
- XWiki Logs in the Docker Image
- Where the logs are, and how to read them from the host.
- HTTPS for XWiki in Docker
- Serve the instance over HTTPS.
