From f6addeea9054274c27d2f32f57ace8fee81ef014 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 9 May 2025 19:42:32 +0200 Subject: [PATCH] Automated openhabian Docs fetch (#2494) Co-authored-by: openHAB Bot --- installation/openhabian-backup.md | 11 +++++++---- installation/openhabian-exim.md | 3 +-- installation/openhabian-troubleshooting.md | 8 ++++---- installation/openhabian.md | 5 +++-- 4 files changed, 15 insertions(+), 12 deletions(-) diff --git a/installation/openhabian-backup.md b/installation/openhabian-backup.md index 279f67a44..768df34c4 100644 --- a/installation/openhabian-backup.md +++ b/installation/openhabian-backup.md @@ -25,11 +25,14 @@ But in all reality, we **strongly** recommend getting a ZWave or Zigbee stick of ### SD Card Failure One of the most common points of failure in a Raspberry Pi is an SD card failing. -This is why we *strongly* recommend using SD cards that are labelled "Endurance" as they are made for applications like this. +Please make sure to use SD cards that are labelled "Endurance" as they are made for write-intensive applications like this. + +We also *strongly* recommend to use [ZRAM](#zram) AND to set up [SD mirroring](#sd-mirroring). +ZRAM is enabled by default. SD mirroring you need set up manually using menu option 53. #### SD Mirroring -We have a bultin option to mirror SD cards so that you can always have a backup ready. +We have a builtin option to mirror SD cards so that you can always have a backup ready. If you plan to mirror you SD card using the auto-backup features in openHAB, you should purchase 2 of the same model of SD card when you setup your system. A different model of SD card may work, but sometimes models differ slightly in size causing issues. @@ -132,7 +135,7 @@ As yourself, prepend `sudo -u backup` to execute the following commands as the " Now once you have read up on all of this and feel you have understood this stuff, the next step will be to prepare your storage. -::: important +::: tip You need to provide your storage *before* you install Amanda. ::: @@ -146,7 +149,7 @@ If you have a NAS, you should typically export the storage shares using the NFS ::: warning If you are a Windows user, please note that CIFS shares are not supported and will not work. -You should use a properly formatted UNIX shares if you are mounting from a NAS. +You should use a properly formatted UNIX share if you are mounting from a NAS. ::: Amanda does not work with CIFS because of issues with symlinks. diff --git a/installation/openhabian-exim.md b/installation/openhabian-exim.md index 4fbf33efb..2146f0d10 100644 --- a/installation/openhabian-exim.md +++ b/installation/openhabian-exim.md @@ -5,7 +5,7 @@ In case you enter anything wrong you can re-initiate the installation process fr Note sending mails is an optional feature. If installing any other package such as the Amanda backup led you to MTA setup here, you can cancel it or enter whatever information so it won't work afterwards. Amanda will keep working, you just won't get any report mails. -::: tip if you relay via mail.gmail.com or mail.gmx.net +::: tip Relaying via mail.gmail.com or mail.gmx.net Both of these freemailers will only forward your mail when you authenticate with your Google/GMX username first. Additionally, GMX requires the "From:" address to be your GMX mail address. Google allows for arbitrary From: but will override any From: with your Gmail address. @@ -13,7 +13,6 @@ Google allows for arbitrary From: but will override any From: with your Gmail ad Google meanwhile enforces more strict anti-spamming so authenticating with your standard credentials likely won't work any more to send mail. With two factor authentication (2FA) you can generate a static password token for use with applications such as email in your Google account. If you don't want to use 2FA or your personal account for this purpose, you can generate a secondary one. - ::: Here is what you will need to enter: diff --git a/installation/openhabian-troubleshooting.md b/installation/openhabian-troubleshooting.md index 2ec784b6e..b9d31fcf1 100644 --- a/installation/openhabian-troubleshooting.md +++ b/installation/openhabian-troubleshooting.md @@ -6,7 +6,7 @@ source: https://github.com/openhab/openhabian/blob/main/docs/openhabian-troubles # openHABian Troubleshooting -::: important +::: warning **Please do not ask for help on the forum unless you have read this guide.** ::: @@ -88,11 +88,11 @@ If you've tried the advice up to this point and it has still failed to install, ### Enabling Debug Logs -Before your first boot, you will need to edit `/boot/openhabian.conf` and `debugmode` to `maximum` (or optionally `on` if you think you only need minimal debugging). -If you want even more logging you could also use `maximum` to increase the output (it will show the output of every command run by `openhabian-config`). +Before your first boot, you will need to edit `openhabian.conf` and set `debugmode` to `maximum` (or optionally `on` if you think you only need minimal debugging). +To do so, you need to mount the first partition of your SD card. It's a Windows FAT filesystem so you can and should be doing that right after flashing your image to SD. See [`debugmode`](./openhabian.md#debugmode) for more information. -After setting `debugmode` boot your system for the first time (yeah again). +After setting `debugmode` boot your system for the first time. Wait for it to complete the setup process, then login and check `/boot/first-boot.log` for the detailed logs. If you are impatient, you can try and follow along with the installation logs in the web browser at [http://openhabian:81](http://openhabian:81). diff --git a/installation/openhabian.md b/installation/openhabian.md index 857310259..6de0bb1c2 100644 --- a/installation/openhabian.md +++ b/installation/openhabian.md @@ -57,7 +57,7 @@ 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. -::: info Note +::: 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. ::: @@ -401,10 +401,11 @@ clonebranch="openHAB" An initial configuration file to import when setting up openHAB. This file must be a `.zip` archive created by `openhab-cli backup`. +ATTENTION: keep /boot/firmware as the directory if you provide an absolute path ::: details Example ``` -initialconfig="/boot/initial.zip" +initialconfig="/boot/firmware/initial.zip" ``` :::