added Readme

2017-02-04 13:15:08 +01:00
parent 0a3a78d788
commit a672326519
2 changed files with 53 additions and 12 deletions
@@ -0,0 +1,52 @@
+ebusd Docker image
+==================
+
+An [ebusd](https://github.com/john30/ebusd/) Docker image is available on the
+[Docker Hub](https://hub.docker.com/r/john30/ebusd/) and comes with the latest German
+[configuration files](https://github.com/john30/ebusd-configuration/).
+
+It allows you to run ebusd without actually installing (or even building) it on your system.
+You might even be able to run it on a non-Linux operating system, which is at least known to
+work well on a  (this is known to work on a Synology Diskstation).
+
+
+Getting the image
+-----------------
+To download the latest image from the hub, use the following command:  
+> docker pull john30/ebusd
+
+
+Running interactively
+---------------------
+
+To run an ebusd container interactively, e.g. on serial device /dev/ttyUSB1, use the following command:
+> docker run --rm -it --device=/dev/ttyUSB1:/dev/ttyUSB0 -p 8888 john30/ebusd
+
+This will show the ebusd output directly in the terminal.
+
+
+Running in background
+---------------------
+
+To start an ebusd container and have it run in the background, e.g. on serial device /dev/ttyUSB1, use the following command:
+> docker run -d --name=ebusd --device=/dev/ttyUSB1:/dev/ttyUSB0 -p 8888 john30/ebusd
+
+The container has the name "ebusd", so you can use that when querying docker about the container.
+
+In order to get the log output from ebusd, use the following command:
+> docker logs ebusd
+
+
+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:
+> docker run --rm -it -p 8888 john30/ebusd -f --scanconfig -d udp:192.168.178.123:10000 --latency=80000
+
+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 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 repacing "<YOUR MQTT BROKER HOST>" 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=<YOUR MQTT BROKER HOST>