Development (#250)

* remove unused variables
* fix badges
* user set

Author: xirixiz

.dockerignore

@@ -1,3 +1,6 @@
 .git
-LICENSE
+.gitignore
+.github
+.gitkeep
+.gitattributes
 README.md

.github/workflows/build_release.yml

@@ -19,7 +19,7 @@ env:
   DOCKER_BASE_IMAGE: python:3-alpine3.13
   DOCKER_TARGET_REPO: xirixiz/dsmr-reader-docker
   DOCKERFILE: Dockerfile
-  DOCKER_TARGET_RELEASE: 2021.12.08
+  DOCKER_TARGET_RELEASE: 2021.12.09
 
 jobs:
   ################################################
@@ -135,9 +135,9 @@ jobs:
         env:
           dsmr_version: ${{ steps.dsmr_version.outputs.version }}
         run: |
-          mkdir -p tmp/dsmr
-          curl -SskLf "https://github.com/dsmrreader/dsmr-reader/archive/v${dsmr_version}.tar.gz" | tar xvzf - --strip-components=1 -C tmp/dsmr
-          pushd tmp/dsmr &&
+          mkdir -p tmp/app
+          curl -SskLf "https://github.com/dsmrreader/dsmr-reader/archive/v${dsmr_version}.tar.gz" | tar xvzf - --strip-components=1 -C tmp/app
+          pushd tmp/app &&
           curl -SskLf "https://raw.githubusercontent.com/dsmrreader/dsmr-reader/v4/dsmr_datalogger/scripts/dsmr_datalogger_api_client.py" -O &&
           popd
 
@@ -181,6 +181,7 @@ jobs:
             --build-arg BASE_IMAGE=${{ matrix.BASE_IMAGE }} \
             --build-arg QEMU_ARCH=${{ matrix.QEMU_ARCH }} \
             --build-arg S6_ARCH=${{ matrix.S6_ARCH }} \
+            --build-arg DOCKER_TARGET_RELEASE=${DOCKER_TARGET_RELEASE} \
             -t ${DOCKER_TARGET_REPO}:${{ matrix.DOCKER_TAG_SUFFIX }}${DOCKER_TAG_SUFFIX_BRANCH} \
             .
 

.gitignore

@@ -1,4 +1,48 @@
-dsmrdb/
-src/dsmr/
-tmp/
-.DS_Store
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# =========================
+# Operating System Files
+# =========================
+
+# OSX
+# =========================
+
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+.jenkins-external
+
+# Ansible
+*.retry
+ansible.log

Dockerfile

@@ -4,11 +4,17 @@ FROM ${BASE_IMAGE:-amd64/python:3-alpine3.13}
 ARG QEMU_ARCH
 ARG S6_ARCH
 ARG DSMR_VERSION
+ARG DOCKER_TARGET_RELEASE
 
-ENV QEMU_ARCH=${QEMU_ARCH:-x86_64}
-ENV S6_ARCH=${S6_ARCH:-amd64}
-ENV S6_KEEP_ENV=1
-ENV DSMR_VERSION=${DSMR_VERSION:-4.19.0}
+# environment variables
+ENV PS1="$(whoami)@dsmr_reader_docker:$(pwd)\\$ " \
+    TERM="xterm"
+
+ENV QEMU_ARCH=${QEMU_ARCH:-x86_64} \
+    S6_ARCH=${S6_ARCH:-amd64} \
+    S6_KEEP_ENV=1 \
+    DSMR_VERSION=${DSMR_VERSION:-4.19.0} \
+    DOCKER_TARGET_RELEASE=${DOCKER_TARGET_RELEASE}
 
 ENV DJANGO_SECRET_KEY=dsmrreader \
     DJANGO_DATABASE_ENGINE=django.db.backends.postgresql \
@@ -23,15 +29,18 @@ ENV DJANGO_SECRET_KEY=dsmrreader \
     DATALOGGER_MODE=standalone \
     VACUUM_DB_ON_STARTUP=false
 
+# copy qemu, s6-overlay and local files
 COPY /tmp/qemu/qemu-${QEMU_ARCH}-static /usr/bin/qemu-${QEMU_ARCH}-static
 COPY /tmp/s6-${S6_ARCH}/ /
-COPY /tmp/dsmr/ /dsmr
-
-COPY app /app
+COPY /tmp/app/ /app
 COPY rootfs /
 
-RUN apk --update add --no-cache \
+RUN echo "**** install runtime packages ****" \
+    && apk --update add --no-cache \
     bash \
+    coreutils \
+    ca-certificates \
+    shadow \
     dpkg \
     curl \
     nginx \
@@ -42,30 +51,38 @@ RUN apk --update add --no-cache \
     mariadb-client \
     tzdata
 
-RUN cp -f /dsmr/dsmrreader/provisioning/django/settings.py.template /dsmr/dsmrreader/settings.py
-
-RUN apk add --no-cache --virtual .build-deps gcc python3-dev musl-dev postgresql-dev build-base mariadb-dev libressl-dev libffi-dev cargo rust \
+RUN echo "**** install build packages ****" \
+    && apk add --no-cache --virtual .build-deps gcc python3-dev musl-dev postgresql-dev build-base mariadb-dev libressl-dev libffi-dev cargo rust \
+    && echo "**** install pip packages ****" \
     && python3 -m pip install --upgrade pip \
-    && python3 -m pip install -r /dsmr/dsmrreader/provisioning/requirements/base.txt --no-cache-dir \
+    && python3 -m pip install -r /app/dsmrreader/provisioning/requirements/base.txt --no-cache-dir \
     && python3 -m pip install psycopg2 --no-cache-dir \
     && python3 -m pip install mysqlclient --no-cache-dir \
     && python3 -m pip install tzupdate --no-cache-dir \
+    && echo "**** create app user and make base folders ****" \
+    && groupmod -g 1000 users \
+    && useradd -u 803 -U -d /config -s /bin/false app \
+    && usermod -G users app \
     && mkdir -p /app /config /defaults \
+    && echo "**** copy default settings dsmr reader ****" \
+    && cp -f /app/dsmrreader/provisioning/django/settings.py.template /app/dsmrreader/settings.py \
+    && echo "**** cleanup package leftovers ****" \
     && apk --purge del .build-deps \
     && apk --purge del \
     && rm -rf /var/cache/apk/* \
     && rm -rf /tmp/*
 
-RUN mkdir -p /run/nginx/ \
+RUN echo "**** configure nginx package ****" \
+    && mkdir -p /run/nginx/ \
     && ln -sf /dev/stdout /var/log/nginx/access.log \
     && ln -sf /dev/stderr /var/log/nginx/error.log \
     && rm -f /etc/nginx/conf.d/default.conf \
     && mkdir -p /var/www/dsmrreader/static \
-    && cp -f /dsmr/dsmrreader/provisioning/nginx/dsmr-webinterface /etc/nginx/conf.d/dsmr-webinterface.conf
+    && cp -f /app/dsmrreader/provisioning/nginx/dsmr-webinterface /etc/nginx/conf.d/dsmr-webinterface.conf
 
 # TODO: Improve healtcheck to respond on 200 only
 HEALTHCHECK --interval=5s --timeout=3s --retries=10 CMD curl -Lsf http://127.0.0.1/about -o /dev/null -w "HTTP_%{http_code}" || exit 1
 
-WORKDIR /dsmr
+WORKDIR /app
 
 ENTRYPOINT ["/init"]

README.md

@@ -1,8 +1,10 @@
 <font size="-1">
 
-[![DockerPulls](https://img.shields.io/docker/pulls/xirixiz/dsmr-reader-docker.svg)](https://img.shields.io/docker/pulls/xirixiz/dsmr-reader-docker/)
-[![Docker Build Status](https://github.com/oznu/docker-homebridge/workflows/Build/badge.svg)](https://github.com/xirixiz/dsmr-reader-docker/actions)
-[![Donate](https://img.shields.io/badge/donate-paypal-yellowgreen.svg)](https://www.paypal.com/donate/?business=9M4P6DGT7U7VU&no_recurring=0&item_name=Open+source+project+development.&currency_code=EUR)
+[![Docker Pulls](https://img.shields.io/docker/pulls/xirixiz/dsmr-reader-docker.svg?logo=docker)](https://img.shields.io/docker/pulls/xirixiz/dsmr-reader-docker/)
+[![Docker Stars](https://img.shields.io/docker/stars/xirixiz/dsmr-reader-docker.svg?logo=docker)](https://hub.docker.com/r/xirixiz/dsmr-reader-docker)
+[![GitHub Build Status](https://github.com/xirixiz/dsmr-reader-docker/workflows/DSMR:%20Build%20Docker%20images/badge.svg?logo=github)](https://github.com/xirixiz/dsmr-reader-docker/actions)
+[![GitHub Stars](https://img.shields.io/github/stars/xirixiz/dsmr-reader-docker.svg?logo=github)](https://github.com/xirixiz/dsmr-reader-docker/)
+[![Donate](https://img.shields.io/badge/donate-paypal-yellowgreen.svg?logo=paypal)](https://www.paypal.com/donate/?business=9M4P6DGT7U7VU&no_recurring=0&item_name=Open+source+project+development.&currency_code=EUR)
 [![BuyMeCoffee][buymecoffeebadge]][buymecoffee]
 
 [buymecoffee]: https://www.buymeacoffee.com/xirixiz
@@ -67,6 +69,10 @@ Docker tags/releases can be found here: https://hub.docker.com/r/xirixiz/dsmr-re
   # Required (defaults are shown as value):
   - DJANGO_TIME_ZONE=Europe/Amsterdam
   - VIRTUAL_HOST=localhost
+  # It's possible to map a UID/GID with a user/group from you local system.
+  # This will not change the username, onbly match ID's to prevent issues with access rights!
+  - DUID=803
+  - DGID=803
   ```
 
 * ##### Nginx related:
@@ -186,12 +192,6 @@ Docker tags/releases can be found here: https://hub.docker.com/r/xirixiz/dsmr-re
 
 ***
 #### Features
-* ##### To-do list:
-  ```text
-  * Upgrade to Docker Alpine base image 3.13 - Done
-  * Upgrade to Postgres 13 client and backend - Done
-  ```
-
 * ##### DSMR Reader - Database cleanup/vacuum
   It could be that you receive a notification that the database is growing, like in this issue: https://github.com/dsmrreader/dsmr-reader/issues/1165.
 
@@ -209,7 +209,7 @@ Docker tags/releases can be found here: https://hub.docker.com/r/xirixiz/dsmr-re
 
   ```yaml
   volumes:
-    - ./modules/forward_telegram_to_api.py:/dsmr/dsmr_plugins/modules/forward_telegram_to_api.py
+    - ./modules/forward_telegram_to_api.py:/app/dsmr_plugins/modules/forward_telegram_to_api.py
   environment:
     - DSMRREADER_PLUGINS=dsmr_plugins.modules.forward_telegram_to_api
   ```
@@ -280,6 +280,15 @@ Docker tags/releases can be found here: https://hub.docker.com/r/xirixiz/dsmr-re
   - restart the dsmrdb container
   - start the dsmr container
   ```
+* ##### UID/GID
+  When using volumes (`-v` or `--volume` flags) permissions issues can occur between the host OS and the container, to avoid this you can specify a user id `DUID` and group id `DGID` from the local system in the Docker container. Make sure the owner of the directory has all permissions on the volume you'd like to mount into the Docker container.
+
+  You can identify a UID or GID by executing the following command
+
+  ```bash
+    id xirixiz
+    uid=1000(xirixiz) gid=1000(xirixiz) groups=1000(xirixiz) 1001(docker)
+  ```
 
 ***
 #### Issues
@@ -313,7 +322,7 @@ Docker tags/releases can be found here: https://hub.docker.com/r/xirixiz/dsmr-re
 * ##### Synology
   For Synology, or maybe other NAS appliances, an additional driver is required:
   * Drivers are required for DSM < 7.0: http://www.jadahl.com/drivers_6.1 or http://www.jadahl.com/drivers_6.2
-  * Drivers to enable USB for DSM > 7.0:
+  * Drivers to enable USB for DSM > 7.0: http://www.jadahl.com/iperf-arp-scan/DSM_7.0/
   ```sh
   sudo insmod /lib/modules/usbserial.ko
   sudo insmod /lib/modules/ftdi_sio.ko

examples/docker-compose.example.yaml

@@ -34,7 +34,7 @@ services:
     restart: always
     volumes:
       - /etc/localtime:/etc/localtime:ro
-      - ./dsmr_backups:/dsmr/backups
+      - ./dsmr_backups:/app/backups
     environment:
       - TZ=Europe/Amsterdam
       - DJANGO_TIME_ZONE=Europe/Amsterdam
@@ -45,10 +45,20 @@ services:
     devices:
       - /dev/ttyUSB0:/dev/ttyUSB0
     healthcheck:
-      test: [ "CMD", "curl", "-f", "http://localhost:80" ]
+      test:
+        [
+          "CMD",
+          "curl",
+          "-Lsf",
+          "http://127.0.0.1/about",
+          "-o",
+          "/dev/null",
+          "-w",
+          "HTTP_%{http_code}"
+        ]
       interval: 10s
       timeout: 5s
-      retries: 5
+      retries: 10
 
 volumes:
   dsmrdb: null

rootfs/app/.gitkeep

@@ -0,0 +1,25 @@
+#!/usr/bin/with-contenv bash
+
+DUID=${DUID:-803}
+DGID=${DGID:-803}
+
+groupmod -o -g "${DGID}" app
+usermod -o -u "${DUID}" app
+
+echo "
+-------------------------
+User UID: $(id -u app)
+User GID: $(id -g app)
+-------------------------
+"
+
+time32="$(date +%Y)"
+
+if [[ "${time32}" == "1970" || "${time32}" == "1969" ]] && [ "$(uname -m)" == "armv7l" ]; then
+  echo 'Your DockerHost is running an outdated version of libseccomp. Search internet to fix this!'
+  sleep infinity
+fi
+
+chown -R app:app /app
+chown -R app:app /config
+chown -R app:app /defaults