binwiederhier/ntfy

Send push notifications to your phone or desktop using PUT/POST

ntfy.sh | Send push notifications to your phone or desktop via PUT/POST

ntfy (pronounced "notify") is a simple HTTP-based pub-sub notification service. With ntfy, you can send notifications to your phone or desktop via scripts from any computer, without having to sign up or pay any fees. If you'd like to run your own instance of the service, you can easily do so since ntfy is open source.

You can access the free version of ntfy at ntfy.sh. There is also an open-source Android app available on Google Play or F-Droid, as well as an open source iOS app available on the App Store.

ntfy Pro 💸 🎉

I now offer paid plans for ntfy.sh if you don't want to self-host, or you want to support the development of ntfy (→ Purchase via web app). You can buy a plan for as low as $5/month. You can also donate via GitHub Sponsors, and Liberapay. I would be very humbled by your sponsorship. ❤️

Documentation

Getting started | Android/iOS | API | Install / Self-hosting | Building

Chat/forum

There are a few ways to get in touch with me and/or the rest of the community. Feel free to use any of these methods. Whatever works best for you:

• Discord server - direct chat with the community
• Matrix room #ntfy (+ Matrix space) - same chat, bridged from Discord
• GitHub issues - questions, features, bugs

Announcements/beta testers

For announcements of new releases and cutting-edge beta versions, please subscribe to the ntfy.sh/announcements topic. If you'd like to test the iOS app, join TestFlight. For Android betas, join Discord/Matrix (I'll eventually make a testing channel in Google Play).

Contributing

I welcome any contributions. Just create a PR or an issue. For larger features/ideas, please reach out on Discord/Matrix first to see if I'd accept them. To contribute code, check out the build instructions for the server and the Android app. Or, if you'd like to help translate 🇩🇪 🇺🇸 🇧🇬, you can start immediately in Hosted Weblate.

Sponsors

I have just very recently started accepting donations via GitHub Sponsors, and Liberapay. I would be humbled if you helped me carry the server and developer account costs. Even small donations are very much appreciated. A big fat Thank You to the folks who have sponsored ntfy in the past, or are still sponsoring ntfy:

I'd also like to thank JetBrains for their awesome IntelliJ IDEA, and DigitalOcean (referral link) for supporting the project:

Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

Please be sure to read the complete Code of Conduct.

License

Made with ❤️ by Philipp C. Heckel.
The project is dual licensed under the Apache License 2.0 and the GPLv2 License.

Third-party libraries and resources:

• github.com/urfave/cli (MIT) is used to drive the CLI
• Mixkit sounds (Mixkit Free License) are used as notification sounds
• Sounds from notificationsounds.com (Creative Commons Attribution) are used as notification sounds
• Roboto Font (Apache 2.0) is used as a font in everything web
• React (MIT) is used for the web app
• Material UI components (MIT) are used in the web app
• MUI dashboard template (MIT) was used as a basis for the web app
• Dexie.js (Apache 2.0) is used for web app persistence in IndexedDB
• GoReleaser (MIT) is used to create releases
• go-smtp (MIT) is used to receive e-mails
• stretchr/testify (MIT) is used for unit and integration tests
• github.com/mattn/go-sqlite3 (MIT) is used to provide the persistent message cache
• Firebase Admin SDK (Apache 2.0) is used to send FCM messages
• github/gemoji (MIT) is used for emoji support (specifically the emoji.json file)
• Lightbox with vanilla JS as a lightbox on the landing page
• HTTP middleware for gzip compression (MIT) is used for serving static files
• Regex for auto-linking (MIT) is used to highlight links (the library is not used)
• Statically linking go-sqlite3
• Linked tabs in mkdocs
• webpush-go (MIT) is used to send web push notifications

ntfy's Issues

Discord/Slack bot

Send messages to topics

/ntfy send mytopic This is a message
/ntfy send myserver.com/mytopic This is a message
/ntfy send --tags=warning,skull mytopic This is a message
...

Subscribe to messages (much cooler) to forward messages to channel

/ntfy subscribe ntfy.sh/mytopic

`curl -s` doesn't work

I can successfully push a message to, but I can't get it in a GET request with curl -s

Make ntfy a UnifiedPush distributor

https://unifiedpush.org

Delayed delivery via At: + In/Delay:

Update/Delete/cancel notifications

Return token on publish

Or set token when publishing

Let user choose delivery mode: instant delivery, 1min, 5min, 15min, ...

Make delivery mode configurable in the app:

• instant (requires foreground service)
• 1min (requires foreground service)
• 5min (requires foreground service)
• 15min (does NOT require foreground service)
• ..

ntfy CLI

The CLI could consist of 3 features:

Server

Just like today, possibly rename command to ntfy serve

Subscribe to topics

Just like curl:

$ ntfy subscribe mytopic1,mytopic2 
{"id":"UiLWPRJAi1","time":1639044609,"event":"message","topic":"mytopic1","message":"It is Thu Dec 09 2021 17:10:09 GMT+0700 (Western Indonesia Time). This is a test."}
{"id":"idFle3ak4S","time":1639074191,"event":"message","topic":"mytopic2","message":"Test"}
...

With a hook:

$ ntfy subscribe mytopic1,mytopic2 --hook 'notify-send "{{.Message}}'

As part of the daemon

$ cat config.yml
subscribe:
   - 
     - topic: ntfy.sh/mytopic
     - hook: 'notify-send "{{.Message}}'

$ ntfy serve # runs daemon

Send messages

ntfy send mytopic "This is a message"
...

Progress in notification via Progress: 0-100

I think it'd be super cool to be able to show a progress bar in the Android app for something that's running remotely, like a compilation, or a build process.

id=$(curl -d "Build process starting" ntfy.sh/mytopic | jq .id)
for progress in 10 20 30 40 50 60 70 80 90 100; do 
  curl -X PATCH -d "Build process running, currently ${progress}%" -H "Progress: $progress" ntfy.sh/mytopic/$id
  sleep 10
done

This entirely relies on #43, and is pretty easy once that's implemented.

See you are enabled client also on Desktop but only android app

Does it using flutter? What if I want a flutter as client?
So that we can cross platform get notifications.

API errors should be JSON and be more user friendly

Right now:

$ curl -v -d "This was a little delayed" -H "Delay: 1s" ntfy.sh/abc
> POST /abc HTTP/1.1
> Host: ntfy.sh
> Delay: 1s
...
< HTTP/1.1 400 Bad Request
< Server: nginx
... 
Bad Request

Should be:

$ curl -v -d "This was a little delayed" -H "Delay: 1s" ntfy.sh/abc
> POST /abc HTTP/1.1
> Host: ntfy.sh
> Delay: 1s
...
< HTTP/1.1 400 Bad Request
< Server: nginx
< Content-Type: application/json
... 
{"error":192,"http":400,"message":"delay must be between 10s and 3 days"}

`chown: cannot access '"/var/cache/ntfy/cache.db"': No such file or directory`

$ sudo dpkg -i dist/ntfy_v1.5.2-next_linux_amd64.deb
(Reading database ... 406444 files and directories currently installed.)
Preparing to unpack .../ntfy_v1.5.2-next_linux_amd64.deb ...
Unpacking ntfy (1.5.2~next) over (1.5.2~next) ...
Setting up ntfy (1.5.2~next) ...
chown: cannot access '"/var/cache/ntfy/cache.db"': No such file or directory

Priorities, title, tags

Priorities: 1-5 (5=high, 1=low)

curl -d "my message -H "X-Priority: low" ntfy.sh/mytopic
curl -d "my message -H "Priority: high" ntfy.sh/mytopic
curl -d "my message -H "prio: 5" ntfy.sh/mytopic
curl -d "my message -H p:5 ntfy.sh/mytopic

Title:

curl -d "my message -H "X-Title: This is a title" ntfy.sh/mytopic
curl -d "my message -H "Title: This is a title" ntfy.sh/mytopic
curl -d "my message -H "t: This is a title" ntfy.sh/mytopic
curl -d "my message -H "ti: This is a title" ntfy.sh/mytopic

