update

birdnet-pi/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.13 (27-04-2024)
+- Initial build

birdnet-pi/Dockerfile

@@ -0,0 +1,183 @@
+#============================#
+#  ALEXBELGIUM'S DOCKERFILE  #
+#============================#
+#           _.------.
+#       _.-`    ('>.-`"""-.
+# '.--'`       _'`   _ .--.)
+#    -'         '-.-';`   `
+#    ' -      _.'  ``'--.
+#        '---`    .-'""`
+#               /`
+#=== Home Assistant Addon ===#
+
+#################
+# 1 Build Image #
+#################
+
+ARG BUILD_VERSION
+ARG BUILD_FROM
+FROM ${BUILD_FROM}
+
+ENV DEBIAN_FRONTEND="noninteractive" \
+    BIRDNET_USER="pi" \
+    USER="pi" \
+    PUID=1000 \
+    PGID=1000 \
+    HOME="/home/pi" \
+    XDG_RUNTIME_DIR="/run/user/1000" \
+    PYTHON_VIRTUAL_ENV="/home/pi/BirdNET-Pi/birdnet/bin/python3"
+
+# hadolint ignore=DL3015,SC2016
+RUN \
+    # Install dependencies
+    echo "Install dependencies" && \
+    apt-get update -y && apt-get install curl gcc python3-dev git jq sudo php-mbstring -y && \
+    \
+    # Correct for systemctl
+    curl -f -L -s -S https://raw.githubusercontent.com/gdraheim/docker-systemctl-replacement/master/files/docker/systemctl3.py -o /bin/systemctl && \
+    chmod a+x /bin/systemctl && \
+    \
+    # Change user to pi and create /home/pi
+    echo "setting users" && \
+    groupmod -o -g 101 abc && usermod -o -u 101 abc && \
+    groupadd --non-unique -g 1000 pi && \
+    useradd --non-unique --uid 1000 --gid 1000 -m pi && \
+    \
+    # Ensure permissions
+    echo "setting permissions" && \
+    echo "pi ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers && \
+    mkdir -p /home/pi/.config/matplotlib && \
+    chown -R 1000:1000 /home/pi && \
+    \
+    # Download installer
+    curl -f -L -s -S "https://raw.githubusercontent.com/Nachtzuster/BirdNET-Pi/main/newinstaller.sh" -o /newinstaller.sh && \
+    chmod 777 /newinstaller.sh && \
+    \
+    # Use installer to modify other scripts
+    #######################################
+    # Define file
+    sed -i "1a /./newinstallermod.sh && rm /newinstallermod.sh" /newinstaller.sh && \
+    echo '#!/bin/bash' >> /newinstallermod.sh && \
+    # Remove all instances of sudo from all other scripts
+    echo 'for file in $(grep -srl "sudo" $HOME/BirdNET-Pi/scripts); do sed -i "s|sudo ||" "$file"; done' >> /newinstallermod.sh && \
+    echo 'for file in $(grep -srl "my_dir" $HOME/BirdNET-Pi/scripts); do sed -i "s|\$my_dir|/config|" "$file"; done' >> /newinstallermod.sh && \
+    # Disable pulseaudio
+    echo 'for file in $(grep -srl "pulseaudio --start" $HOME/BirdNET-Pi/scripts); do sed -i "/pulseaudio --start/d" "$file"; done' >> /newinstallermod.sh && \
+    # Set permission
+    chmod +x /newinstallermod.sh && \
+    \
+    # Modify installer
+    ##################
+    # Avoid rebooting at end of installation
+    sed -i "/reboot/d" /newinstaller.sh && \
+    # Use apt-get as without user action
+    sed -i "s|apt |apt-get |g" /newinstaller.sh && \
+    # Ensure chmod
+    sed -i "/git clone/a chown -R 1000:1000 $HOME" /newinstaller.sh && \
+    # Remove all instances of sudo from the newinstaller
+    #sed -i -e "s|== 0|== 7|g" -e "s|sudo -n true|true|g" -e "s|sudo -K|true|g" /newinstaller.sh && \
+    \
+    # Execute installer
+    sudo -u pi /./newinstaller.sh && \
+    \
+    # Adapt for lsio usage of /app
+    if [ -d /app ]; then rm -r /app; fi && \
+    ln -s /home/pi /app && \
+    chown -R 1000:1000 /home/pi /app
+
+##################
+# 2 Modify Image #
+##################
+
+# Set S6 wait time
+ENV S6_CMD_WAIT_FOR_SERVICES=1 \
+    S6_CMD_WAIT_FOR_SERVICES_MAXTIME=0 \
+    S6_SERVICES_GRACETIME=0
+
+##################
+# 3 Install apps #
+##################
+
+# Add rootfs
+COPY rootfs/ /
+
+# Uses /bin for compatibility purposes
+# hadolint ignore=DL4005
+RUN if [ ! -f /bin/sh ] && [ -f /usr/bin/sh ]; then ln -s /usr/bin/sh /bin/sh; fi && \
+    if [ ! -f /bin/bash ] && [ -f /usr/bin/bash ]; then ln -s /usr/bin/bash /bin/bash; fi
+
+# Modules
+ARG MODULES="00-local_mounts.sh 00-smb_mounts.sh"
+
+# Automatic modules download
+ADD "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/ha_automodules.sh" "/ha_automodules.sh"
+RUN chmod 744 /ha_automodules.sh && /ha_automodules.sh "$MODULES" && rm /ha_automodules.sh
+
+# Manual apps
+ENV PACKAGES="alsa-utils libasound2-plugins"
+
+# Automatic apps & bashio
+ADD "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/ha_autoapps.sh" "/ha_autoapps.sh"
+RUN chmod 744 /ha_autoapps.sh && /ha_autoapps.sh "$PACKAGES" && rm /ha_autoapps.sh
+
+################
+# 4 Entrypoint #
+################
+
+# Add entrypoint
+ENV S6_STAGE2_HOOK=/ha_entrypoint.sh
+ADD "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/ha_entrypoint.sh" "/ha_entrypoint.sh"
+
+# Entrypoint modifications
+ADD "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.templates/ha_entrypoint_modif.sh" "/ha_entrypoint_modif.sh"
+RUN chmod 777 /ha_entrypoint.sh /ha_entrypoint_modif.sh && /ha_entrypoint_modif.sh && rm /ha_entrypoint_modif.sh
+
+# Avoid config.yaml interference
+WORKDIR /config
+#ENTRYPOINT ["/lib/systemd/systemd"]
+#ENTRYPOINT [ "/usr/bin/env" ]
+#CMD [ "/ha_entrypoint.sh" ]
+#SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+
+############
+# 5 Labels #
+############
+
+ARG BUILD_ARCH
+ARG BUILD_DATE
+ARG BUILD_DESCRIPTION
+ARG BUILD_NAME
+ARG BUILD_REF
+ARG BUILD_REPOSITORY
+ARG BUILD_VERSION
+LABEL \
+    io.hass.name="${BUILD_NAME}" \
+    io.hass.description="${BUILD_DESCRIPTION}" \
+    io.hass.arch="${BUILD_ARCH}" \
+    io.hass.type="addon" \
+    io.hass.version=${BUILD_VERSION} \
+    maintainer="alexbelgium (https://github.com/alexbelgium)" \
+    org.opencontainers.image.title="${BUILD_NAME}" \
+    org.opencontainers.image.description="${BUILD_DESCRIPTION}" \
+    org.opencontainers.image.vendor="Home Assistant Add-ons" \
+    org.opencontainers.image.authors="alexbelgium (https://github.com/alexbelgium)" \
+    org.opencontainers.image.licenses="MIT" \
+    org.opencontainers.image.url="https://github.com/alexbelgium" \
+    org.opencontainers.image.source="https://github.com/${BUILD_REPOSITORY}" \
+    org.opencontainers.image.documentation="https://github.com/${BUILD_REPOSITORY}/blob/main/README.md" \
+    org.opencontainers.image.created=${BUILD_DATE} \
+    org.opencontainers.image.revision=${BUILD_REF} \
+    org.opencontainers.image.version=${BUILD_VERSION}
+
+#################
+# 6 Healthcheck #
+#################
+
+ENV HEALTH_PORT="80" \
+    HEALTH_URL=""
+HEALTHCHECK \
+    --interval=5s \
+    --retries=5 \
+    --start-period=30s \
+    --timeout=25s \
+    CMD curl --fail "http://127.0.0.1:${HEALTH_PORT}${HEALTH_URL}" &>/dev/null || exit 1

