Guide
Upgrading
Before you start: back up
Back up these three directories before every upgrade, without exception:
entities/logs/loggers/
An in-place upgrade replaces the application binaries only; it must never touch these directories. Taking the backup regardless costs you a few minutes and protects against the one bad release that breaks this assumption.
In-place upgrade
- Download the new installer for your platform from the download page.
- Stop the running service (
systemctl stop data-orchester, or the equivalent for your platform). - Run the new installer over the existing install — it replaces the application files and leaves
entities//logs//loggers/untouched. - Start the service again and confirm the version shown in the UI matches what you installed.
- Confirm your existing dashboards, modules and peers all still load and report data as before.
What must not happen
- Configuration should not need re-entering after an upgrade.
- No entity file should be silently rewritten by the new version on first load — if you see every entity file's modification time change right after an upgrade, that's a bug, not expected behaviour.
Rolling back
If something goes wrong, stop the service, reinstall the previous version's package, and restore
entities//logs//loggers/ from the backup you took in step 1 if the new version wrote anything unexpected to
them. A same-version reinstall never requires restoring the backup; only do so if you have a concrete reason to
believe the new version altered your data.