Update docker README for XWiki (#22700)

This commit is contained in:
Yauheni Suhakou
2026-04-13 17:44:17 +02:00
committed by GitHub
parent 9eeb5418fa
commit a748b68496
2 changed files with 57 additions and 3 deletions
+35 -3
View File
@@ -1,7 +1,6 @@
# Setup guide
A minimal setup guide for using a local XWiki inside a docker stack. The example compose file is connected to the
standard setup of the TLS-ready stack with `traefik`.
A minimal setup guide for using a local XWiki inside a docker stack. The example compose file is connected to the standard setup of the [TLS-ready](https://www.openproject.org/docs/development/development-environment/docker/#tls-support) stack with `traefik`.
## First steps
@@ -9,4 +8,37 @@ standard setup of the TLS-ready stack with `traefik`.
- Go to https://xwiki.local
- Wait for initialisation to succeed
- Create admin user
- Select XWiki standard flavor and install it
- Select XWiki standard flavor and install it**this is highly recommended** as many XWiki
features and the OpenProject plugin depend on it
## Recommended extensions
For integration with OpenProject, install the following after the standard flavor is set up:
- **[OpenProject Integration](https://store.xwiki.com/xwiki/bin/view/Extension/OpenProjectIntegration)** — connects XWiki with OpenProject
Install it via the Extension Manager (Administration → Extensions → search for "OpenProject Integration").
## Updating XWiki
To update XWiki to a newer version, pull the latest image and recreate the container:
```bash
docker compose --project-directory docker/dev/xwiki/ pull
docker compose --project-directory docker/dev/xwiki/ up -d
```
After the container starts, go to <https://xwiki.local> — XWiki will detect the new version and
present an upgrade wizard. Follow it to completion before using XWiki again.
## Certificates
### Trusting the local CA in XWiki (for outbound HTTPS calls)
XWiki runs on Java/Tomcat which has its own certificate truststore, independent of the system CA
bundle. If XWiki needs to make HTTPS requests to OpenProject (e.g. for OAuth), it must trust the
local step-ca root certificate.
Copy `docker-compose.override.example.yml` to `docker-compose.override.yml` — it wraps the XWiki
entrypoint to automatically import the step-ca certificate into Java's truststore on every container
start, including after recreations. Requires the TLS stack (`docker/dev/tls`) to be running.
@@ -0,0 +1,22 @@
services:
web:
volumes:
- step-certs:/step:ro
# Automatically imports the local step-ca root certificate into Java's truststore on every
# container start, so XWiki can make HTTPS calls to OpenProject without certificate errors.
# Requires the TLS stack (docker/dev/tls) to be running.
entrypoint:
- /bin/bash
- -c
- |
keytool -import -trustcacerts \
-keystore /opt/java/openjdk/lib/security/cacerts \
-storepass changeit -noprompt \
-alias step-ca \
-file /step/certs/root_ca.crt 2>/dev/null || true
exec docker-entrypoint.sh xwiki
volumes:
step-certs:
external: true
name: tls_step # volume created by the TLS stack (docker/dev/tls)