From 1513c108f357e54f0cce6a3e1e6d8304eca51965 Mon Sep 17 00:00:00 2001 From: Josua Frank Date: Tue, 11 Jun 2024 03:17:56 +0200 Subject: [PATCH] App Submission: ntfy (#1118) Co-authored-by: nmfretz --- ntfy/data/cache/.gitkeep | 0 ntfy/data/data/.gitkeep | 0 ntfy/data/lib/.gitkeep | 0 ntfy/docker-compose.yml | 28 +++++++++++++++++++ ntfy/entrypoint.sh | 5 ++++ ntfy/umbrel-app.yml | 58 ++++++++++++++++++++++++++++++++++++++++ 6 files changed, 91 insertions(+) create mode 100644 ntfy/data/cache/.gitkeep create mode 100644 ntfy/data/data/.gitkeep create mode 100644 ntfy/data/lib/.gitkeep create mode 100644 ntfy/docker-compose.yml create mode 100644 ntfy/entrypoint.sh create mode 100644 ntfy/umbrel-app.yml diff --git a/ntfy/data/cache/.gitkeep b/ntfy/data/cache/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/ntfy/data/data/.gitkeep b/ntfy/data/data/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/ntfy/data/lib/.gitkeep b/ntfy/data/lib/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/ntfy/docker-compose.yml b/ntfy/docker-compose.yml new file mode 100644 index 0000000..174c0af --- /dev/null +++ b/ntfy/docker-compose.yml @@ -0,0 +1,28 @@ +version: "3.7" + +services: + app_proxy: + environment: + APP_HOST: ntfy_app_1 + APP_PORT: 80 + PROXY_AUTH_ADD: false + + app: + image: binwiederhier/ntfy:v2.11.0@sha256:4a7d0f0adc6d5d9fc36e64ab55ef676e76e124a2bdd50ce115b6d9c1c7430294 + user: "1000:1000" + restart: on-failure + stop_grace_period: 1m + entrypoint: [ "/bin/sh", "/entrypoint.sh" ] + volumes: + - ${APP_DATA_DIR}/entrypoint.sh:/entrypoint.sh + - ${APP_DATA_DIR}/data/cache:/var/cache/ntfy + - ${APP_DATA_DIR}/data/data:/etc/ntfy + - ${APP_DATA_DIR}/data/lib:/var/lib/ntfy + environment: + NTFY_BASE_URL: http://${DEVICE_DOMAIN_NAME}:${APP_PROXY_PORT} + NTFY_UPSTREAM_BASE_URL: https://ntfy.sh + NTFY_CACHE_FILE: /var/cache/ntfy/cache.db + NTFY_ENABLE_LOGIN: true + NTFY_AUTH_FILE: /var/lib/ntfy/user.db + NTFY_AUTH_DEFAULT_ACCESS: deny-all + NTFY_PASSWORD: ${APP_PASSWORD} \ No newline at end of file diff --git a/ntfy/entrypoint.sh b/ntfy/entrypoint.sh new file mode 100644 index 0000000..4fa379e --- /dev/null +++ b/ntfy/entrypoint.sh @@ -0,0 +1,5 @@ +#!/bin/sh +ntfy serve & +sleep 2 +NTFY_PASSWORD=${NTFY_PASSWORD} ntfy user add --role=admin umbrel || true +wait \ No newline at end of file diff --git a/ntfy/umbrel-app.yml b/ntfy/umbrel-app.yml new file mode 100644 index 0000000..34a355e --- /dev/null +++ b/ntfy/umbrel-app.yml @@ -0,0 +1,58 @@ +manifestVersion: 1 +id: ntfy +name: ntfy +tagline: Send notifications to your phone or desktop via scripts from any computer, and/or using a REST API +category: automation +version: "2.11.0" +port: 13119 +description: >- + ntfy (pronounced notify) is a simple HTTP-based pub-sub notification service. It allows you to send notifications to + your phone or desktop via scripts from any computer, and/or using a REST API. + + + ℹī¸ iOS Notifications + + Apple's restrictions require a publicly reachable server for instant notifications on iOS. We use https://ntfy.sh for poll + requests by default. This doesn't send your notifications through this service, but instead only prompts your iOS device to + download the notification from your local ntfy instance. Advanced users can remove the "NTFY_UPSTREAM_BASE_URL" environment variable from the Docker compose file if desired; however, this will disable instant notifications on iOS devices. + + + 🔔 Send push notifications from your app or script + + Publishing messages can be done via PUT or POST. Topics are created on the fly by subscribing or publishing to them. + If you use ntfy without sign-up, the topic is essentially a password, so pick something that's not easily guessable. + + + 📱 Receive notifications on your phone + + Subscribe to a topic and receive notifications, with different priorities, attachments, action buttons, tags & emojis, + and even for automation. + + + đŸ’ģ Get notified on your computer + + You can use the web app to subscribe to topics as well. If you do, notifications will pop up as desktop notifications. + Simply type in the topic name and click the Subscribe button. The browser will keep a connection open and listen for + incoming notifications. + + + ⚙ī¸ Integrate with your favorite tools + + Publishing messages is just a HTTP request, so pretty much everything under the sun can integrate with ntfy. Hundreds + of integrations, projects or scripts already support ntfy. + +developer: ntfy LLC +website: https://ntfy.sh/ +submitter: Sharknoon +submission: https://github.com/getumbrel/umbrel-apps/pull/ +repo: https://github.com/binwiederhier/ntfy +support: https://github.com/binwiederhier/ntfy/issues +gallery: + - 1.jpg + - 2.jpg + - 3.jpg +releaseNotes: "" +dependencies: [] +path: "" +defaultUsername: umbrel +deterministicPassword: true \ No newline at end of file