OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Extend documentation for upgrade tool (#2617) 

Signed-off-by: Mark Herwege <mark.herwege@telenet.be>
pull/2619/head
Mark Herwege 2025-12-21 18:50:11 +01:00 committed by GitHub
parent 33d7ec6620
commit 2470eb45cb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
installation/index.md
View File

@ -129,6 +129,7 @@ If you run into any problems, use the search function in the forum or open a new
In some cases upgrading to a new version of openHAB requires additional steps.
For textual based configuration this can usually be done using a text editor or VS Code.
UI configuration updates to the JSON database should not be done manually but by using the upgrade tool.
When using the standard upgrade scripts, the upgrade tool will execute automatically and there should not be a need to run them manually.
The upgrade tool is a Java application and allows performing different steps.
Each step can only be executed once (unless you `--force` the tool to perform them again).
@ -142,11 +143,20 @@ They have been replaced by the generic script transformation/profile which requi
This step rewrites the profiles to the new format.
- `linkUpgradeScriptProfile`: Upgrades the script profile `toHandlerScript` option into separate `commandFromItemScript` and `stateFromItemScript` options.
- `yamlTagsListToMap`: The original implementation of custom tags in openHAB 4 were defined in a YAML List. This step converts them into map format used in openHAB 5. It will process valid YAML files in `conf/tags` directory.
- `homeAssistantUpgrader`: The Home Assistant add-on has been separated from the MQTT add-on. This installs the Home Assistant add-on if Home Assistant Things are present.
- `homieUpgrader`: The Homie add-on has been separated from the MQTT add-on. This installs the Homie add-on if Homie Things are present.
- `persistenceCopyDefaultStrategy`: Move persistence default strategy configuration to all persistence configurations without strategy defined and create it when none exists.
The upgrade tool needs to know the path to the openHAB userdata folder (e.g. `/var/lib/openhab` on most Debian like systems).
If the tool is not operated from that folder, it can be specified by using `--userdata /var/lib/openhab` on the commandline.
The upgrade tool needs to know the path to the openHAB conf folder (e.g. `/etc/openhab` on most Debian like systems).
You can specify this conf folder using `--conf /etc/openhab` on the commandline.
The full list of command line options can be displayed using the `--help` argument
After running the upgrade tool, it is recommended to reset the file ownership of the content of the userdata jsondb folder (e.g. `/var/lib/openhab/jsondb` on most Debian like systems).
On Debian like systems, this could be done with `sudo chown -R ohuser:ohgroup /var/lib/openhab/jsondb`, where `ohuser` and `ohgroup` are the user, resp. group for openhab.
If you have an openHABian installation, you can simply reset ownerships using `sudo openhab-cli reset-ownership`.
Example:
```shell