Skip to content
Draft
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
12 changes: 12 additions & 0 deletions ntfy/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,17 @@ RUN apk update \
#COPY --from=build /go/bin/ntfy /ntfy
COPY --from=build /go/src/github.com/binwiederhier/ntfy/ntfy /usr/local/bin/ntfy

# Specify the volume for ntfy configuration.
# Users can mount their server.yml here.
VOLUME /etc/ntfy

# For server.yml configuration, especially for APNS (iOS notifications),
# please consult the ntfy/README.md in this repository and the official ntfy documentation.
#
# Example APNS configuration via environment variables (VERIFY WITH NTFY DOCUMENTATION):
# ENV NTFY_IOS_KEY_ID=your_key_id
# ENV NTFY_IOS_TEAM_ID=your_team_id
# ENV NTFY_IOS_PRIVATE_KEY_FILE=/path/in/container/to/AuthKey.p8

ENTRYPOINT ["/usr/local/bin/ntfy"]

11 changes: 11 additions & 0 deletions ntfy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,14 @@

Up to date multi-platform images are built an hour after upstream release and rebuilt at least once a week.

## iOS Notifications (APNS Setup)

For iOS notifications to work, you must configure APNS (Apple Push Notification Service) in your `ntfy` server configuration file (usually `server.yml`). This requires an APNS authentication key (`.p8` file), Key ID, and Team ID, which can be obtained from your Apple Developer account.

It is strongly recommended to consult the official `ntfy` documentation at `https://ntfy.sh/docs/config/#ios-notifications-apns` for detailed instructions on generating these credentials and configuring the `server.yml` file.

Conceptually, you would mount your `server.yml` file when running the Docker container like so:

```
docker run -v /path/to/your/server.yml:/etc/ntfy/server.yml jauderho/ntfy ...
```