Skip to content

Commit 7f61dda

Browse files
authored
Update docs for OH5 and 64 bit (#2041)
* Updated docs on OH 5 and 64 bit Signed-off-by: Markus Storm <markus.storm@gmx.net>
1 parent ae46ee7 commit 7f61dda

5 files changed

Lines changed: 50 additions & 27 deletions

File tree

NEWS.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,19 @@ Hit tab to unselect buttons and scroll through the text using UP/DOWN or
22
PGUP/PGDN. All announcements are stored in `/opt/openhabian/docs/CHANGELOG.md`
33
for you to lookup.
44

5-
## Recommended 32/64 bit Java providers ## July 31, 2025
5+
## 64 bit OS support only ## Aug 1, 2025
66

7-
For 64bit, the default in openHABian will Temurin 21.
8-
For 32 bit, there is no officially version of Java 21 available that
9-
is known to be well supported and stable. Check your OS for 32/64 bitness
10-
using getconf LONG_BIT and read the openHAB release notes at
7+
With openHAB 5, we are sorry but we have to drop support for 32 bit systems.
8+
There is no officially supported and stable version of Java 21 available that
9+
runs on ARM hardware with a 32 bit Linux.
10+
Check your OS for 32/64 bit using getconf LONG_BIT and read the release notes
1111
https://github.com/openhab/openhab-distro/releases/tag/5.0.0#openhabian
1212
to find out how to proceed with your openHAB upgrade to version 5.
13+
Starting with openHABian v1.11, the upgrade menu function (03) will no longer
14+
work if you are still on an 32 bit system.
15+
You can still manually select to install Temurin 21 Java and openHAB
16+
but be aware that you will be running an unsupported version of openHAB so
17+
if you run into any trouble, please do not ask for help but upgrade to 64.
1318

1419

1520
## openHAB 5 released ## July 21, 2025

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,18 +59,22 @@ We provide code that is reported "as-is" to run on Ubuntu but we do not support
5959
Several optional components such as WireGuard or Homegear are known to expose problems on Ubuntu.
6060

6161
Note with openHAB 4 and Java 17, `buster` and older distros are no longer supported and there'll be issues when you attempt upgrading Java 11->17.
62+
Note openHAB 5 and Java 21 require a 64 bit image.
6263
Should you still be running an older distribution, we recommend not to upgrade the distro but to re-install using the latest openHABian image and import your config instead.
6364

64-
### 64 bit?
65-
RPi 3 and newer have a 64 bit processor. There's openHABian images available in both, 32 and 64 bit.
66-
Choose yours based on your hardware and primary use case. Please be aware that you cannot change once you decided in favor of either 32 or 64 bit. Should you need to revoke your choice, export/backup your config and install a fresh system, then import your config there.
6765

68-
Use the 64 bit image versions but please be aware that 64 bit always has one major drawback: increased memory usage. That is not a good idea on heavily memory constrained platforms like Raspberries. If you want to go with 64 bit, ensure your RPi has a minimum of 2 GB, 4 will put you on the safe side.
69-
You can use the 32 bit version for older or non official addons that will not work on 64 bit yet.
70-
Note there's a known issue on 32 bit, JS rules are reported to be annoyingly slow on first startup and in some Blockly use cases.
71-
If you consider using the (newer but still experimental) Java version 21, if possible choose 64 bit.
66+
### on 64 bit
67+
openHAB 5 requires to run on a 64 bit OS and Java 21 version so the recommended openHABian image is the 64 bit version.
68+
69+
Many RPi users are still on a 32 bit based Linux OS. You can check bitness using the command `getconf LONG_BIT`.
70+
64 bit has one major drawback: increased memory usage. That is not a good idea on heavily memory constrained platforms like older Raspberries. So if you want to go with 64 bit, ensure your RPi has a minimum of 2 GB, 4 will put you on the safe side.
71+
On x86 hardware, it's all 64 bit but that in turn once more increases memory usage. A NUC to run on should have no less than 4 GB, 8 are better.
72+
73+
You can *temporarily* use the 32 bit version if you want to stay with openHAB 4 or if you cannot upgrade your HW or OS at the very moment, BUT
74+
ATTENTION: RUNNING openHAB 5 on any 32 bit OS image IS NOT SUPPORTED ANY MORE and known to have issues with some functions like JS scripting.
75+
Please don't ask for help if you nonetheless run in 32 and hit trouble.
76+
You cannot change your OS once you decided in favor of either 32 or 64 bit, so should you decide to upgrade, export/backup your config and install a fresh system, then import your config there.
7277

73-
On x86 hardware, it's all 64 bit but that in turn once more increases memory usage. A NUC to run on should have no less than 8 GB.
7478

7579

7680
## Installation and Setup

build-image/template_rpi-imager-openhab.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
},
1616
{
1717
"name": "openHABian (32 bit)",
18-
"description": "This version can be used for systems with less memory like a RPi 3.",
18+
"description": "Fallback version. This version can be used for RPIs with less than 2 GB of memory.\nBe prepared that you might run into issues when you attempt to run openHAB 5.\nParts of 5 requires a 64 bit OS and Java. You can run openHAB 4 with this image.",
1919
"url": "%url32_latest%",
2020
"icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB2aWV3Qm94PSIwIDAgMzIgMzIiPgoJPGNpcmNsZSBjeD0iMTYiIGN5PSIxNiIgcj0iMTYiIGZpbGw9IiNmZmYiLz4KCTxwYXRoIGZpbGw9IiNlNjRhMTkiIGQ9Im01LjI0MiAyMS4xMzMgOS4zOS05LjM5OEwxNiAxMC4zNjhsMS4zNjcgMS4zNjcgNi45MzMgNi45MzMtLjAxLjAzNS0uMTM3LjQwMi0uMTU2LjM5NC0uMTc0LjM4My0uMTkyLjM3NC0uMTc1LjMwNEwxNiAxMy4xMDMgNi4yNCAyMi44N2MtLjM3Ny0uNTUzLS43MjUtMS4xMjMtLjk5OC0xLjczOHoiLz4KCTxwYXRoIGZpbGw9IiM0NzQ3NDciIGQ9Ik0xNiA0YzYuNjEgMCAxMiA1LjM5IDEyIDEycy01LjM5IDEyLTEyIDEyYy0zLjYxIDAtNi44NTYtMS42MS05LjA1OS00LjE0N2wuNDI0LS40MjUuMzA4LS4zMDguMzA4LS4zMS4zMDktLjMwNy4wMTMtLjAxM0ExMC4wNTcgMTAuMDU3IDAgMCAwIDE2IDI2LjA3N2M1LjU1IDAgMTAuMDc4LTQuNTI2IDEwLjA3OC0xMC4wNzdTMjEuNTUgNS45MjIgMTYgNS45MjJDMTAuNDQ5IDUuOTIyIDUuOTIyIDEwLjQ1IDUuOTIyIDE2YzAgLjc0Ny4wODMgMS40NzYuMjM5IDIuMTc4bC0uNjY4LjY3LS44OTMuODkzQTExLjkyMiAxMS45MjIgMCAwIDEgNCAxNkM0IDkuMzkgOS4zOSA0IDE2IDR6Ii8+Cjwvc3ZnPgo=",
2121
"extract_size": %imageE_size32_latest%,

docs/openhabian.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ With that being said, we can't and won't stop you from doing whatever you want,
4545

4646
Our current recommendation is to get a Raspberry Pi model 4 or 5 with 2 or 4 GB of RAM, whatever you can get for a good price.
4747
Older RPi models (or models with less RAM) can be sufficient to run a smallish openHAB setup.
48-
Please note that running 64bit mode on RPi's with only 1 GB of RAM tends not to work super well.
48+
Please note that running 64bit mode on RPi with only 1 GB of RAM tends not to work super well.
4949

5050
You will need an SD card to go along with your Raspberry Pi, SD cards labelled "Endurance" are best for openHABian.
5151
Cards labelled "Endurance" can handle more write cycles and will typically last longer for openHAB's use conditions.
@@ -58,11 +58,16 @@ This will give you a ready to go drop in replacement in the case of any hardware
5858
All Raspberry Pi models are supported by openHABian.
5959

6060
::: tip Note
61-
With the upcoming openHAB 5 release, we will drop support for anything older than an RPi 3 as openHAB 5 will require a 64 bit processor.
61+
With openHAB 5 release, we have dropped support for anything older than an RPi 3 as openHAB 5 requires a 64 bit processor.
6262
:::
6363

64+
65+
Running in 64 bit has one major drawback: increased memory usage. That is not a good idea on heavily memory constrained platforms like older Raspberries. Ensure your RPi has a minimum of 2 GB, 4 will put you on the safe side.
66+
For older hardware, you can attempt to use the 32 bit image we still provide, it should work but we do not support running openHAB 5.
67+
6468
openHABian can run on x86 based systems but you will need to install debian yourself.
6569
See [installation on other Linux systems](#installation-on-other-linux-systems) for directions on what to do.
70+
On x86 hardware, it's all 64 bit but that in turn once more increases memory usage. A NUC to run on should have no less than 4 GB, 8 are better.
6671

6772
All other system combinations do not have official support.
6873
We do not actively prohibit installation on any hardware, including unsupported systems, *but we will **not** offer support for any issues you encounter*.
@@ -72,13 +77,18 @@ This will help you and those you will want to ask for help on the forum focus on
7277

7378
##### 32/64 Bit Image Support
7479

75-
Any RPi 3 or newer supports 64 bit operation.
76-
Unless you really know what you are doing and have a compelling reason to do so, stick with the 64 bit image.
77-
If you do install a 32 bit image, please note that you will be unable to upgrade to openHAB 5 in the future.
80+
openHAB 5 requires to run on a 64 bit OS and Java 21 version so the recommended openHABian image is the 64 bit version.
81+
82+
Many RPi users are still on a 32 bit based Linux OS (you can check bitness using the command `getconf LONG_BIT`).
83+
84+
You can *temporarily* use the 32 bit version if you want to stay with openHAB 4 or if you cannot upgrade your HW or OS at the very moment, BUT
85+
ATTENTION: RUNNING openHAB 5 on any 32 bit OS image IS NOT SUPPORTED ANY MORE.
86+
You will be having issues with some functions like JS Scripting. Reinstall your OS to 64 bit or stay with openHAB 4.
87+
Should you decide to upgrade, check the openHAB 5 release notes how to export/backup your config and install a fresh system.
88+
https://github.com/openhab/openhab-distro/releases/tag/5.0.0#openhabian
7889

79-
On systems with only 1 GB of RAM running the 64 bit image may cause issues as there may not be sufficient RAM.
80-
If you observe issues please consider upgrading to a model with more that 1 GB of RAM.
8190

91+
## Installation and Setup
8292
### Networking
8393

8494
You need to connect your Raspberry Pi to the network by Ethernet or configure Wi-Fi settings before first boot.

functions/menu.bash

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,11 @@ show_main_menu() {
6969
elif [[ "$choice" == "03"* ]]; then
7070
wait_for_apt_to_finish_update
7171
if ! is_supported; then
72-
whiptail --title "outdated OS" --msgbox "You are running a too old version of your Operating System.\\n\\nOpenHAB 4 and Java 17 require that you upgrade to Debian 11 (bullseye) first." 8 80
72+
whiptail --title "outdated OS" --msgbox "You are running a too old version of your Operating System.\\nYou need to upgrade to be running at least Debian 11 (bullseye).\\nWe do NOT recommend to dist-upgrade but to re-install using the openHABian 64 bit image." 9 80
73+
return 255
74+
fi
75+
if is_arm && [[ "$(getconf LONG_BIT)" == "32" ]]; then
76+
whiptail --title "32 bit OS" --msgbox "You are running a 32 bit Operating System. THIS IS NOT SUPPORTED ANY LONGER.\\nOpenHAB 5 and Java 21 require that you upgrade your OS to a 64 bit version, please read the release notes at\\nhttps://github.com/openhab/openhab-distro/releases/tag/5.0.0#openhabian\\nYou can still install manually via menus 45 and 41 if in vain but remember that will be an UNSUPPORTED setup.\\nPlease reinstall your system with the 64 bit image of openHABian." 11 80
7377
return 255
7478
fi
7579

@@ -211,11 +215,11 @@ show_main_menu() {
211215
"42 | Remote Console" "Bind the openHAB SSH console to all external interfaces" \
212216
"43 | Clean cache" "Clean the cache for openHAB" \
213217
"44 | Nginx Proxy" "Setup reverse and forward web proxy" \
214-
"45 | OpenJDK 17" "Install and activate OpenJDK 17 as Java provider (default)" \
215-
" | OpenJDK 21" "Install and activate OpenJDK 21 as Java provider (DO NOT USE WILL BREAK SYSTEM - upcoming default when fixed)" \
216-
" | Temurin 17" "Install and activate Temurin 17 as Java provider (default alternative)" \
217-
" | Temurin 21" "Install and activate Temurin 21 as Java provider (upcoming alternative, currently preferred)" \
218-
" | OpenJDK 11" "Install and activate OpenJDK 11 as Java provider (legacy)" \
218+
"45 | OpenJDK 17" "Install + activate OpenJDK 17 as Java provider (default for OH versions 4 and older)" \
219+
" | OpenJDK 21" "Install + activate OpenJDK 21 as Java provider (DO NOT USE WILL BREAK SYSTEM)" \
220+
" | Temurin 17" "Install + activate Temurin 17 as Java provider (fallback for OH versions 4 and older)" \
221+
" | Temurin 21" "Install + activate Temurin 21 as Java provider (default)" \
222+
" | OpenJDK 11" "Install + activate OpenJDK 11 as Java provider (legacy)" \
219223
"46 | Install openhab-js" "JS Scripting: Upgrade to latest version of openHAB JavaScript library (advanced)" \
220224
" | Uninstall openhab-js" "JS Scripting: Switch back to included version of openHAB JavaScript library" \
221225
"47 | Install openhab_rules_tools" "JS Scripting: Manually install openhab_rules_tools (auto-installed)" \

0 commit comments

Comments
 (0)