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

Update several file paths for openHAB 3 release (#1409) 

Starting with openHAB 3, configuration folders and service names do no
longer contain the version number of openHAB.

Signed-off-by: Christoph Thiede <christoph.thiede@outlook.de>
pull/1417/head
Christoph Thiede 2021-01-03 21:35:28 +01:00 committed by GitHub
parent 810d24de15
commit 714776463a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
administration/serial.md
View File

@ -23,7 +23,7 @@ openHABian comes with a menu option to configure the serial ports automatically.
If you can see issues related to opening the serial port with Linux, and you are using **non standard serial ports** (e.g. `/dev/ttyAMA0`) you might have to configure openHAB to detect and access the port correctly: If you can see issues related to opening the serial port with Linux, and you are using **non standard serial ports** (e.g. `/dev/ttyAMA0`) you might have to configure openHAB to detect and access the port correctly:
* Adapt Java command line arguments to include `-Dgnu.io.rxtx.SerialPorts=/dev/ttyAMA0` (where `/dev/ttyAMA0` is the serial port). If you have multiple serial ports to configure, separate them with colon (`:`). Depending on openHAB installation method, you should modify `start.sh`, `start_debug.sh`, `start.bat`, or `start_debug.bat` (standalone/manual installation) or `EXTRA_JAVA_OPTS` in `/etc/default/openhab2` (Debian installation) * Adapt Java command line arguments to include `-Dgnu.io.rxtx.SerialPorts=/dev/ttyAMA0` (where `/dev/ttyAMA0` is the serial port). If you have multiple serial ports to configure, separate them with colon (`:`). Depending on openHAB installation method, you should modify `start.sh`, `start_debug.sh`, `start.bat`, or `start_debug.bat` (standalone/manual installation) or `EXTRA_JAVA_OPTS` in `/etc/default/openhab` (Debian installation)
* Depending on Linux distribution, you might need to add the user running openHAB to `dialout` user group.With Debian openHAB installation: `sudo usermod -a -G dialout openhab`. The user will need to logout from all login instances and log back in to see their new group added. If the user added to this group still cannot get permission, rebooting the box to ensure the new group permission is attached to the user is suggested. * Depending on Linux distribution, you might need to add the user running openHAB to `dialout` user group.With Debian openHAB installation: `sudo usermod -a -G dialout openhab`. The user will need to logout from all login instances and log back in to see their new group added. If the user added to this group still cannot get permission, rebooting the box to ensure the new group permission is attached to the user is suggested.
* When using more than one USB-Serial converters, it may happen that the `/dev/ttyUSB0` device is named `/dev/ttyUSB1` after a reboot. To prevent this problem, alias names can be assigned to serial devices by adding them to `/etc/udev/rules.d/99-com.rules`. Example: * When using more than one USB-Serial converters, it may happen that the `/dev/ttyUSB0` device is named `/dev/ttyUSB1` after a reboot. To prevent this problem, alias names can be assigned to serial devices by adding them to `/etc/udev/rules.d/99-com.rules`. Example:

4
appendix/contributing.md
View File

@ -20,8 +20,8 @@ When no solution was found, use the table below to determine where your issue sh
| Issue | Where to report | | Issue | Where to report |
|--------------------------------------------------------------|--------------------------------------------------------------------| |--------------------------------------------------------------|--------------------------------------------------------------------|
| Problems and feature requests for openHAB 1 add-ons | [openHAB](https://github.com/openhab/openhab/issues) | | Problems and feature requests for openHAB 1 add-ons | [openHAB 1](https://github.com/openhab/openhab/issues) |
| Problems and feature requests for openHAB 2 add-ons | [openHAB2](https://github.com/openhab/openhab2/issues) | | Problems and feature requests for openHAB 2 add-ons | [openHAB 2+](https://github.com/openhab/openhab-addons/issues) |
| Issues related to the runtime environment, IDE and packaging | [openHAB-distro](https://github.com/openhab/openhab-distro/issues) | | Issues related to the runtime environment, IDE and packaging | [openHAB-distro](https://github.com/openhab/openhab-distro/issues) |
| Issues related to the core openHAB bundles | [openHAB-core](https://github.com/kaikreuzer/openhab-core/issues) | | Issues related to the core openHAB bundles | [openHAB-core](https://github.com/kaikreuzer/openhab-core/issues) |

8
installation/docker.md
View File

@ -123,7 +123,7 @@ To change the runtime parameters stop the container then execute the long comman
Note, always review the README on [Docker Hub](https://hub.docker.com/r/openhab/openhab/) for the most up to date set of recommended arguments and environment variables. Note, always review the README on [Docker Hub](https://hub.docker.com/r/openhab/openhab/) for the most up to date set of recommended arguments and environment variables.
If running on a Systemd based Linux distro (Ubuntu 16.04 to be specific). If running on a Systemd based Linux distro (Ubuntu 16.04 to be specific).
The following openhab2.service file will start a new openHAB container every time it starts the service and destroy that container when the service stops. The following `openhab.service` file will start a new openHAB container every time it starts the service and destroy that container when the service stops.
What that means is any data that you want to preserve between restarts of openHAB (e.g. configuration, databases, etc.) must be mounted from your host file system into the container. What that means is any data that you want to preserve between restarts of openHAB (e.g. configuration, databases, etc.) must be mounted from your host file system into the container.
Creating a new container on every run greatly simplifies the upgrade and update process. Creating a new container on every run greatly simplifies the upgrade and update process.
@ -159,11 +159,11 @@ Where `<uid>` is the user ID number for the `openhab` user which you can obtain
It is important that the ID number is passed in. It is important that the ID number is passed in.
The ID for the `openhab` user inside the container will not match the ID of the user on your host system and file permissions may be a bit odd (e.g. why does www-data own my openHAB config files?). The ID for the `openhab` user inside the container will not match the ID of the user on your host system and file permissions may be a bit odd (e.g. why does www-data own my openHAB config files?).
Place this openhab2.service file into `/etc/systemd/system`. Place this `openhab.service` file into `/etc/systemd/system`.
Then run `sudo systemctl enable openhab2.service`. Then run `sudo systemctl enable openhab.service`.
Finally run `sudo systemctl start openhab2.service` to start openHAB running. Finally run `sudo systemctl start openhab.service` to start openHAB running.
## Explanation of Arguments Passed to Docker ## Explanation of Arguments Passed to Docker

2
installation/linux.md
View File

@ -628,7 +628,7 @@ sudo systemctl daemon-reload
## Backup and Restore ## Backup and Restore
It is recommended to make a backup of your configuration before *any* major change. It is recommended to make a backup of your configuration before *any* major change.
To make a backup of openHAB2, you need to retain your configuration and userdata files. To make a backup of openHAB 2 or higher, you need to retain your configuration and userdata files.
openHAB comes with scripts for storing your configuration in a zip file which is saved in `/var/lib/openhab/backups` for automatic installs and `openhab/backups` for manual installs. openHAB comes with scripts for storing your configuration in a zip file which is saved in `/var/lib/openhab/backups` for automatic installs and `openhab/backups` for manual installs.
You can change the default path by setting the $OPENHAB_BACKUPS environment variable. You can change the default path by setting the $OPENHAB_BACKUPS environment variable.