Skip to content

Latest commit

 

History

History
100 lines (85 loc) · 2.51 KB

README.Docker.md

File metadata and controls

100 lines (85 loc) · 2.51 KB
Raw

Running semonitor in docker

SEMonitor can be run within a Docker container. This provides isolation from other processes by running it in a containerized environment. As this is not and in-depth tutorial on docker, those with Docker, containers or cgroups see [docker.com][docker].

This guide is not a comprehensive guide, but just lists the most basic things!

Building the container

Building the container is only needed if the official one is not sufficient, or when developing on semonitor.

To build the image, the following can be used, where ISSUE-123 is just used as an example. It is important in that it will be re-used later.

docker image build \
    --file 'Containerfile' \
    --rm \
    --tag 'semonitor:ISSUE-123' \
    './'

Running tests

The tests are not included in the container image, so we volume mount them to make them available to the installed semonitor application.

docker container run \
    --interactive \
    --rm  \
    --tty \
    --user 'root:root' \
    --volume "$(pwd)/test:/usr/local/src/semonitor/test" \
    'semonitor:ISSUE-123' \
    '/bin/sh' -c 'runuser --user semonitor -- ./test/test.sh'

Running serial device

Running the semonitor on a serial device using the official latest image can be done as follows.

docker container run \
    --device '/dev/solaredge0:/dev/ttyUSB0' \
    --interactive \
    --rm  \
    --tty \
    --volume "$(pwd)/semonitor_logs/:/semonitor/" \
    'ghcr.io/jbuehl/solaredge:latest' \
    semonitor.sh \
        -a \
        -b 115200 \
        -m \
        -o "/semonitor/json/$(date +%Y%m%d).json" \
        -r "/semonitor/rec/$(date +%Y%m%d).rec" \
        -s '1234567' \
        -t 4 \
        '/dev/ttyUSB0'

Using compose

It is also possible to run the container using docker compose. Here an example. The device used is a udev symlinked serial to USB adapter, whith the appropriate permissions.

networks:
  semonitor: {}

volumes:
  semonitor:

services:
  sslh:
    image: ghcr.io/jbuehl/solaredge:master
    cap_drop:
      - all
    ulimits:
      nproc: 64
      nofile:
        soft: 4194304
        hard: 16777216
    devices:
      - /dev/solaredge:/dev/ttyUSB0
    env_file:
      - common.env
    volumes:
      - semonitor:/var/lib/semonitor:rw
    networks:
      - semonitor
    expose:
      - "80/tcp"
      - "22221-22222/tcp"
    command: -a -b 115200 -m -o "/var/lib/semonitor/json/__date__.json" -r "/var/lib/semonitor/rec/__date__.rec" -s '1234567' -t 4 '/dev/ttyUSB0'
    restart: unless-stopped