From 9ceb1b62608b83633b90a3e9a26ae530c2bad0fc Mon Sep 17 00:00:00 2001
From: Vincent Massol <vincent@massol.net>
Date: Thu, 17 Aug 2017 14:02:35 +0200
Subject: [PATCH] [Misc] Added explanation on how to upgrade XWiki

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 8646391..a3bf08e 100644
--- a/README.md
+++ b/README.md
@@ -208,6 +208,20 @@ Note that `docker-compose up` will automatically build the XWiki image on the fi
 
 You can also just build the image by issuing `docker build -t xwiki .` and then use the instructions from above to start XWiki and the database using `docker run ...`.
 
+# 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
@@ -225,6 +239,8 @@ If you need to configure XWiki (e.g. modify `xwiki.properties` or `xwiki.cfg`) o
 docker exec -it <xwiki container id> 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.
-- 
GitLab