mirror of
https://github.com/buanet/ioBroker.docker.git
synced 2026-01-02 14:02:52 +02:00
preparing v4.2.1beta
This commit is contained in:
buanet
62
README.md
62
README.md
@@ -9,9 +9,9 @@
|
||||
[](https://github.com/buanet/docker-iobroker/blob/master/LICENSE.md)
|
||||
[](https://paypal.me/buanet)
|
||||
|
||||
IoBroker for Docker is a Dockerimage for ioBroker IoT platform (http://www.iobroker.net).
|
||||
IoBroker for Docker is a Docker image for ioBroker IoT platform (http://www.iobroker.net).
|
||||
|
||||
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.
|
||||
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 Docker image for running ioBroker IoT platform with Docker.
|
||||
|
||||
Since v4.0.0 the image is available for the following architectures: amd64, armv7hf, aarch64.<br>
|
||||
If you need more please let me know by opening a Github issue.
|
||||
@@ -20,21 +20,21 @@ If you need more please let me know by opening a Github issue.
|
||||
|
||||
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".
|
||||
You might avoid these procedure if you use my "Best practice" hint for "upgrading your ioBroker container".<br>
|
||||
In any case make a backup first!
|
||||
|
||||
By the way, a more comfortable way is to use "iobroker backup" to create a full backup of your existing installation and copy it into a empty folder which you will mount to /opt/iobroker when setting up a new container. The startup script will automatically detect the backup file and restore it to the new container. For more details see "Mounting folder/ volume" section of this readme.md file.
|
||||
|
||||
## Getting started
|
||||
|
||||
A detailed tutorial (german, based on v3.0.0) can be found here: [https://buanet.de](https://buanet.de/2019/05/iobroker-unter-docker-auf-der-synology-diskstation-v3/). Please notice that the old tutorial is outdated and does no longer work!
|
||||
A detailed tutorial (German, based on v3.0.0) can be found here: [https://buanet.de](https://buanet.de/2019/05/iobroker-unter-docker-auf-der-synology-diskstation-v3/). Please notice that the old tutorial is outdated and does no longer work!
|
||||
|
||||
For discussion and support please visit [ioBroker forum thread](http://forum.iobroker.net/viewtopic.php?f=17&t=5089) or use the comments section at the linked tutorial. Please do not contact me directly for any support-reasons. Every support question should be answered in a public place. Thanks in advance.
|
||||
If you think you found a bug or simply want to request a new feature please open an issue on Github.
|
||||
|
||||
The following ways to get iobroker-container running are only examples. Maybe you have to change, add or replace parameters to configure ioBroker for fitting your needs.
|
||||
|
||||
### Running from commandline
|
||||
### Running from command line
|
||||
|
||||
For taking a first look at the iobroker docker container it would be enough to simply run the following basic docker run command:
|
||||
|
||||
@@ -68,7 +68,7 @@ The following will give a short overview.
|
||||
### Environment variables
|
||||
|
||||
To configure the ioBroker container on startup it is possible to set some environment variables.
|
||||
You do not have to declare every single variable when stting up your container. Variables you do not set will come up with their default value.
|
||||
You do not have to declare every single variable when setting up your container. Variables you do not set will come up with their default value.
|
||||
|
||||
**Important: In v4.2.0 the ENVs "ADMINPORT" and "REDIS" were renamed/ reorganized. For Details see the following table!**
|
||||
|
||||
@@ -94,9 +94,9 @@ You do not have to declare every single variable when stting up your container.
|
||||
|
||||
### Mounting folder/ volume
|
||||
|
||||
It is possible to mount an empty folder to /opt/iobroker during first startup of the container. The Startupscript will check this folder and restore content if it is empty.
|
||||
It is possible to mount an empty folder to /opt/iobroker during first startup of the container. The startup script will check this folder and restore content if it is empty.
|
||||
Since v4.1.0 it is also possible mount a folder filled up with an iobroker backup file (for example created with backitup adapter) named like this: "iobroker_2020_01_06-01_09_10_backupiobroker.tar.gz".
|
||||
The startup script will detect this backup and restore it during the start of the container. Plese see container logs when starting the container for more details!
|
||||
The startup script will detect this backup and restore it during the start of the container. Please see container logs when starting the container for more details!
|
||||
|
||||
Note: It is absolutely recommended to use a mounted folder or persistent volume for /opt/iobroker folder!
|
||||
|
||||
@@ -105,13 +105,13 @@ But watch for the used node version. If the existing installation runs with anot
|
||||
|
||||
**Important: If the folder you mount to /opt/iobroker in your container is placed on a mounted device, partition or other storage, the mountpoint on your host should NOT have the "noexec" flag activated. Otherwise you may get problems executing ioBroker inside the container!**
|
||||
|
||||
### Mounting USB device
|
||||
### Mounting USB device
|
||||
|
||||
If you want to use a USB device within ioBroker inside your container don´t forget to [mount the device](https://docs.docker.com/engine/reference/commandline/run/#add-host-device-to-container---device) on container startup and use the environment variable "USBDEVICES".
|
||||
|
||||
### Userdefined startup scripts
|
||||
|
||||
In some cases it migth be helpful to add some script code to the startup script of the container. This is now possible by mounting an additional folder to the container and place a userscript in there.
|
||||
In some cases it might be helpful to add some script code to the startup script of the container. This is now possible by mounting an additional folder to the container and place a userscript in there.
|
||||
The folder containing your userscripts must be mounted under /opt/userscripts inside the container. If you mount an empty folder you will get two example scripts to be restored in that folder. Just try it out.
|
||||
|
||||
Basically there are two different scripts which will be read and called by the startup script. One that will only be called once at the first start of the container (userscript_firststart.sh) and one which will be called for every start of the container (userscript_everystart.sh).
|
||||
@@ -123,36 +123,44 @@ To get familiar with that feature try the following: Create a Container, mount a
|
||||
|
||||
### 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>
|
||||
To avoid conflicts when upgrading your container or getting in trouble when accidentally upgrading your container to a new major version I prefer using the version tag like "V4.2.0" instead of "latest" for creating your 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 container 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
|
||||
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 backup 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 command line ("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
|
||||
* create a new and empty data folder or volume and place your backup file in it
|
||||
* create a new container as your old or as you need it and use the new data folder/ volume for the /opt/iobroker mount point
|
||||
* 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...
|
||||
After this the startup script 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
|
||||
|
||||
### Beta testing
|
||||
|
||||
If you want to get the newest features and changes feel free to use/ test the beta version of the Docker image. You can find the readme.md file for beta versions [here](https://github.com/buanet/docker-iobroker/blob/beta/README.md).
|
||||
|
||||
### Subscribe to updates
|
||||
|
||||
If you want the newest updates about the image and my tutorials at https://buanet.de/tutorials you can simply subscribe to my new "news and updates" channel (only in german) on Telegram.
|
||||
If you want the newest updates about the image and my tutorials at https://buanet.de/tutorials you can simply subscribe to my new "news and updates" channel (only in German) on Telegram.
|
||||
You will find the channel here: https://t.me/buanet_tutorials
|
||||
|
||||
### Support the project
|
||||
|
||||
The easiest way to support this project is to leave me some likes/ stars on github and docker hub!<br>
|
||||
The easiest way to support this project is to leave me some likes/ stars on Github and Docker hub!<br>
|
||||
If you want to give something back, feel free to take a look into the [open issues](https://github.com/buanet/docker-iobroker/issues) or the [ioBroker forum thread](http://forum.iobroker.net/viewtopic.php?f=17&t=5089) and helping me answering questions, fixing bugs or adding new features!<br>
|
||||
And if you want to buy me a beer instead, you can do this here: <a href="https://www.paypal.me/buanet" target="_blank"><img src="https://buanet.de/wp-content/uploads/2017/08/pp128.png" height="20" width="20"></a><br>
|
||||
Thank you!
|
||||
|
||||
## Changelog
|
||||
|
||||
### v4.2.1beta (2020-05-10)
|
||||
* using node 12 instead of 10
|
||||
* updated documentation in readme.md
|
||||
|
||||
### v4.2.0 (2020-04-14)
|
||||
* v4.1.4beta (2020-04-07)
|
||||
* switching base image to buster
|
||||
@@ -160,9 +168,9 @@ Thank you!
|
||||
* v4.1.3beta (2020-02-08)
|
||||
* renamed ENV for adminport (new "IOB_ADMINPORT)")
|
||||
* added new ENVs for "iobroker setup custom" (replacing "REDIS")
|
||||
* enhancements in startupscript logging
|
||||
* enhancements in startup script logging
|
||||
* v4.1.2beta (2020-02-02)
|
||||
* added feature for running userdefined scripts on startup
|
||||
* added feature for running user defined scripts on startup
|
||||
* small fix for permissions issues on some systems
|
||||
* v4.1.1beta (2020-01-17)
|
||||
* updated openzwave to version 1.6.1007
|
||||
@@ -174,19 +182,19 @@ Thank you!
|
||||
* small fixes according to "docker best practices"
|
||||
* v4.0.2beta (2019-12-10)
|
||||
* ~~added env for activating redis~~
|
||||
* enhancements in startupscript and dockerfile
|
||||
* enhancements in startup script and docker file
|
||||
* v4.0.1beta (2019-11-25)
|
||||
* added env for iobroker admin port
|
||||
* added env for usb-devices (setting permissions)
|
||||
* updateing prerequisites for iobroker installation
|
||||
* some small codefixes
|
||||
* some small code fixes
|
||||
|
||||
### v4.0.0 (2019-10-25)
|
||||
* v3.1.4beta (2019-10-23)
|
||||
* added env for zwave support
|
||||
* v3.1.3beta (2019-10-17)
|
||||
* enhanced logging of startup-script
|
||||
* multiarch support (amd64, aarch64, armv7hf)
|
||||
* multi arch support (amd64, aarch64, armv7hf)
|
||||
* v3.1.2beta (2019-09-03)
|
||||
* using node 10 instead of node 8
|
||||
* v3.1.1beta (2019-09-02)
|
||||
@@ -204,10 +212,10 @@ Thank you!
|
||||
### v3.0.0 (2019-05-09)
|
||||
* v2.0.6beta (2019-04-14)
|
||||
* added some additional logging
|
||||
* fixing some issues for languag env
|
||||
* fixing some issues for language env
|
||||
* added permission fixing on first start
|
||||
* v2.0.5beta (2019-02-09)
|
||||
* added ENV to dockerfile
|
||||
* added ENV to docker file
|
||||
* added EXPOSE for admin
|
||||
* final testing
|
||||
* v2.0.4beta (2019-01-28)
|
||||
@@ -220,7 +228,7 @@ Thank you!
|
||||
* optimizing logging output
|
||||
* optimizing scripts
|
||||
* v2.0.2beta (2019-01-23)
|
||||
* optimizing and rearraged dockerfile
|
||||
* optimizing and rearranged docker file
|
||||
* changes for new ioBroker install script
|
||||
* added restoring for empty mounted /opt/iobroker folder
|
||||
* some more small fixes
|
||||
@@ -255,7 +263,7 @@ Thank you!
|
||||
|
||||
### v1.0.0 (2017-08-22)
|
||||
* moved and renamed iobroker startup script
|
||||
* disabled iobroker deamon to (hopefully) fix restart issue
|
||||
* disabled iobroker daemon to (hopefully) fix restart issue
|
||||
* added some maintenance scripts
|
||||
|
||||
### v0.2.1 (2017-08-16)
|
||||
|
||||
@@ -30,8 +30,8 @@ RUN apt-get update && apt-get install -y \
|
||||
wget \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Install node10
|
||||
RUN curl -sL https://deb.nodesource.com/setup_10.x | bash \
|
||||
# Install node
|
||||
RUN curl -sL https://deb.nodesource.com/setup_12.x | bash \
|
||||
&& apt-get update && apt-get install -y nodejs \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
|
||||
@@ -30,8 +30,8 @@ RUN apt-get update && apt-get install -y \
|
||||
wget \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Install node10
|
||||
RUN curl -sL https://deb.nodesource.com/setup_10.x | bash \
|
||||
# Install node
|
||||
RUN curl -sL https://deb.nodesource.com/setup_12.x | bash \
|
||||
&& apt-get update && apt-get install -y nodejs \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
|
||||
Reference in New Issue
Block a user