Updating¶
Every software needs to be updated over time to get new functionality or just to fix some bugs. Because Karmen is distributed as a bunch of Docker images, updating is quite easy.
Finding out about the release¶
All new releases show up in the releases section on our GitHub. You can get notifications if you start watching the repository or you can subscribe to an Atom feed. Any major changes will also probably be announced on our social media.
The easy way¶
We have prepared an update script that can perform all of the steps for you. However, it doesn’t hurt to always have a manual backup before running an automated update.
If you followed the installation guide, you will have a karmen directory
in Raspberry Pi’s home directory of /home/pi. And there should be an update.sh script. It does all
the steps described below for you and after running it, you should be ready to start Karmen Hub again from a new version
either by restarting your device (if you have set up the startup script), or by running
<YOUR CONFIGURATION ENVVARS> /home/pi/karmen/run-karmen.sh
By default, the update script will update to the latest stable release. If you’re feeling adventurous,
you may update to an unstable release by running update.sh --edge.
Updating manually¶
All of the following commands are run from the /home/pi/karmen directory unless stated otherwise.
- Stop Karmen with
./stop-karmen.sh. - Do a backup of the whole
karmendirectory including the PotsgreSQL datafiles. - Get the latest (or specific)
release.zipfrom github and unpack its contents into thekarmendirectory. - Run
docker-compose pullto get the latest versions of docker containers. - Start Karmen again with
<YOUR CONFIGURATION ENVVARS> /home/pi/karmen/run-karmen.sh
