diff --git a/README.Docker.md b/README.Docker.md index fba78fe..fccb430 100644 --- a/README.Docker.md +++ b/README.Docker.md @@ -12,9 +12,10 @@ Building should be a simple matter: All configuration for the docker container is handled through environment variables. You can pass these to `docker run` using the -e flag. At a minimum you need to set `WATCHED_METERS`. + | Environment Variable | Default | Required | Description | -|----------------------|----------|-------------| -| WATCHED_METERS | | Yes | A comma or space separated list of meters to watch | +| -------------------- | ------- | -------- | ----------- | +| WATCHED_METERS | | Yes | A comma or space separated list of meter ids to watch | | WH_MULTIPLIER | 1000 | No | multiplier to get reading to Watt Hours (Wh) | | READINGS_PER_HOUR | 12 | No | number of IDM intervals per hour reported by the meter | | MQTT_HOST | `127.0.0.1` | No | MQTT host to report to | @@ -22,6 +23,7 @@ All configuration for the docker container is handled through environment variab | MQTT_USER | | No | MQTT username for authentication | | MQTT_PASSWORD | | No | MQTT password for authentication | + ## Running In order to run your container will need to be both privileged and have a volume mount to `/dev/bus/usb`. You can do that by adding these arguments to `docker run`: