initial version

firefly_iii/CHANGELOG.md

@@ -0,0 +1 @@
+- Initial release

firefly_iii/Dockerfile

@@ -0,0 +1,80 @@
+#==========================#
+# ALEXBELGIUM'S DOCKERFILE #
+#==========================#
+#           _.------.
+#       _.-`    ('>.-`"""-.
+# '.--'`       _'`   _ .--.)
+#    -'         '-.-';`   `
+#    ' -      _.'  ``'--. 
+#        '---`    .-'""`
+#               /`
+
+#################
+# 1 Build Image #
+#################
+
+ARG BUILD_FROM
+ARG BUILD_VERSION
+FROM ${BUILD_FROM}
+
+##################
+# 2 Modify Image #
+##################
+
+ENV DB_CONNECTION=sqlite
+
+##################
+# 3 Install apps #
+##################
+
+# Copy local files
+COPY rootfs/ /
+
+# Manual apps
+ENV PACKAGES=""
+
+# Automatic apps & bashio
+RUN if ! command -v bash >/dev/null 2>/dev/null; then (apt-get update && apt-get install -yqq --no-install-recommends bash || apk add --no-cache bash); fi && \
+    if ! command -v curl >/dev/null 2>/dev/null; then (apt-get update && apt-get install -yqq --no-install-recommends curl || apk add --no-cache curl); fi && \
+    curl -L -f -s "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/zzz_templates/automatic_packages.sh" --output /automatic_packages.sh && \
+    chmod 777 /automatic_packages.sh && \
+    /automatic_packages.sh "${PACKAGES:-}" && \
+    rm /automatic_packages.sh || printf '%s\n' "${PACKAGES:-}" > /ENVFILE
+
+################
+# 4 Entrypoint #
+################
+
+RUN chmod 777 /entrypoint.sh
+ENTRYPOINT [ "/usr/bin/env" ]
+CMD [ "/entrypoint.sh" ] 
+
+############
+# 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}

firefly_iii/Readme.md