Tags:

curl -d "my message -H "X-Tags: warning,skull" ntfy.sh/mytopic
curl -d "my message -H "Tags: warning,skull" ntfy.sh/mytopic
curl -d "my message -Hta:warning,skull ntfy.sh/mytopic

Daily Summary Notification

I would like to schedule a summary notification, daily at 8am with minimal content something like:

Last 24 hours:
New: 24 messages
Unread: 3 messages (2 /topic1, 1 /topic2)

This would let me see at a glance if any hot topics had come in overnight on say, a chatty release/testing night and be more comfortable turning off my notifications.

Delete messages

Is there a way to delete all messages (or all messages since )?

allow disabling cache via Cache: no

Cache: 10m/yes/no/max/default

Opening ntfy.sh link in a browser on Android opens the app and subscribes to the topic if the app is installed

A scenario may be:

• I have the ntfy.sh app installed on my Android device
• A browser page or application (like Slack) has a URL to a ntfy.sh topic

If I click on the ntfy.sh link, it will attempt to open the app and subscribe to the topic, so that I can view it from there.

If I do not have the ntfy.sh link, it will display the web page for that topic.

ntfy GitHub org

Hey @ntfy, if you're reading this, would you be willing to give up your username, so I can create a GitHub org for this project. Looks like you're not using the GitHub account anyway. I'd be willing to buy you a coffee or the like for your troubles.

Webhooks: GET requests for simple pings without messages

I propose allowing GET requests with no parameters to send simple ping notification without message. Quicker to type in terminal when someone wants a notification but not necessarily a message

Better build pipeline, build in github workflow

Unsubscribing takes long sometimes

"I had subscribed to mytopic and left my tablet off to the side for some of the weekend. When I unsubscribed from it this morning, it did take a bit to remove itself from the UI. Would like to see if that can be replicated"

Unit tests

"Clear all notifications" menu item

As requested per beta user feedback.

Target certain devices

See https://discord.com/channels/874398661709295626/874398661709295629/919114373992165437

I picture this very simple:

curl ntfy.sh/mytopic/json?id=device1

And then:

curl -d "Hi" "Targets: device1,device2" ntfy.sh/mytopic

deb/rpm: Make systemd unit run as `ntfy` user

Do not publish to firebase via Firebase: no

better documentation

Android foreground service does not restart on upgrade

I've been working hard on this: binwiederhier/ntfy-android#5

Opening ntfy.sh/docs on a phone opens the app 🤦‍♂️

This is due to Android's limited way of specifying which links should be handled by the app. I am thinking maybe we should just handle

https://ntfy.sh/.*/subscribe

systemd service does not restart on package upgrade

Manually refreshing fails if one subscription URL is not reachable

This is annoying if your self-hosted instance is in your LAN and not always reachable.

Copyright holder is not specified in LICENSE file

iOS app

If you're interested in making an iOS app, I'm more than happy to help out. Unfortunately I don't have an iPhone or a Mac so it's a little tricky for me.

