From d24fab3e612bca3fbbeb6a18d1e71b8a80a9863c Mon Sep 17 00:00:00 2001 From: Vincent Massol Date: Thu, 17 Aug 2017 14:06:34 +0200 Subject: [PATCH 1/2] Added explanations on how to upgrade XWiki + added info on additional configuration --- xwiki/content.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/xwiki/content.md b/xwiki/content.md index 33510db16..39eb6d59f 100644 --- a/xwiki/content.md +++ b/xwiki/content.md @@ -206,6 +206,20 @@ Note that if you want to set a custom version of XWiki you can edit the `.env` f Note that `docker-compose up` will automatically build the XWiki image on the first run. If you need to rebuild it you can issue `docker-compose up --build`. You can also build the image with `docker build . -t xwiki-mysql-tomcat:latest` for example. +# Upgrading XWiki + +You've installed an XWiki docker image and used it and now comes the time when you'd like to upgrade XWiki to a newer version. + +If you've followed the instructions above you've mapped the XWiki permanent directory to a local directory on your host. + +Thus all you need to do is to execute the installation instructions above as if you were installing a new version of the XWiki docker image. + +Then you need to stop your running XWiki container. You should keep your DB container running. Then all you have to do is start a new container as described above, using the new XWiki docker image. + +Caveats: + +- Right now we have an [outstanding issue](https://jira.xwiki.org/browse/XDOCKER-20) and thus if you've had to modify `xwiki.properties` or `xwiki.cfg` inside the XWiki container, you'll need to port your changes inside the new container (see the section below). + # Details for the xwiki image ## Configuration Options @@ -217,6 +231,14 @@ The first time you create a container out of the xwiki image, a shell script (`/ - `DB_DATABASE`: The name of the XWiki database to use/create. - `DB_HOST`: The name of the host (or docker container) containing the database. Default is "db". +If you need to configure XWiki (e.g. modify `xwiki.properties` or `xwiki.cfg`) or perform some additional configuration, you can execute another container and attach to the running XWiki container by issuing: + +```console +docker exec -it bash -l +``` + +Note that we plan to [lift this limitation in the future](https://jira.xwiki.org/browse/XDOCKER-20). + ## Passing JVM options It's possible to pass JVM options to Tomcat by defining the `JAVA_OPTS` environment property. From c097a83f53a78dbd06af8c77f322031e3598c534 Mon Sep 17 00:00:00 2001 From: Vincent Massol Date: Thu, 17 Aug 2017 19:30:42 +0200 Subject: [PATCH 2/2] Remove EOL space --- xwiki/content.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xwiki/content.md b/xwiki/content.md index 39eb6d59f..443fb0ab8 100644 --- a/xwiki/content.md +++ b/xwiki/content.md @@ -218,7 +218,7 @@ Then you need to stop your running XWiki container. You should keep your DB cont Caveats: -- Right now we have an [outstanding issue](https://jira.xwiki.org/browse/XDOCKER-20) and thus if you've had to modify `xwiki.properties` or `xwiki.cfg` inside the XWiki container, you'll need to port your changes inside the new container (see the section below). +- Right now we have an [outstanding issue](https://jira.xwiki.org/browse/XDOCKER-20) and thus if you've had to modify `xwiki.properties` or `xwiki.cfg` inside the XWiki container, you'll need to port your changes inside the new container (see the section below). # Details for the xwiki image