Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document & default attachments location #13

Merged
merged 1 commit into from
Jul 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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 ****" && \
Expand Down
4 changes: 3 additions & 1 deletion Dockerfile.aarch64
Original file line number Diff line number Diff line change
Expand Up @@ -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 ****" && \
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
Expand All @@ -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)

Expand Down
10 changes: 10 additions & 0 deletions readme-vars.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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."}
Expand Down