Significant work has been done here (https://github.com/Copephobia/ntfy-ios), but it's stale now, sadly.

I have picked up the work in https://github.com/binwiederhier/ntfy-ios and will hopefully be able to release soon.

Auth

I would like to require authentication to pub/sub to topics at least on private servers.
I think Google Identity would be a good provider here since authenticating to it is a familiar part of the types of workflows I would like to incorporate this into.

UTF8

Is it possible to process utf-8 encoding? Say, I've sent russian strings and gets bad symbols. Take a look at ntfy.sh/manson_alerts channeln you'll see it.

Sending files

$ curl -Timage.jpg ntfy.sh/mytopic
{"message": "Attached file", "attachment":{"url":"https://ntfy.sh/mytopic/file/JxAebdF.jpg","type":"image/jpeg","size":1234,"expires":12345,"url":"https://ntfy.sh/mytopic/file/JxAebdF.jpg"}}

$ curl -Timage.jpg -H "Filename: ntfy.sh/mytopic
{"message": "Attached file", "attachment":{"name":"image.jpg","type":"image/jpeg","size":1234,"expires":12345,"url":"https://ntfy.sh/mytopic/file/JxAebdF.jpg"}]

Investigate strategies for battery optimization

Options:

• Polling every x minutes
• UnifiedPush

ARM Support

Looks great and very suitable for raspis. Any chance of arm (docker) builds?

Make build without Firebase to include in F-Droid

See

• https://f-droid.org/en/docs/Inclusion_Policy/
• https://f-droid.org/en/docs/FAQ_-_App_Developers/#how-do-i-get-my-app-included

Add Python to examples in docs

No notification via Silent:yes

Sending int/long extras for SEND_MESSAGE should work

"I am trying integration, but I found out, that if I want to send message throught intent that contains only numbers it will fail. If I use curl it won't fail. For example '5555' will fail, but '5555t' won't fail, because there's a letter.

Topic is no problem, but message containing only numbers will fail."

Android app: "Silence notifications until"

Android automation apps integration (Tasker, MacroDroid, Automate, ...)

Hi! I am the guy from Reddit!

Android automation apps are tools that helps you automate your android smartphone. They are like simple automation programming. There's a lot of them. Most known is Tasker, but also MacroDroid and Auomate too and there's also lot of other.

I see big potential in communicating between devices throught ntfy.sh. Of course many of these apps have their own solution, for example MacroDroid runs its own webhook server and there's a lot of other solutions for Tasker, but one more option is always good and your service seems to have a lot of more options. SO NOW TO THE POINT.

HOW TO INTEGRATE NFTY WITH AUTOMATIZATION APPS

As I mentioned before MacroDroid is able to use curl, but I don't know Tasker or any else, but they propably should also be able to.

There are 2 best ways how to integrate nfty with automatization apps

• via Tasker plugin (which also MacroDroid and Automate suppports)
• via broadcasting intents (which I think is better and simpler for this kind of thing)

Here is official video on how to create a Tasker pugin
https://piped.kavin.rocks/watch?v=48IVJgDtu6Y

However in this case I think intent solution would be much more simple and also more could make use of it. Tasker plugin is good for advanced triggers and actions, with a lot of data, but for something simple like messages it's not propably needed. Also more apps that doesn't work with Tasker plugins could make use of it.

let me give an EXAMPLE OF BROADCAST intent after message is received. I am an amateur so forgive me any mistakes. I am not writing in code, just showing what should intent contain.

Action: io.heckel.ntfy.messageReceived
Extra 'topic': my_custom_topic
Extra 'title': my_custom_title
Extra 'priority': 3
Extra 'tags': warning,skull
Extra 'message': my_custom_message

One note. There should be a ability to turn this intent broadcasting on and off, so any unwanted apps couldn't catch or send intents and misuse the ability.

Look at mqtt

Make selecting same base URL easier (default host or autocomplete)

Move to EC2 server

Currently ntfy.sh runs on a server in Germany, with a rather high latency. I'd like to move it to an EC2 instance with an nginx frontend.

Android app: per-subscription / per-priority notification sound

Support for other media types: images, URLs, ...

"I used a similar push notification service (Pushover) on my iPhone to send URLs in messages (to open a browser page on my phone). It could be neat to see a similar functionality for ntfy"

"Similarly to URLs, maybe attachments (like images) - imagine an App with push notifications, that sends an embedded image of the failed screenshot"

Android, Feature Request: allow subscribing to multiple topics

The Web and curl allow for subscribing to multiple topics, like this:

Subscribing to multiple topics (topic1,topic2,...)

It's possible to subscribe to multiple topics in one HTTP call by providing a comma-separated list of topics in the URL. This allows you to reduce the number of connections you have to maintain: 

That does not work in the app currently, but would make "following" multiple topics easier.

healthchecks.io integration

See healthchecks/healthchecks#590

This should be pretty simple, see https://github.com/healthchecks/healthchecks/blob/master/hc/api/transports.py#L384

Also we'd have to write docs and such; but there are enough examples.