Rename

paperless_ng/CHANGELOG.md

@@ -0,0 +1 @@
+- Initial build

paperless_ng/Dockerfile

@@ -0,0 +1,66 @@
+ARG BUILD_FROM
+ARG BUILD_VERSION
+FROM ${BUILD_FROM}
+
+# Set shell
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+ARG BASHIO_VERSION=0.13.1
+ENV PAPERLESS_DATA_DIR=/config/paperless_ng 
+
+RUN apt-get update \
+    \
+    && apt-get clean && \
+                    apt-get update && \
+                    apt-get install -y --no-install-recommends \
+                jq \
+                curl \
+                cifs-utils \
+                keyutils \
+                smbclient \
+                samba \
+    \
+    ##################
+    # Install bashio #
+    ##################
+    && mkdir -p /tmp/bashio \
+    && curl -L -f -s "https://github.com/hassio-addons/bashio/archive/v${BASHIO_VERSION}.tar.gz" \
+    | tar -xzf - --strip 1 -C /tmp/bashio \
+    && mv /tmp/bashio/lib /usr/lib/bashio \
+    && ln -s /usr/lib/bashio/bashio /usr/bin/bashio \
+    && rm -rf /tmp/bashio \
+    \
+    #################
+    # Correct image #
+    #################
+    && sed -i "s|/config|$PAPERLESS_DATA_DIR|g" /etc/cont-init.d/* \
+    || true
+
+# copy local files
+COPY rootfs/ /
+
+### 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}

paperless_ng/apparmor.txt

@@ -0,0 +1,49 @@
+#include <tunables/global>
+
+profile addon_db21ed7f_paperless_ng 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/ttyUSB0 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,
+
+} 

paperless_ng/build.json

@@ -0,0 +1,8 @@
+{
+  "build_from": {
+    "armv7": "linuxserver/paperless-ng:arm32v7-latest",
+    "armhf": "linuxserver/paperless-ng:arm32v7-latest",
+    "aarch64": "linuxserver/paperless-ng:arm64v8-latest",
+    "amd64": "linuxserver/paperless-ng:amd64-latest"
+  }
+} 

paperless_ng/config.json

@@ -0,0 +1,69 @@
+{
+  "apparmor": true,
+  "arch": [
+    "aarch64",
+    "amd64",
+    "armv7",
+    "armhf"
+  ],
+  "boot": "auto",
+  "description": "indexes your scanned documents and allows you to easily search for documents and store metadata",
+  "devices": [
+    "/dev/sda1",
+    "/dev/sdb1",
+    "/dev/sdc1",
+    "/dev/sdd1",
+    "/dev/sde1",
+    "/dev/sdf1",
+    "/dev/sdg1",
+    "/dev/sda2",
+    "/dev/sdb2",
+    "/dev/sdc2",
+    "/dev/sdd2",
+    "/dev/sde2",
+    "/dev/sdf2",
+    "/dev/sdg2"
+  ],
+  "environment": {
+    "PUID": "0",
+    "PGID": "0"
+  },
+  "map": [
+    "config:rw",
+    "share:rw",
+    "media:rw",
+    "config:rw"
+  ],
+  "name": "Paperless NG",
+  "options": {
+    "PUID": 0,
+    "PGID": 0,
+    "networkdisks": "<//SERVER/SHARE>,<//SERVER2/SHARE2>",
+    "cifsusername": "<username>",
+    "cifspassword": "<password>"
+  },
+  "ports": {
+    "8000/tcp": 8011
+  },
+  "ports_description": {
+    "8000/tcp": "web interface"
+  },
+  "privileged": [
+    "SYS_ADMIN",
+    "DAC_READ_SEARCH"
+  ],
+  "schema": {
+    "PUID": "int",
+    "PGID": "int",
+    "TZ": "str?",
+    "localdisks": "str?",
+    "networkdisks": "str?",
+    "cifsusername": "str?",
+    "cifspassword": "str?"
+  },
+  "slug": "paperless_ng",
+  "upstream": "1.5",
+  "url": "https://github.com/alexbelgium/hassio-addons",
+  "version": "1.5",
+  "webui": "http://[HOST]:[PORT:8000]"
+} 

paperless_ng/rootfs/00-aaa_dockerfile_backup.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+# If dockerfile failed install manually
+if [ ! -f "/usr/bin/bashio" ]; then
+    echo "Bashio does not exist, executing script"
+    (
+        ################
+        # Install apps #
+        ################
+        
+                apt-get clean &&
+                    apt-get update &&
+                    apt-get install -y --no-install-recommends \
+                jq \
+                curl \
+                cifs-utils \
+                keyutils \
+                smbclient \
+                samba
+           
+
+        ###################
+        # Install bashio #
+        ##################
+        BASHIO_VERSION=0.13.1
+        mkdir -p /tmp/bashio
+        curl -L -f -s "https://github.com/hassio-addons/bashio/archive/v${BASHIO_VERSION}.tar.gz" |
+            tar -xzf - --strip 1 -C /tmp/bashio
+        mv /tmp/bashio/lib /usr/lib/bashio
+        ln -s /usr/lib/bashio/bashio /usr/bin/bashio
+        rm -rf /tmp/bashio
+    ) >/dev/null
+
+fi

paperless_ng/rootfs/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

paperless_ng/rootfs/92-local_mounts.sh

@@ -0,0 +1,32 @@
+#!/usr/bin/with-contenv bashio
+
+######################
+# MOUNT LOCAL SHARES #
+######################
+
+# Mount local Share if configured
+if bashio::config.has_value 'localdisks'; then
+
+  MOREDISKS=$(bashio::config 'localdisks')
+  echo "Local Disks mounting..."
+
+  # Separate comma separated values
+  for disk in ${MOREDISKS//,/ }; do
+
+    # Mount by device as default
+    devpath=/dev
+
+    # Mount as label
+    [ ${disk:0:2} != "sd" ] && devpath=/dev/disk/by-label
+
+    # Creates dir
+    mkdir -p /mnt/$disk
+    chown -R $(id -u):$(id -g) /mnt/$disk
+    # Legacy mounting : mount to share if still exists (avoid breaking changes)
+    [ -d /share/$disk ] && mount $devpath/$disk /share/$disk || true
+    # Mount
+    mount $devpath/$disk /mnt/$disk && bashio::log.info "Success! $disk mounted to /mnt/$disk" || (bashio::log.fatal "Unable to mount local drives! Please check the name." && rmdir /mnt/$disk)
+
+  done
+
+fi

paperless_ng/rootfs/92-smb_mounts.sh

@@ -0,0 +1,83 @@
+#!/usr/bin/with-contenv bashio
+
+#########################
+# MOUNT SMB SHARES v1.6 #
+#########################
+if bashio::config.has_value 'networkdisks'; then
+
+  # Define variables
+  MOREDISKS=$(bashio::config 'networkdisks')
+  CIFS_USERNAME=$(bashio::config 'cifsusername')
+  CIFS_PASSWORD=$(bashio::config 'cifspassword')
+  MOUNTED=false
+  SMBVERS=""
+  SECVERS=""
+
+  # Mount CIFS Share if configured and if Protection Mode is active
+  echo 'Mounting smb share(s)...'
+
+  if bashio::config.has_value 'cifsdomain'; then
+    DOMAIN=",domain=$(bashio::config 'cifsdomain')"
+  else
+    DOMAIN=""
+  fi
+
+  # Mounting disks
+  for disk in ${MOREDISKS//,/ }; do # Separate comma separated values
+
+    # Clean name of network share
+    disk=$(echo $disk | sed "s,/$,,") # Remove / at end of name
+    diskname=${disk//\\//}            #replace \ with /
+    diskname=${diskname##*/}          # Get only last part of the name
+
+    # Data validation
+    if [[ ! $disk =~ ^.*+[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+[/]+.*+$ ]]; then
+      bashio::log.fatal "The structure of your \"networkdisks\" option : \"$disk\" doesn't seem correct, please use a structure like //123.12.12.12/sharedfolder,//123.12.12.12/sharedfolder2. If you don't use it, you can simply remove the text, this will avoid this error message in the future."
+      exit 0
+    fi
+
+    # Prepare mount point
+    mkdir -p /mnt/$diskname
+    chown -R root:root /mnt/$diskname
+
+    #Tries to mount with default options
+    mount -t cifs -o rw,username=$CIFS_USERNAME,password=${CIFS_PASSWORD}$DOMAIN $disk /mnt/$diskname 2>ERRORCODE && MOUNTED=true || MOUNTED=false
+
+    # if Fail test different smb and sec versions
+    if [ $MOUNTED = false ]; then
+      for SMBVERS in ",vers=3" ",vers=1.0" ",vers=2.1" ",vers=3.0" ",nodfs" ",uid=0,gid=0,forceuid,forcegid" ",noforceuid,noforcegid" ",${DOMAIN:-WORKGROUP}"; do
+        mount -t cifs -o rw,file_mode=0777,dir_mode=0777,username=$CIFS_USERNAME,password=${CIFS_PASSWORD}$SMBVERS $disk /mnt/$diskname 2>/dev/null && MOUNTED=true && break || MOUNTED=false
+        for SECVERS in ",sec=ntlmi" ",sec=ntlmv2" ",sec=ntlmv2i" ",sec=ntlmssp" ",sec=ntlmsspi" ",sec=ntlm" ",sec=krb5i" ",sec=krb5" ",iocharset=utf8"; do
+          mount -t cifs -o rw,file_mode=0777,dir_mode=0777,username=$CIFS_USERNAME,password=${CIFS_PASSWORD}$SMBVERS$SECVERS $disk /mnt/$disk name 2>/dev/null && MOUNTED=true && break 2 && break || MOUNTED=false
+        done
+      done
+    fi
+
+    # Messages
+    if [ $MOUNTED = true ] && [ "mountpoint -q /mnt/$diskname" ]; then
+      #Test write permissions
+      touch /mnt/$diskname/testaze && rm /mnt/$diskname/testaze &&
+        bashio::log.info "... $disk successfully mounted to /mnt/$diskname with options $SMBVERS$SECVERS" ||
+        bashio::log.fatal "Disk is mounted, however unable to write in the shared disk. Please check UID/GID for permissions, and if the share is rw"
+
+    else
+      # Mounting failed messages
+      bashio::log.fatal "Error, unable to mount $disk to /mnt/$diskname with username $CIFS_USERNAME, $CIFS_PASSWORD. Please check your remote share path, username, password, domain, try putting 0 in UID and GID"
+      bashio::log.fatal "Here is some debugging info :"
+
+      # Provide debugging info
+      smbclient -V &>/dev/null || apt-get install smbclient || apk add --no-cache samba-client
+      #smbclient $disk -U $CIFS_USERNAME%$CIFS_PASSWORD  || true
+      smbclient -L $disk -U $CIFS_USERNAME%$CIFS_PASSWORD || true
+
+      # Error code
+      bashio::log.fatal "Error read : $(<ERRORCODE)"
+      rm ERRORCODE
+
+      # clean folder
+      umount /mnt/$diskname 2>/dev/null || true
+      rmdir /mnt/$diskname || true
+    fi
+
+  done
+fi