@@ -0,0 +1,68 @@
+# Home assistant add-on: fireflyiii
+
+[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
+
+[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
+
+![Supports 
+ Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield]
+![Supports smb mounts][smb-shield]
+
+_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://reporoster.com/stars/alexbelgium/hassio-addons)](https://github.com/alexbelgium/hassio-addons/stargazers)
+
+## About
+
+[fireflyiii](https://www.firefly-iii.org) a personal finances manager.
+This addon is based on the docker image https://hub.docker.com/r/fireflyiii/core
+
+## 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
+
+## Configuration
+
+Options can be configured through two ways :
+
+- Addon options
+
+```yaml
+"CONFIG_LOCATION": location of the config.yaml file that allows setting additional environment variables (see below)
+"DB_CONNECTION": "list(sqlite_internal|mariadb_addon|mysql|pgsql)" # Defines if you are using the built in sqlite ; the mariadb addon ; or a remote database
+"DB_HOST": "CHANGEME" # only needed if using a remote database
+"DB_PORT": "CHANGEME" # only needed if using a remote database
+"DB_DATABASE": "CHANGEME" # only needed if using a remote database
+"DB_USERNAME": "CHANGEME" # only needed if using a remote database
+"DB_PASSWORD": "CHANGEME" # only needed if using a remote database
+```
+
+- Config.yaml
+
+Configuration is done by customizing the config.yaml in the location defined in your addon options
+
+The complete list of options can be seen here : https://raw.githubusercontent.com/firefly-iii/firefly-iii/main/.env.example
+
+## Support
+
+Create an issue on github
+
+## Illustration
+
+![illustration](https://raw.githubusercontent.com/firefly-iii/firefly-iii/develop/.github/assets/img/imac-complete.png)
+
+[repository]: https://github.com/alexbelgium/hassio-addons
+[smb-shield]: https://img.shields.io/badge/smb-yes-green.svg
+[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
+[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
+[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
+[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg

firefly_iii/apparmor.txt

@@ -0,0 +1,48 @@
+#include <tunables/global>
+
+profile fireflyiii_addon flags=(attach_disconnected,mediate_deleted) {
+  #include <abstractions/base>
+  
+  capability,
+  file,
+  mount,
+  umount,
+  remount,
+
+  capability setgid,
+  capability setuid,
+  capability sys_admin, 
+  capability dac_read_search, 
+  # capability dac_override,
+  # capability sys_rawio,
+
+# S6-Overlay
+  /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/sda1 mrwkl,
+  /dev/sdb1 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,
+
+} 

firefly_iii/build.json

@@ -0,0 +1,8 @@
+{
+  "build_from": {
+    "armhf": "fireflyiii/core:latest",
+    "armv7": "fireflyiii/core:latest",
+    "aarch64": "fireflyiii/core:latest",
+    "amd64": "fireflyiii/core:latest"
+  }
+}

firefly_iii/config.json

@@ -0,0 +1,37 @@
+{
+  "apparmor": true,
+  "arch": ["aarch64", "amd64", "armv7", "armhf"],
+  "boot": "auto",
+  "description": "A free and open source personal finance manager",
+  "devices": [],
+  "environment": {
+    "TRUSTED_PROXIES": "**"
+  },
+  "map": ["config:rw", "share:rw", "ssl"],
+  "name": "fireflyiii",
+  "options": {
+    "DB_CONNECTION": "sqlite",
+    "CONFIG_LOCATION": "/config/addons_config/fireflyiii/config.yaml"
+  },
+  "ports": {
+    "80/tcp": 3473
+  },
+  "ports_description": {
+    "80/tcp": "web interface"
+  },
+  "schema": {
+    "CONFIG_LOCATION": "str",
+    "DB_CONNECTION": "list(sqlite|mariadb_addon|remotedb)",
+    "DB_HOST": "str?",
+    "DB_PORT": "str?",
+    "DB_DATABASE": "str?",
+    "DB_USERNAME": "str?",
+    "DB_PASSWORD": "str?"
+  },
+  "slug": "fireflyiii",
+  "services": ["mysql:want"],
+  "upstream": "5.6.7",
+  "url": "https://github.com/alexbelgium/hassio-addons",
+  "version": "5.6.7",
+  "webui": "[PROTO:ssl]://[HOST]:[PORT:80]"
+}

firefly_iii/rootfs/entrypoint.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+echo "Starting..."
+
+####################
+# Starting scripts #
+####################
+
+for SCRIPTS in /scripts/*; do
+  [ -e "$SCRIPTS" ] || continue
+  echo "$SCRIPTS: executing"
+  chown $(id -u):$(id -g) $SCRIPTS
+  chmod a+x $SCRIPTS
+  sed -i 's|/usr/bin/with-contenv bashio|/usr/bin/env bashio|g' $SCRIPTS || true
+  /./$SCRIPTS || echo "$SCRIPTS: exiting $?"
+done

firefly_iii/rootfs/scripts/00-aaa_dockerfile_backup.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+# If dockerfile failed install manually
+if [ -e "/ENVFILE" ]; then
+    echo "Executing script"
+    PACKAGES=$(</ENVFILE)
+    (
+        #######################
+        # Automatic installer #
+        #######################
+        if ! command -v bash >/dev/null 2>/dev/null; then (apt-get update && apt-get install -yqq --no-install-recommends bash || apk add --no-cache bash); fi &&
+            if ! command -v curl >/dev/null 2>/dev/null; then (apt-get update && apt-get install -yqq --no-install-recommends curl || apk add --no-cache curl); fi &&
+            curl -L -f -s "https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/zzz_templates/automatic_packages.sh" --output /automatic_packages.sh &&
+            chmod 777 /automatic_packages.sh &&
+            eval /./automatic_packages.sh "$PACKAGES" &&
+            rm /automatic_packages.sh
+    ) >/dev/null
+
+fi

firefly_iii/rootfs/scripts/00-banner.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/with-contenv bashio
+# ==============================================================================
+# Displays a simple add-on banner on startup
+# ==============================================================================
+
+if bashio::supervisor.ping; then
+    bashio::log.blue \
+    '-----------------------------------------------------------'
+    bashio::log.blue " Add-on: $(bashio::addon.name)"
+    bashio::log.blue " $(bashio::addon.description)"
+    bashio::log.blue \
+    '-----------------------------------------------------------'
+
+    bashio::log.blue " Add-on version: $(bashio::addon.version)"
+    if bashio::var.true "$(bashio::addon.update_available)"; then
+        bashio::log.magenta ' There is an update available for this add-on!'
+        bashio::log.magenta \
+        " Latest add-on version: $(bashio::addon.version_latest)"
+        bashio::log.magenta ' Please consider upgrading as soon as possible.'
+    else
+        bashio::log.green ' You are running the latest version of this add-on.'
+    fi
+
+    bashio::log.blue " System: $(bashio::info.operating_system)" \
+    " ($(bashio::info.arch) / $(bashio::info.machine))"
+    bashio::log.blue " Home Assistant Core: $(bashio::info.homeassistant)"
+    bashio::log.blue " Home Assistant Supervisor: $(bashio::info.supervisor)"
+
+    bashio::log.blue \
+    '-----------------------------------------------------------'
+    bashio::log.blue \
+    ' Please, share the above information when looking for help'
+    bashio::log.blue \
+    ' or support in, e.g., GitHub, forums'
+    bashio::log.green \
+    ' https://github.com/alexbelgium/hassio-addons'
+    bashio::log.blue \
+    '-----------------------------------------------------------'
+fi

firefly_iii/rootfs/scripts/00-global_var.sh

@@ -0,0 +1,33 @@
+#!/usr/bin/with-contenv bashio
+
+###################################
+# Export all addon options as env #
+###################################
+
+# For all keys in options.json
+JSONSOURCE="/data/options.json"
+
+# Export keys as env variables
+# echo "All addon options were exported as variables"
+mapfile -t arr < <(jq -r 'keys[]' ${JSONSOURCE})
+for KEYS in ${arr[@]}; do
+  # export key
+  VALUE=$(jq .$KEYS ${JSONSOURCE})
+  line="${KEYS}=${VALUE//[\"\']/}"
+  # Use locally
+  if ! bashio::config.false "verbose"; then bashio::log.blue "$line"; fi
+  export $line
+  # Export the variable to run scripts
+  line="${KEYS}=${VALUE//[\"\']/} &>/dev/null"
+  sed -i "1a export $line" /etc/services.d/*/*run* 2>/dev/null || sed -i "1a export $line" /scripts/*run*
+done
+
+################
+# Set timezone #
+################
+if [ ! -z "TZ" ] && [ -f /etc/localtime ]; then
+  if [ -f /usr/share/zoneinfo/$TZ ]; then
+    echo "Timezone set from $(cat /etc/timezone) to $TZ"
+    ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ >/etc/timezone
+  fi
+fi

firefly_iii/rootfs/scripts/20-folders.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bashio
+
+echo "Connecting database to /config/addons_config/firefly_iii"
+
+# Create directory
+mkdir -p /config/addons_config/firefly_iii
+
+# Make sure permissions are right
+chown $(id -u):$(id -g) /config/addons_config/firefly_iii
+
+# Make symlink
+ln -snf /var/www/html/storage /config/addons_config/firefly_iii

firefly_iii/rootfs/scripts/92-config_yaml.sh

@@ -0,0 +1,102 @@
+#!/usr/bin/with-contenv bashio
+
+##################
+# INITIALIZATION #
+##################
+
+# Where is the config
+CONFIGSOURCE=$(bashio::config "CONFIG_LOCATION")
+
+# Check if config file is there, or create one from template
+if [ -f $CONFIGSOURCE ]; then
+    echo "Using config file found in $CONFIGSOURCE"
+else
+    echo "No config file, creating one from template"
+    # Create folder
+    mkdir -p "$(dirname "${CONFIGSOURCE}")"
+    # Placing template in config
+    if [ -f /templates/config.yaml ]; then
+        # Use available template
+        cp /templates/config.yaml "$(dirname "${CONFIGSOURCE}")"
+    else
+        # Download template
+        TEMPLATESOURCE="https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/zzz_templates/config.template"
+        curl -L -f -s $TEMPLATESOURCE --output $CONFIGSOURCE
+    fi
+    # Need to restart
+    bashio::log.fatal "Config file not found, creating a new one. Please customize the file in $CONFIGSOURCE before restarting."
+    # bashio::exit.nok
+fi
+
+# Check if yaml is valid
+EXIT_CODE=0
+yamllint -d relaxed --no-warnings $CONFIGSOURCE &>ERROR || EXIT_CODE=$?
+if [ $EXIT_CODE = 0 ]; then
+    echo "Config file is a valid yaml"
+else
+    cat ERROR
+    bashio::log.fatal "Config file has an invalid yaml format. Please check the file in $CONFIGSOURCE. Errors list above."
+    # bashio::exit.nok
+fi
+
+# Export all yaml entries as env variables
+# Helper function
+function parse_yaml {
+    local prefix=$2 || local prefix=""
+    local s='[[:space:]]*' w='[a-zA-Z0-9_]*' fs=$(echo @ | tr @ '\034')
+    sed -ne "s|^\($s\):|\1|" \
+        -e "s| #.*$||g" \
+        -e "s|#.*$||g" \
+        -e "s|^\($s\)\($w\)$s:$s[\"']\(.*\)[\"']$s\$|\1$fs\2$fs\3|p" \
+        -e "s|^\($s\)\($w\)$s:$s\(.*\)$s\$|\1$fs\2$fs\3|p" $1 |
+        awk -F$fs '{
+      indent = length($1)/2;
+      vname[indent] = $2;
+      for (i in vname) {if (i > indent) {delete vname[i]}}
+      if (length($3) > 0) {
+         vn=""; for (i=0; i<indent; i++) {vn=(vn)(vname[i])("_")}
+         printf("%s%s%s=\"%s\"\n", "'$prefix'",vn, $2, $3);
+      }
+     }'
+}
+
+# Get variables and export
+bashio::log.info "Starting the app with the variables in in $CONFIGSOURCE"
+# Get list of parameters in a file
+parse_yaml "$CONFIGSOURCE" "" >/tmpfile
+while IFS= read -r line; do
+    # Clean output
+    line=${line//[\"\']/}
+    # Check if secret
+    if [[ "${line}" == *'!secret '* ]]; then
+        echo "secret detected"
+        secret=${line#*secret }
+        # Check if single match
+        secretnum=$(sed -n "/$secret:/=" /config/secrets.yaml)
+        [[ $(echo $secretnum) == *' '* ]] && bashio::exit.nok "There are multiple matches for your password name. Please check your secrets.yaml file"
+        # Get text
+        secret=$(sed -n "/$secret:/p" /config/secrets.yaml)
+        secret=${secret#*: }
+        line="${line%%=*}=$secret"
+    fi
+    # Data validation
+    if [[ $line =~ ^.+[=].+$ ]]; then
+        export $line
+        # Export the variable
+        sed -i "1a export $line" /etc/services.d/*/*run* 2>/dev/null || true
+        sed -i "1a export $line" /scripts/*run* 2>/dev/null || true
+        # Show in log
+        if ! bashio::config.false "verbose";then bashio::log.blue "$line"; fi
+    else
+        bashio::exit.nok "$line does not follow the correct structure. Please check your yaml file."
+    fi
+done <"/tmpfile"
+
+# Test mode
+TZ=$(bashio::config "TZ")
+if [ $TZ = "test" ]; then
+    echo "secret mode found, launching script in /config/test.sh"
+    cd /config
+    chmod 777 test.sh
+    ./test.sh
+fi

firefly_iii/rootfs/scripts/99-run.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bashio
+
+bashio::log.info "Launching app"
+
+# Create API key if needed
+if ! bashio::fs.file_exists "/data/firefly/appkey.txt"; then
+    #Command fails without appkey set, this won't be used again
+    export APP_KEY=SomeRandomStringOf32CharsExactly
+    bashio::log.info "Generating app key"
+    key=$(php /var/www/firefly/artisan key:generate --show)
+    echo "${key}" >/data/firefly/appkey.txt
+    bashio::log.info "App Key generated: ${key}"
+fi
+
+# Define database
+case $(bashio::config 'DB_CONNECTION') in
+
+# Use sqlite
+sqlite_internal)
+    bashio::log.info "Using built in sqlite"
+    touch ./storage/database/database.sqlite
+    php artisan migrate --seed
+    php artisan firefly-iii:upgrade-database
+    ;;
+
+# Use MariaDB
+mariadb_addon)
+    bashio::log.info "Using MariaDB addon. Requirements : running MariaDB addon"
+    if ! bashio::services.available 'mysql'; then
+        bashio::log.fatal \
+        "Local database access should be provided by the MariaDB addon"
+        bashio::exit.nok \
+        "Please ensure it is installed and started"
+    fi
+
+    host=$(bashio::services "mysql" "host")
+    password=$(bashio::services "mysql" "password")
+    port=$(bashio::services "mysql" "port")
+    username=$(bashio::services "mysql" "username")
+
+    bashio::log.warning "Firefly-iii is using the Maria DB addon"
+    bashio::log.warning "Please ensure this is included in your backups"
+    bashio::log.warning "Uninstalling the MariaDB addon will remove any data"
+
+    bashio::log.info "Creating database for Firefly-iii if required"
+    mysql \
+    -u "${username}" -p"${password}" \
+    -h "${host}" -P "${port}" \
+    -e "CREATE DATABASE IF NOT EXISTS \`firefly\` ;"
+    ;;
+
+# Use remote
+*)
+    bashio::log.info "Using remote database. Requirement : filling all addon options fields"
+    for conditions in "DB_HOST" "DB_PORT" "DB_DATABASE" "DB_USERNAME" "DB_PASSWORD"; do
+        if ! bashio::config.has_value "$conditions"; then
+            bashio::exit.nok "Remote database has been specified but $conditions is not defined in addon options"
+        fi
+    done
+    ;;
+
+esac
+
+##############
+# LAUNCH APP #
+##############
+
+/./usr/local/bin/entrypoint.sh