LAB-linuxserver/docker-apprise-api
1
0
Fork 0
mirror of https://github.com/linuxserver/docker-apprise-api.git synced 2026-02-23 00:00:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #13 from linuxserver/ro-tweaks

Browse Source
This commit is contained in:
Roxedus 2024-07-05 11:41:23 +02:00 committed by GitHub
commit 79443aba28
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Dockerfile
View File

@ -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 ****" && \

4
Dockerfile.aarch64
View File

@ -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 ****" && \

6
README.md
View File

@ -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)

10
readme-vars.yml
View File

@ -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."}