From e74ea62e8b56c65c12acaaf79b208bb21fb68c27 Mon Sep 17 00:00:00 2001
From: thespad <git@spad.co.uk>
Date: Tue, 2 Jul 2024 19:33:01 +0100
Subject: [PATCH] Document & default attachments location

---
 Dockerfile         |  4 +++-
 Dockerfile.aarch64 |  4 +++-
 README.md          |  6 ++++++
 readme-vars.yml    | 10 ++++++++++
 4 files changed, 22 insertions(+), 2 deletions(-)

diff --git a/Dockerfile b/Dockerfile
index 3a41ec7..c36854f 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -9,7 +9,9 @@ ARG APPRISE_TAG
 LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
 LABEL maintainer="Roxedus"
 
-ENV APPRISE_CONFIG_DIR=/config
+ENV APPRISE_CONFIG_DIR=/config \
+  APPRISE_ATTACH_DIR=/attachments \
+  APPRISE_ATTACH_SIZE=0
 
 RUN \
   echo "**** install build packages ****" && \
diff --git a/Dockerfile.aarch64 b/Dockerfile.aarch64
index 8926fb6..8966122 100644
--- a/Dockerfile.aarch64
+++ b/Dockerfile.aarch64
@@ -9,7 +9,9 @@ ARG APPRISE_TAG
 LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
 LABEL maintainer="Roxedus"
 
-ENV APPRISE_CONFIG_DIR=/config
+ENV APPRISE_CONFIG_DIR=/config \
+  APPRISE_ATTACH_DIR=/attachments \
+  APPRISE_ATTACH_SIZE=0
 
 RUN \
   echo "**** install build packages ****" && \
diff --git a/README.md b/README.md
index 8059f4b..bfc48fc 100644
--- a/README.md
+++ b/README.md
@@ -79,8 +79,10 @@ services:
       - PUID=1000
       - PGID=1000
       - TZ=Etc/UTC
+      - APPRISE_ATTACH_SIZE=0 #optional
     volumes:
       - /path/to/apprise-api/config:/config
+      - /path/to/apprise-api/attachments:/attachments #optional
     ports:
       - 8000:8000
     restart: unless-stopped
@@ -94,8 +96,10 @@ docker run -d \
   -e PUID=1000 \
   -e PGID=1000 \
   -e TZ=Etc/UTC \
+  -e APPRISE_ATTACH_SIZE=0 `#optional` \
   -p 8000:8000 \
   -v /path/to/apprise-api/config:/config \
+  -v /path/to/apprise-api/attachments:/attachments `#optional` \
   --restart unless-stopped \
   lscr.io/linuxserver/apprise-api:latest
 ```
@@ -110,7 +114,9 @@ Containers are configured using parameters passed at runtime (such as those abov
 | `-e PUID=1000` | for UserID - see below for explanation |
 | `-e PGID=1000` | for GroupID - see below for explanation |
 | `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
+| `-e APPRISE_ATTACH_SIZE=0` | Max attachment size in Mb. `0` disables attachments. Must have `/attachments` mounted to set to a positive value. |
 | `-v /config` | Persistent config files |
+| `-v /attachments` | Temporary storage for attachments when sent with notifications. |
 
 ## Environment variables from files (Docker secrets)
 
diff --git a/readme-vars.yml b/readme-vars.yml
index 7956c31..6533a04 100644
--- a/readme-vars.yml
+++ b/readme-vars.yml
@@ -26,6 +26,16 @@ param_usage_include_ports: true
 param_ports:
   - {external_port: "8000", internal_port: "8000", port_desc: "Port for apprise's interface and API."}
 
+opt_param_usage_include_vols: true
+opt_param_volumes:
+  - { vol_path: "/attachments", vol_host_path: "/path/to/{{ project_name }}/attachments", desc: "Temporary storage for attachments when sent with notifications." }
+
+opt_param_usage_include_env: true
+opt_param_env_vars:
+  - { env_var: "APPRISE_ATTACH_SIZE", env_value: "0", desc: "Max attachment size in Mb. `0` disables attachments. Must have `/attachments` mounted to set to a positive value." }
+
+readonly_supported: true
+
 # changelog
 changelogs:
   - {date: "24.06.24:", desc: "Rebase to Alpine 3.20."}