dimitri/ntfy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Send push notifications to your phone or desktop using PUT/POST
2114 commits 23 branches 90 tags 37 MiB
Find a file
nimbleghost 11f8984127 Add a way to use Docker for building everything 
I’d like to test #751 on my own instance, but installing all the build
dependencies on my server isn’t ideal - having this script in the repo
would make it possible to simply point my compose file to the git repo
and have it build the Linux binary itself.

Note that it uses a somewhat “inefficient” builder step, i.e. not
combining steps together to reduce layers, as it uses a multi-stage
build to have a lean final image. This makes it easier to re-build if
something needs to change, as the cache is used more optimally.

For example, if only some go files change, most of the build is already
cached and only the go step gets re-run.

The more “efficient” builder step would look like this, but would have
to build the docs, web app and go CLI for any change in any file:

```Dockerfile
FROM golang:1.19-bullseye as builder

RUN apt-get update && \
    curl -fsSL https://deb.nodesource.com/setup_18.x | bash && \
    apt-get install -y \
    build-essential \
    nodejs \
    python3-pip

WORKDIR /app
ADD . .

RUN make web docs cli-linux-server
```
2023-05-26 22:22:21 +02:00
.github Move checkout up since the cache needs lockfiles 2023-05-23 21:03:58 +02:00
assets
client
cmd Rename twilio-from-number to twilio-phone-number 2023-05-18 13:32:27 -04:00
docs Add a way to use Docker for building everything 2023-05-26 22:22:21 +02:00
examples Troubleshooting docs page 2023-03-20 15:34:10 -04:00
log Self-review 2023-05-17 10:39:15 -04:00
scripts Make emojis in docs larger 2023-04-06 21:51:25 -04:00
server Add vite 2023-05-24 22:16:10 +02:00
test
tools Profiling support 2023-03-28 14:41:16 -04:00
user The last one 2023-05-17 11:19:48 -04:00
util Fix false positive in ContainsAll function 2023-05-12 09:51:47 -03:00
web Make small code style improvements 2023-05-25 07:17:05 +02:00
.dockerignore Add a way to use Docker for building everything 2023-05-26 22:22:21 +02:00
.git-blame-ignore-revs Add eslint commits to .git-blame-ignore-revs 2023-05-24 12:58:49 +02:00
.gitignore Fix docs 2023-03-16 23:09:37 -04:00
.gitpod.yml
.goreleaser.yml Logo in rpm file 2023-05-18 13:51:58 -04:00
CODE_OF_CONDUCT.md
docker-compose.yml
Dockerfile
Dockerfile-build Add a way to use Docker for building everything 2023-05-26 22:22:21 +02:00
go.mod Self-review 2023-05-17 10:39:15 -04:00
go.sum More self-review 2023-05-17 10:58:28 -04:00
LICENSE
LICENSE.GPLv2
main.go
Makefile Add a way to use Docker for building everything 2023-05-26 22:22:21 +02:00
mkdocs.yml Replace favicon 2023-04-27 13:08:24 -04:00
README.md You rock Jonathan. Thank you for your sponsorship @jonathan-kosgei 2023-05-21 17:27:24 -04:00
requirements.txt
SECURITY.md

README.md

ntfy

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

Release Go Reference Tests Go Report Card codecov Discord Matrix Matrix space Reddit Healthcheck Gitpod

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 $3.33/month (if you use promo code MYTOPIC, limited time only). 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:

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 and all 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.

Translation status

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 already sponsoring ntfy:

I'd also like to thank JetBrains for providing their awesome IntelliJ IDEA to me for free, 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: