Cleanup & DOC Update

Author: joshuamerold

paperless-ngx/DOCS.md

@@ -70,6 +70,10 @@ consumer_subdirs_as_tags: false
 ssl: false
 certfile: fullchain.pem
 keyfile: privkey.pem
+backup_enabled: false
+backup_path: /share/paperless/exports
+backup_cron: "0 3 * * *"
+backup_keep_count: 3
 ```
 
 ### Option: `url`
@@ -152,6 +156,22 @@ The private key file to use for SSL.
 
 Let you set `client_max_body_size` of _nginx_ manually
 
+### Option: `backup_enabled`
+
+Enables or disables automatic backups of your Paperless data. Set to `true` to enable scheduled backups. `false` ist default.
+
+### Option: `backup_path`
+
+Specifies the directory where backup files will be stored. The default path is `/share/paperless/exports`.
+
+### Option: `backup_cron`
+
+Defines the cron schedule for automatic backups. The default value `"0 3 * * *"` runs backups daily at 3:00 AM. Use standard cron syntax to customize the backup schedule.
+
+### Option: `backup_keep_count`
+
+Sets the number of most recent backups to retain. Older backups beyond this count will be automatically deleted. The default is `3` backups.
+
 ### More personalisation
 
 You can add more configurations options in `/addon_config/paperless_ngx/paperless.conf`

paperless-ngx/Dockerfile

@@ -133,13 +133,12 @@ RUN --mount=type=cache,target=/root/.cache/uv/,id=uv-cache \
   && echo "Download Paperless-ngx" \
   && curl -J -L -s -o paperless.tar.xz https://github.com/paperless-ngx/paperless-ngx/releases/download/${PAPERLESS_VERSION}/paperless-ngx-${PAPERLESS_VERSION}.tar.xz \
   && tar -xf paperless.tar.xz \
-  && mv paperless-ngx /usr/src/paperless \
-  && apt-get update && apt-get install -y
+  && mv paperless-ngx /usr/src/paperless
 
 WORKDIR /usr/src/paperless
 
 # Packages needed only for building a few quick Python
-# dependencies & running a backup script
+# dependencies
 ARG BUILD_PACKAGES="\
   build-essential \
   git \
@@ -205,8 +204,7 @@ RUN set -eux \
   && useradd --uid 1000 --gid paperless --home-dir /usr/src/paperless paperless \
   && chown -R paperless:paperless /usr/src/paperless \
   && gosu paperless python3 manage.py collectstatic --clear --no-input --link \
-  && gosu paperless python3 manage.py compilemessages \
-  && chmod +x /usr/local/bin/paperless_backup.sh
+  && gosu paperless python3 manage.py compilemessages
 
 ENV PAPERLESS_REDIS="redis://localhost:6379"
 ENV PAPERLESS_DATA_DIR="/config/data"
@@ -222,7 +220,8 @@ VOLUME ["/usr/src/paperless/data", \
 # Copy root filesystem
 COPY rootfs/ /
 
-RUN chmod +x /usr/local/bin/paperless_backup.sh
+RUN chmod +x /usr/local/bin/paperless_backup.sh \
+  && chmod +x /etc/cont-init.d/90-cron-backup.sh
 
 # Build arguments
 ARG BUILD_ARCH

paperless-ngx/rootfs/etc/cont-init.d/90-cron-backup.sh

@@ -9,7 +9,7 @@ if type bashio >/dev/null 2>&1; then
     BACKUP_ENABLED="$(bashio::config 'backup_enabled')"
     BACKUP_KEEP_COUNT="$(bashio::config 'backup_keep_count')"
 else
-    CRON_SCHEDULE="${BACKUP_CRON:-0 2 * * *}"
+    CRON_SCHEDULE="0 2 * * *"
     BACKUP_ENABLED="false"
     BACKUP_KEEP_COUNT=-1
 fi
@@ -21,7 +21,7 @@ fi
 
 mkdir -p /etc/cron.d
 
-echo "${CRON_SCHEDULE:-0 3 * * *} /usr/local/bin/paperless_backup.sh" > /etc/cron.d/paperless-backup
+echo "${CRON_SCHEDULE} /usr/local/bin/paperless_backup.sh" > /etc/cron.d/paperless-backup
 
 chmod 0644 /etc/cron.d/paperless-backup
 

paperless-ngx/scripts/paperless_backup.sh

@@ -10,7 +10,7 @@ else
     BACKUP_PATH="/share/paperless/exports"
 fi
 
-NOW=$(date '+%Y-%m-%d %H:%M:%S')
+NOW=$(date '+%Y-%m-%d-%H:%M:%S')
 echo "[INFO] Backup started: $NOW"
 
 mkdir -p $BACKUP_PATH/temp