audrius/ioBroker.docker
1
0
Fork 0
mirror of https://github.com/buanet/ioBroker.docker.git synced 2025-12-18 10:59:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Andre Germann
2020-05-08 23:54:42 +02:00
committed by GitHub
parent 0b705506cf
commit b7e9efaf40
1 changed files with 26 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -9,20 +9,19 @@
[![License](https://img.shields.io/github/license/buanet/docker-iobroker)](https://github.com/buanet/docker-iobroker/blob/master/LICENSE.md)
[![Donate](https://img.shields.io/badge/donate-paypal-blue)](https://paypal.me/buanet)
IoBroker for Docker is an Dockerimage for ioBroker IoT platform (http://www.iobroker.net).
IoBroker for Docker is a Dockerimage for ioBroker IoT platform (http://www.iobroker.net).
It is originally made for and always tested on a Synology Disk Station 1515+ with DSM 6 and official Docker package installed. But it also works on other systems with Docker installed!
It was originally created for a Synology Disk Station 1515+ with DSM 6 and official Docker package installed. After more than three years of development it might be the best documented and still maintained Dockrimage for running ioBroker ioT platform with Docker.
Version 4 now supports running the Image in Docker on the following architectures: amd64, armv7hf, aarch64.
Feel free to ask for more architectures by opening an github issue.
Since v4.0.0 the image is available for the following architectures: amd64, armv7hf, aarch64.
If you need more please let me know by opening a Github issue.
## Important notice
The new v4 comes again with a new major node version (node10)!
If you are updating an existing installation you have to perform some additional steps inside ioBroker!
After upgrading your iobroker container you have to call "npm rebuild" or "reinstall.sh" (when js-controller > v1.5 "reinstall.js") for recompileing your installation for the use with node10!
For more details please see official ioBroker documentation: [EN](https://www.iobroker.net/#en/documentation/install/updatenode.md) | [DE](https://www.iobroker.net/#de/documentation/install/updatenode.md).
Make backup first!
Normally a new major version (e.g. v2, v4 and upcoming v5) of the image comes with a new, preinstalled major node version!
If you are updating an existing installation to a new major version (e.g. from v4 to v5) you have to perform some additional steps inside ioBroker! For more details please see official ioBroker documentation: [EN](https://www.iobroker.net/#en/documentation/install/updatenode.md) | [DE](https://www.iobroker.net/#de/documentation/install/updatenode.md).<br>
You might avoid these procedure if you use my "Best practise" hint for "upgrading your ioBroker container".
In any case make a backup first!
## Getting started
@@ -117,6 +116,24 @@ Basically there are two different scripts which will be read and called by the s
Hint:
To get familiar with that feature try the following: Create a Container, mount an empty folder to /opt/userscripts, start your container. Two scripts will be restored into the empty folder. Rename the example scripts by simply removing "\_example". Restart your container and take a look at the Log. In "Step 4 of 5: Applying special settings" you will see the messages generated by the example userscripts.
## Best practices
### Avoid using "latest" tag
To avoid conflicts when upgrading your container or getting in trouble when accedentially upgrading your container to a new major version I prefer using the version tag like "V4.2.0" instead of "latest" for creating yor container. Just think about when I tell you it is not possible to download a new image version of a specific tag as long as a conrainer depends on it.<br>
By the way it also makes it more safe to keep your image up to date by using "watchtower" or something like that.
### Upgrading you container
If you want to upgrade your ioBroker container to a new major version (e.g. from v4 to v5) I would prefer to do that by creating a bockup in ioBroker (by "iobroker backup" or backitup adapter) and restoring it to a completely new container. All you need is time an the following steps:
* make a backup by Commandline ("iobroker backup") or backitup adapter
* stop the old container
* create a new and empty data folder or volume and place your backupfile in it
* create a new container as your old or as you need it and use the new data folder/ volume for the /opt/iobroke mountpoint
* follow the log output of the container and be patient
After this the startupscript inside the container will automatically detect and restore your backup to a new ioBroker instance. When iobroker is started after the restore it will install your adapters to the new ioBroker instance by itself. This might take some time but will get you the best and cleanest results...
## Miscellaneous
### Subscribe to updates