Hi devs and all xwiki users,
Currently, when using one of the XWiki docker images, when you start the container, an image script will check if there are xwiki configuration files (hibernate.cfg.xml, xwiki.cfg and xwiki.properties) from the xwiki runtime that are not in your xwiki permanent directory on your host and if not, it’ll copy them to save them, so that you can make easy changes to them, and at the next restart, these files will be copied to the runtime.
While this makes it easy to change the XWiki configuration, it has one problem:
- If you’ve not made changes to the config files and you upgrade the version of xwiki, and it happens that there’s a config change that was made in XWiki in one the 3 files mentioned, then your instance will start with the old config.
So to work around this, I’d like to propose a change of config strategy:
- We document on xwiki-docker/README.md at master · xwiki/xwiki-docker · GitHub that if users need to make changes to config files, they’ll need to map a docker volume for them. We document the locations of all config files to make it easier.
- We keep the backward-compatibility so that if these config files exist in the host permanent directory, they are copied to the runtime (as it’s the case now). We also document that this can be used as an alternative to point 1) if you want to have all the config files located in the host permanent directory.
It should also fix Loading... and Loading....
Note that this strategy doesn’t address merging configuration files if you’ve made changes to them and the XWiki runtime also has made changes to them. This has to be done manually currently (we could document some command line to help with this though).
WDYT?
Thanks
3 posts - 2 participants