Add DSM 7 support to synology.md (#1673)

* Update synology.md Added the installation for DSM 7. Now a Synology specific docker is needed. Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Removed the use of bridge in network Bridge makes the installation of openhab on synology more complex, it limits the internal ip traffic to stay in the container. Bindings like Network Binding won't work easily. Normally you would optimize for security, but here the choice was made to optimize for ease of use. The latter is also the case if openhab was installed directly on the synology like we did on oh2 Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Style change Co-authored-by: Wouter Born <github@maindrain.net> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Style change Co-authored-by: Wouter Born <github@maindrain.net> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Added DSM 7 support with correct style rules * Adding DSM 7 installation Commit the changes on brand names and newlines. Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * Update installation/synology.md Co-authored-by: Wouter Born <github@maindrain.net> * added image for the Orbit b-Hyve binding (#1631) Signed-off-by: Ondrej Pecta <opecta@gmail.com> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Update expire examples (#1629) * Update expire examples Added a description that the expire parameter can be combined with items that are connected to a channel. Added an example to show the correct syntax when combining channels and expire. Signed-off-by: Michael Bredehorn michael@bredehorn.nrw (github: bredmich) Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Fix copy&paste typo in example code (#1644) Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Fixed broken links to item details (#1633) Some of the links under `General remarks on parameters:` were broken and redirect to a 404 site. Wrong link: `(items.html#item-syntax)` Correct link: `({{base}}/configuration/items.html#item-syntax)` Signed-off-by: Michael Bredehorn michael@bredehorn.nrw (github: bredmich) Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * improve openHABian install instructions and work around a Github issue to display the breaking changes (#1634) Signed-off-by: Markus Storm <markus.storm@gmx.net> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Add logos for wled and ipobserver (#1635) Signed-off-by: Matthew Skinner <matt@pcmus.com> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Update vscode.md Signed-off-by: Michael Geramb (github: mgeramb) (#1636) Because / is allowed in Windows 10+, the path example should use / instead of \ because this will work on linux too Signed-off-by: Michael Geramb <mail@michael-geramb.at> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Update floorplan-pages.md to show URL details required (#1643) Add some detail to the Floor Plan documentation to show the correct URL to use for Browser and Android App to prevent blank images on the Android app related to non relative URL Signed-off-by: Mark van Gelder <vangelder.mark@gmail.com> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Update Eclipse IDE docs (#1645) * A log4j2.xml file is used for configuring the logging instead of logback.xml * All openHAB development is now done on the 'main' branches/streams (and not 2.5.x 3.0.x branches) See: * openhab/openhab-distro#1273 * openhab/openhab-distro#1278 Signed-off-by: Wouter Born <github@maindrain.net> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Mikrotik binding logo (#1648) Signed-off-by: Oleg Vivtash <oleg@vivtash.net> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Update "Default Tags" documentation (#1651) There used to be the following "Default Tags" which are no longer used in the current semantic model: * Lighting * Switchable * CurrentTemperature * TargetTemperature * CurrentHumidity Related to openhab/openhab-addons#11313 Signed-off-by: Wouter Born <github@maindrain.net> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Fix samba-tool testparm (#1650) The actual command "samba-tool" was missing to run the "testparm" subcommand. Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Add logos for featured add-ons in marketplace (#1652) Add a PNG version of the macOS add-on. Signed-off-by: Yannick Schaus <github@schaus.net> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Create souliss.png (#1663) Logo for Souliss binding Signed-off-by: Luca Calcaterra <calcaterra.luca@gmail.com> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Fix link in Contributing section (#1664) Signed-off-by: Wouter Born <github@maindrain.net> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Remove broken link to Raspberry Pi page (#1666) This page was removed with https://github.com/openhab/openhab-docs/pull/1533. Signed-off-by: Wouter Born <github@maindrain.net> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Adding haywardomnilogic.png (#1653) Signed-off-by: Matt Myers <mmyers75@icloud.com> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Removed author-tags in binding definitions (#1654) Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Removed author-tags from binding definitions (#1655) Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Removed author-tags from binding definitions (#1656) Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Update synology.md Added the installation for DSM 7. Now a Synology specific docker is needed. Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Removed the use of bridge in network Bridge makes the installation of openhab on synology more complex, it limits the internal ip traffic to stay in the container. Bindings like Network Binding won't work easily. Normally you would optimize for security, but here the choice was made to optimize for ease of use. The latter is also the case if openhab was installed directly on the synology like we did on oh2 Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Style change Co-authored-by: Wouter Born <github@maindrain.net> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Style change Co-authored-by: Wouter Born <github@maindrain.net> Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Added DSM 7 support with correct style rules Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Adding DSM 7 installation Commit the changes on brand names and newlines. Signed-off-by: André Scholten <36789802+TallDragon@users.noreply.github.com> * Update synology.md * Fix markdown Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Remove trailing spaces Signed-off-by: Jerome Luckenbach <github@luckenba.ch> Co-authored-by: Wouter Born <github@maindrain.net> Co-authored-by: Ondrej Pecta <opecta@gmail.com> Co-authored-by: Michael B <bredmich@users.noreply.github.com> Co-authored-by: juergencodes <58371839+juergencodes@users.noreply.github.com> Co-authored-by: Markus Storm <markus.storm@gmx.net> Co-authored-by: Matthew Skinner <matt@pcmus.com> Co-authored-by: Michael Geramb <mail@michael-geramb.at> Co-authored-by: Mark van Gelder <vangelder.mark@gmail.com> Co-authored-by: Oleg Vivtash <oleg@vivtash.net> Co-authored-by: Per Skenhall <per_skenhall@hotmail.com> Co-authored-by: Yannick Schaus <github@schaus.net> Co-authored-by: Luca Calcaterra <calcaterra.luca@gmail.com> Co-authored-by: Matt <mmyers75@icloud.com> Co-authored-by: Christoph Weitkamp <github@christophweitkamp.de> Co-authored-by: Jerome Luckenbach <github@luckenba.ch>
2021-11-26 15:33:08 +01:00 · 2021-11-26 15:33:08 +01:00 · 7e8100f302
parent 2fccb34061
commit 7e8100f302
1 changed files with 130 additions and 2 deletions
--- a/installation/synology.md
+++ b/installation/synology.md
@ -3,7 +3,134 @@ layout: documentation
 title: Synology DiskStation
 ---
-# Synology DiskStation
+# Synology DiskStation DSM 7.0 and higher
 The [DiskStation by Synology](https://www.synology.com/en-us/dsm) is a famous NAS server solution for your home, allowing the installation of additional packages.
 For versions of DSM before 7.0 please refer to the second half of this page.
 ## Prerequisite - prepare the Synology OS for openHAB
 Synology NAS is based on Linux but it has limitations since it is not a full server.
 There are some shortcuts you have to take to make it work.  
 For the use of openHAB you need some preparation steps.
 For this create a ssh session into your NAS.
 For reference how to do that: I found this [youtube tutorial](https://www.youtube.com/watch?v=BCCIMRbAUp8).
 When you are in the secured shell first thing to do is to create the user openhab.
 ```bash
 sudo synouser --add openhab habopen
 sudo synogroup --add openhab openhab
 ```
 If you are going to use an USB like a Z-Wave dongle add another group for openhab and change the port access for ttyACM0 if that is the port for your USB device
 ```bash
 sudo synogroup --add dialout openhab
 sudo chown root:dialout /dev/ttyACM0
 sudo chmod g+rw /dev/ttyACM0
 ```
 Then for installation purposes run the following command:
 ```bash
 sudo id openhab
 ```
 The result will something like
 ```bash
 uid=1032(openhab) gid=100(users) groups=100(users),65537(dialout),65539(openhab)
 ```
 In this case we need the 1032 as the user and the 65539 as the group. Write them down.
 ## Docker
 DSM 7 does not longer support Java 11 directly and therefor openHAB has to run in a Docker container.
 And that also makes the installation easier to maintain.
 It works out of the box a bit different then the normal Docker installation as described in de openHAB documententation.
 Docker is a containerization platform and is used to run lightweight containers.
 These containers require a very little amount of memory and system resources to run.
 Synology NAS has official support for Docker.
 To use Docker, you need to install the Docker app from the Synology Web GUI.
 - Login and open the DiskStation Manager.
 - Go to Main Menu → Package Center.
 - Search for "Docker" and install.
 - Click "Open".
 - Go to "Registry", here are all the available Docker images and search for openhab.
 - Choose the "openhab/openhab" image and click "Download". Select "latest" since that is the latest stable version of openHAB. The Docker image is added to "Image"
 - Go to "Image" and click on the openhab/openhab image and click "Add".
 Here comes the part where you really notice the difference between the Synology OS and Linux.
 - On the create container window fill a name for the container (space and some special characters are not allowed).
 - Next enable "Execute container using high privilege".
 ::: tip Note
 This is needed for the host resources like '/dev/ttyACM0' for Z-Wave binding, the TCP stack for Network Binding, etc.
 It will run the Docker container as root, the application in the container is still limited.
 Several issues are already raised for this at Synology.
 :::
 - Enable the resource limitation, CPU on Med and Memory limit on 2048MB.
 You can increase this in the future if you like.
 - Click on "Advanced"
 ### Advanced Settings
 - Enable auto-restart
 ### Volume
 - Click on "Add Folder" and "Create Folder" under the folder "docker" with the name "openHAB".
 - Create the folder "userdata" in the folder "openHAB"
 - Create the folder "conf" in the folder "openHAB"
 - Create the folder "addons" in the folder "openHAB"
 - Now select "userdata" and click on "Select"
 - Change the mount path to "/openhab/userdata" this will connect the Docker containers path "/openhab/userdata" to your Synology's local path "docker/openHAB/userdata" where you can reach it from outside the Docker.
 - Click on "Add Folder", select "docker/openHAB/conf", click on select and change the mount path to "/openhab/conf".
 - Repeat this for addons.
 ### Network
 - Select 'host' if you are planning to use the IP stack in bindings or if you are not sure what this does.
 ### Port Settings
 - No change
 ### Links
 - Nothing to do here
 ### Environment
 - In the list find the variable "GROUP_ID" and put your previous written down id of the group openhab here, in this tutorial it is 65539.
 - In the same list locate "USER_ID" and fill the id of the user openhab, in this tutorial 1032.
 - Click on "Apply".
 ### Summary
 Here you can check if all changes where set correctly for your openHAB container, enable "Run this container after the wizard is finished" and press "Done".
 openHAB is now running on your NAS.
 Give it a few minutes to start up.
 ## Shells
 If you select the container running and press "Details" you will end up on  a windows where you get more information on this running container.
 One particular menu item you have to check is "Terminal".
 In here you see the name of the container left from the black field and if you press that you'll get the Karaf terminal for openHAB.
 If you click on "Create' it creates a bash terminal, click on bash and you'll have access to a shell in the container.
 By now the container is up and running, goto "http://[your-NAS-ip-or-host-name]:8080" and the welcome to openHAB.
 If you use p.e. a Z-Wave dongle on ttyACM0 you can now add the Z-Wave binding. Once openHAB has been configured under the binding Z-Wave add a controller manually and change the port to /dev/ttyACM0. The Z-Wave controller gets online and you will discover the Z-Wave devices. If this is not working, please verify you enabled high privilege.
 ::: tip Note
 The device path (`/dev/ttyACM0`) or container name (`openhab`) could be different in your system, please modify the commands accordingly.
 :::
 ---
 # Older Synology DiskStations till DSM 6
 The [DiskStation by Synology](https://www.synology.com/en-us/dsm) is a famous NAS server solution for your home, allowing the installation of additional packages.
 We are proud to be able to provide an [openHAB Synology package](https://github.com/openhab/openhab-syno-spk).
@ -68,6 +195,7 @@ The openHAB log files can be found here:
 From Version openHAB-2.2.0.006 the SPK generates two log files located at `/var/log/`.
-The first log file `openHAB-install.log` will be generated during the installation. If you can't install the openHAB SPK, please have a look inside the file.
+The first log file `openHAB-install.log` will be generated during the installation.
 If you can't install the openHAB SPK, please have a look inside the file.
 The second log `openHAB-start-stop.log` will be generated by starting and stopping openHAB inside the Package Manager.