Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions installation/images/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 28 additions & 14 deletions installation/openhabian.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ With that being said, we can't and won't stop you from doing whatever you want,

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.
Older RPi models (or models with less RAM) can be sufficient to run a smallish openHAB setup.
Please note that running 64bit mode on RPi's with only 1 GB of RAM tends not to work super well.
Please note that running 64bit mode on RPi with only 1 GB of RAM tends not to work super well.

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

::: tip Note
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.
With openHAB 5 release, we have dropped support for anything older than an RPi 3 as openHAB 5 requires a 64 bit processor.
:::


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.
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.

openHABian can run on x86 based systems but you will need to install debian yourself.
See [installation on other Linux systems](#installation-on-other-linux-systems) for directions on what to do.
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.

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

##### 32/64 Bit Image Support

Any RPi 3 or newer supports 64 bit operation.
Unless you really know what you are doing and have a compelling reason to do so, stick with the 64 bit image.
If you do install a 32 bit image, please note that you will be unable to upgrade to openHAB 5 in the future.
openHAB 5 requires to run on a 64 bit OS and Java 21 version so the recommended openHABian image is the 64 bit version.

Many RPi users are still on a 32 bit based Linux OS (you can check bitness using the command `getconf LONG_BIT`).

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
ATTENTION: RUNNING openHAB 5 on any 32 bit OS image IS NOT SUPPORTED ANY MORE.
You will be having issues with some functions like JS Scripting. Reinstall your OS to 64 bit or stay with openHAB 4.
Should you decide to upgrade, check the openHAB 5 release notes how to export/backup your config and install a fresh system.
https://github.com/openhab/openhab-distro/releases/tag/5.0.0#openhabian

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

## Installation and Setup
### Networking

You need to connect your Raspberry Pi to the network by Ethernet or configure Wi-Fi settings before first boot.
Expand Down Expand Up @@ -244,12 +254,16 @@ Each of these are included as a part of `openhabian-config` menu option 20.
- [OWServer](https://owfs.org) - 1-Wire system of Dallas/Maxim
- [FIND](https://www.internalpositioning.com/) - Framework for Internal Navigation and Discovery
- Mi Flora MQTT daemon
- [ESPHome Device Builder](https://esphome.io/guides/getting_started_hassio.html#device-builder-interface) - Webinterface for easy configuration, installation and updating of ESPHome devices at [http://openhabian:6052](http://openhabian:6052) <br/>
The ESPHome configuration files are secured by the openHABbian backup function. <br/>
**Please note that automatic updates are not implemented in OpenHABian. <br/> &rarr; to do this, use the openhbaian-config update function in menu 20**
- Grott Proxy server for [Growatt binding](https://www.openhab.org/addons/bindings/growatt/#grott-application-installation-and-setup)

## First boot configuration

Many settings are configurable prior to the first boot of openHABian by changing the key value pairs in the `/boot/openhabian.conf` file on the SD card once you have flashed the initial image onto it.

Please note that - in case you use a Windows system for writing the SD card - the `/boot/` partition will be mounted to a drive named `bootfs`. So, e.g. if this drive has the letter `D:`, `/boot/openhabian.conf` will be found as `D:\openhabian.conf`.
Please note that - in case you use a Windows system for writing the SD card - the `/boot/` partition will be mounted to a drive named `bootfs`. So, e.g. if this drive has the letter `D:`, `/boot/openhabian.conf` will be found as `D:\openhabian.conf`.

The openHABian configuration file uses key value pairs, essentially a list of `option=value` settings in a plain text file.
All supported options are already in the file but unused options and optional components are commented out by default.
Expand Down Expand Up @@ -373,7 +387,7 @@ Set this according to your current location or you may risk violating regulatory

::: details Example
```
wifi_country="US"
wifi_country="DE"
```
:::

Expand All @@ -392,11 +406,11 @@ repositoryurl="https://github.com/openhab/openhabian.git"

#### `clonebranch`

The branch of the repository to use for openHABian.
The branch of the repository to use for openHABian. Use branch openHAB4 or openHAB3 to get OH 4 or 3 installed right from the start.

::: details Example
```
clonebranch="openHAB"
clonebranch="openHAB4"
```
:::

Expand All @@ -419,7 +433,7 @@ Debug log level for openHABian, valid options are: `off`, `on` (verbose output i

::: details Example
```
debugmode="off"
debugmode="maximum"
```
:::

Expand All @@ -435,11 +449,11 @@ apttimeout="60"

#### `java_opt`

Java version to install, valid options are: `17`, `Zulu21-64`, or `BellSoft21`.
Java version to install, valid options are: 17, 21, Temurin17, Temurin21, 11 (legacy)

::: details Example
```
java_opt="17"
java_opt="Temurin21"
```
:::

Expand Down