birdnet-pi/README.md

@@ -0,0 +1,81 @@
+# Home assistant add-on: birdnet-pi
+
+[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
+
+![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fbirdnet-pi%2Fconfig.json)
+![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fbirdnet-pi%2Fconfig.json)
+![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fbirdnet-pi%2Fconfig.json)
+
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
+[![GitHub Super-Linter](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/weekly-supelinter.yaml?label=Lint%20code%20base)](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
+[![Builder](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/onpush_builder.yaml?label=Builder)](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
+
+[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
+
+_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
+
+[![Stargazers repo roster for @alexbelgium/hassio-addons](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.github/stars2.svg)](https://github.com/alexbelgium/hassio-addons/stargazers)
+
+![downloads evolution](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/birdnet-pi/stats.png)
+
+## About
+
+---
+
+[birdnet-pi](https://github.com/tphakala/birdnet-pi/tree/main) is an AI solution for continuous avian monitoring and identification developed by @tphakala
+
+This addon is based on their docker image.
+
+## Configuration
+
+Install, then start the addon a first time
+Webui can be found at <http://homeassistant:8080>.
+
+You'll need a microphone : either use one connected to HA or the audio stream of a rstp camera.
+
+Options can be configured through three ways :
+
+- Addon options
+
+```yaml
+ALSA_CARD : number of the card (0 or 1 usually), see https://github.com/tphakala/birdnet-pi/blob/main/doc/installation.md#deciding-alsa_card-value
+TZ: Etc/UTC specify a timezone to use, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
+COMMAND : realtime --rtsp url # allows to provide arguments to birdnet-pi
+```
+
+- Config.yaml
+Additional variables can be configured using the config.yaml file found in /config/db21ed7f_birdnet-pi/config.yaml using the Filebrowser addon
+
+- Config_env.yaml
+Additional environment variables can be configured there
+
+## Installation
+
+---
+
+The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
+
+1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
+   [![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
+1. Install this add-on.
+1. Click the `Save` button to store your configuration.
+1. Set the add-on options to your preferences
+1. Start the add-on.
+1. Check the logs of the add-on to see if everything went well.
+1. Open the webUI and adapt the software options
+
+## Integration with HA
+
+Not yet available
+
+## Common issues
+
+Not yet available
+
+## Support
+
+Create an issue on github
+
+---
+
+![illustration](https://raw.githubusercontent.com/tphakala/birdnet-pi/main/doc/birdnet-pi-dashboard.webp)

birdnet-pi/apparmor.txt

@@ -0,0 +1,66 @@
+#include <tunables/global>
+
+profile birdnet-pi_addon flags=(attach_disconnected,mediate_deleted) {
+  #include <abstractions/base>
+
+  capability,
+  file,
+  signal,
+  mount,
+  umount,
+  remount,
+  network udp,
+  network tcp,
+  network dgram,
+  network stream,
+  network inet,
+  network inet6,
+  network netlink raw,
+  network unix dgram,
+
+  capability setgid,
+  capability setuid,
+  capability sys_admin,
+  capability dac_read_search,
+  # capability dac_override,
+  # capability sys_rawio,
+
+# S6-Overlay
+  /init ix,
+  /run/{s6,s6-rc*,service}/** ix,
+  /package/** ix,
+  /command/** ix,
+  /run/{,**} rwk,
+  /dev/tty rw,
+  /bin/** ix,
+  /usr/bin/** ix,
+  /usr/lib/bashio/** ix,
+  /etc/s6/** rix,
+  /run/s6/** rix,
+  /etc/services.d/** rwix,
+  /etc/cont-init.d/** rwix,
+  /etc/cont-finish.d/** rwix,
+  /init rix,
+  /var/run/** mrwkl,
+  /var/run/ mrwkl,
+  /dev/i2c-1 mrwkl,
+  # Files required
+  /dev/fuse mrwkl,
+  /dev/sda1 mrwkl,
+  /dev/sdb1 mrwkl,
+  /dev/nvme0 mrwkl,
+  /dev/nvme1 mrwkl,
+  /dev/mmcblk0p1 mrwkl,
+  /dev/* mrwkl,
+  /tmp/** mrkwl,
+
+  # Data access
+  /data/** rw,
+
+  # suppress ptrace denials when using 'docker ps' or using 'ps' inside a container
+  ptrace (trace,read) peer=docker-default,
+
+  # docker daemon confinement requires explict allow rule for signal
+  signal (receive) set=(kill,term) peer=/usr/bin/docker,
+
+}

birdnet-pi/build.yaml

@@ -0,0 +1,6 @@
+---
+build_from:
+  aarch64: ghcr.io/linuxserver/baseimage-debian:arm64v8-bookworm
+  amd64: ghcr.io/linuxserver/baseimage-debian:amd64-bookworm
+codenotary:
+  signer: alexandrep.github@gmail.com

birdnet-pi/config.json

@@ -59,8 +59,6 @@
     "/dev/nvme2"
   ],
   "description": "realtime acoustic bird classification system",
-  "environment": {
-  },
   "image": "ghcr.io/alexbelgium/birdnet-pi-{arch}",
   "init": false,
   "map": [
@@ -69,7 +67,6 @@
     "share:rw"
   ],
   "name": "BirdNET-pi",
-  "panel_icon": "mdi:bird",
   "ports": {
     "80/tcp": 80
   },
@@ -94,7 +91,7 @@
   "slug": "birdnet-pi",
   "url": "https://github.com/alexbelgium/hassio-addons/tree/master/birdnet-pi",
   "usb": true,
-  "version": "1.4",
+  "version": "0.13",
   "video": true,
-  "webui": "[PROTO:ssl]://[HOST]:[PORT:80]"
+  "webui": "http://[HOST]:[PORT:80]"
 }

birdnet-pi/rootfs/Caddyfile

@@ -0,0 +1,22 @@
+%%interface%%:%%port%% {
+    reverse_proxy http://localhost:8080 {
+        header_up Host {host}
+        header_up X-Forwarded-For {remote}
+        header_up Connection "upgrade"
+        header_up Accept-Encoding ""
+        @base_url {
+            path /
+            file {
+                try_files {path} /%%ingress_entry%%
+            }
+        }
+        handle @base_url {
+            sub_filter_once off
+            sub_filter_types *
+            sub_filter href=\"/ href=\"%%ingress_entry%%/
+            sub_filter src=\"/ src=\"%%ingress_entry%%/
+            sub_filter hx-get=\"/ hx-get=\"%%ingress_entry%%/
+            sub_filter action=\"/ action=\"%%ingress_entry%%/
+        }
+    }
+}

birdnet-pi/rootfs/custom-services.d/00_php_pfm

@@ -0,0 +1,9 @@
+#!/usr/bin/with-contenv bash
+# shellcheck shell=bash
+
+# Waiting for dbus
+until [[ -e /var/run/dbus/system_bus_socket ]]; do
+    sleep 1s
+done
+echo "Starting service: php pfm"
+exec /usr/sbin/php-fpm* -F

birdnet-pi/rootfs/custom-services.d/01_avahi

@@ -0,0 +1,9 @@
+#!/usr/bin/with-contenv bashio
+# Waiting for dbus
+until [[ -e /var/run/dbus/system_bus_socket ]]; do
+    sleep 1s
+done
+
+echo "Starting service: avahi daemon"
+exec \
+    avahi-daemon --no-chroot

birdnet-pi/rootfs/custom-services.d/02_caddy

@@ -0,0 +1,14 @@
+#!/usr/bin/with-contenv bashio
+# Dependencies
+sockfile="empty"
+until [[ -e /var/run/dbus/system_bus_socket ]] && [[ -e "$sockfile" ]]; do
+    sleep 1s
+    sockfile="$(find /run/php -name *.sock)"
+done
+
+# Correct fpm.sock
+chown caddy:caddy /run/php/php*-fpm.sock
+sed -i "s|/run/php/php-fpm.sock|$sockfile|g" /etc/caddy/Caddyfile
+
+echo "Starting service: caddy"
+/usr/bin/caddy run --config /etc/caddy/Caddyfile

birdnet-pi/rootfs/custom-services.d/99_avahi-alias

@@ -0,0 +1,8 @@
+#!/usr/bin/with-contenv bashio
+echo "Starting service: avahi alias"
+until [[ -e /start ]]; do
+    sleep 1s
+done
+
+exec \
+    s6-setuidgid "$USER" /usr/bin/avahi-publish -a -R %I "$(hostname)"

birdnet-pi/rootfs/etc/cont-init.d/99-run.sh

@@ -0,0 +1,28 @@
+#!/command/with-contenv bashio
+# shellcheck shell=bash
+set -e
+
+#################
+# INITALISATION #
+#################
+
+# Correcting systemctl
+curl -f -L -s -S https://raw.githubusercontent.com/gdraheim/docker-systemctl-replacement/master/files/docker/systemctl3.py -o /bin/systemctl
+chmod a+x /bin/systemctl
+
+# Starting dbus
+bashio::log.info "Starting system services..."
+echo "... dbus"
+service dbus start
+
+# Restarting all services
+bashio::log.info "Ensuring birdnet.conf is in /config ; please customize as needed"
+if [ ! -f /config/birdnet.conf ]; then
+  cp /etc/birdnet/birdnet.conf /config
+fi
+
+bashio::log.info "Starting BirdNET-Pi services"
+chmod +x "$HOME"/BirdNET-Pi/scripts/restart_services.sh
+/."$HOME"/BirdNET-Pi/scripts/restart_services.sh &>/proc/1/fd/1
+
+bashio::log.info "App is accessible from webui"

zzz_draft_birdnet-pi/CHANGELOG.md

@@ -1,2 +0,0 @@
-## 1.4 (27-04-2024)
-- Initial build