From e9c631e9e3e0a07a110a85221a6f0ed1912570d4 Mon Sep 17 00:00:00 2001 From: John Date: Sun, 17 Jan 2021 19:29:53 +0100 Subject: [PATCH] updated with multi arch info --- contrib/docker/README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/contrib/docker/README.md b/contrib/docker/README.md index ffe4ac85..0f9e4a8e 100644 --- a/contrib/docker/README.md +++ b/contrib/docker/README.md @@ -12,9 +12,18 @@ work well on a Synology Diskstation as well as Windows with Docker Desktop. Getting the image ----------------- -To download the latest image from the hub, use the following command: +To download the latest release image from the hub, use the following command: > docker pull john30/ebusd +The image is able to run on any of the following architectures and the right image will be picked automatically: +* amd64 +* arm32v7 + +In addition to the default "latest" tag, a development set of images is available with "devel" tag. This is built +automatically with every commit to the git repository. Run the following command to use it: + +> docker pull john30/ebusd:devel + Running interactively --------------------- @@ -40,13 +49,16 @@ In order to get the log output from ebusd, use the following command: Using a network device ---------------------- -When using a network device, the "--device" argument to docker can be omitted, but the device information has to be passed on to ebusd: +When using a network device, the "--device" argument to docker can be omitted, but the device information has to be +passed on to ebusd: > docker run --rm -it -p 8888 john30/ebusd -f --scanconfig -d udp:192.168.178.123:10000 --latency=80 -Note: the "-f" and "--scanconfig" arguments are only passed to ebusd if it is called without any additional arguments. So when passing further arguments, these two usually need to be added as well. +Note: the "-f" and "--scanconfig" arguments are only passed to ebusd if it is called without any additional arguments. +So when passing further arguments, these two usually need to be added as well. Running with MQTT broker ------------------------ -To start an ebusd container in the background and have it connect to your MQTT broker, use the following command while replacing "BROKERHOST" with your MQTT broker host name or IP address: +To start an ebusd container in the background and have it connect to your MQTT broker, use the following command while +replacing "BROKERHOST" with your MQTT broker host name or IP address: > docker run -d --name=ebusd --device=/dev/ttyUSB0 -p 8888 john30/ebusd -f --scanconfig -d /dev/ttyUSB0 --mqttport=1883 --mqtthost=BROKERHOST