Docker Installation - aseracorp/HA_enoceanmqtt GitHub Wiki

Docker Installation

A docker image is now available for the development version.

Install Docker

Download container-image (multi-arch):

docker pull ghcr.io/aseracorp/ha_enoceanmqtt

Example docker command:

sudo docker run --device=/dev/enocean -v ${PWD}/HA_enoceanmqtt-config:/config ghcr.io/aseracorp/ha_enoceanmqtt

The volume mount has to point to -v /local/path/to/configfile:/config. Or pass a docker volume created using the docker volume create command.

You can also use docker-compose as in the example below:

services:
  # adapt name to your liking
  ha_enoceanmqtt:
    container_name: ha_enoceanmqtt
    image: ghcr.io/aseracorp/ha_enoceanmqtt
    restart: unless-stopped
    volumes:
      #bind-mount
      - ${PWD}/HA_enoceanmqtt-config:/config
      # named Volume
      #- HA_enoceanmqtt-config:/config
    devices:
      # adapt to your device name
      - /dev/ttyUSB0:/dev/enocean:rwm
    environment:
      # Your Timezone, if not set on host, set manually
      - TZ=${TIMEZONE}
    # This command is not needed if your conf file is located at /config/enoceanmqtt.conf as this is the default location
    command: /config/enoceanmqtt.conf

You can also run with below additional options:

  • --logfile /config/enoceanmqtt.log to have logs generated to /config/enoceanmqtt.log
  • --debug to have debug messages in the log

Adapt enoceanmqtt.conf file in the /config folder to set parameters as well as devices to manage.
See Normal Usage for more details.

sudo docker exec -it ha_enoceanmqtt vi /config/enoceanmqtt.conf

Or on the host if u use a bind mount:

sudo nano ${PWD}/HA_enoceanmqtt/enoceanmqtt.conf

Or

sudo vi ${PWD}/HA_enoceanmqtt/enoceanmqtt.conf

Restart container:

sudo docker restart ha_enoceanmqtt

If you are using Kubernetes, there is also a Kubernetes template.

⚠️ **GitHub.com Fallback** ⚠️