Service adapted from https://github.com/emersion/hydroxide for receiving push notifications for Protonmail via ntfy.sh
Go to file
Jarno Rankinen 1f0f33ee50 Update README 2024-06-14 17:19:57 +03:00
auth Rename package, don't serve IMAP 2024-06-14 17:19:50 +03:00
carddav Rename package, don't serve IMAP 2024-06-14 17:19:50 +03:00
cmd Combine auth/setup flow, update readme 2024-06-14 17:19:57 +03:00
config config: use os.UserConfigDir 2022-05-24 21:20:13 +02:00
events Rename package, don't serve IMAP 2024-06-14 17:19:50 +03:00
exports Rename package, don't serve IMAP 2024-06-14 17:19:50 +03:00
imap Rename package, don't serve IMAP 2024-06-14 17:19:50 +03:00
imports Rename package, don't serve IMAP 2024-06-14 17:19:50 +03:00
ntfy Combine auth/setup flow, update readme 2024-06-14 17:19:57 +03:00
protonmail Upgrade github.com/ProtonMail/go-crypto 2023-08-24 08:21:44 +02:00
smtp Rename package, don't serve IMAP 2024-06-14 17:19:50 +03:00
.build.yml ci: print build status 2018-10-28 16:58:28 +01:00
.gitignore Add authentication, fixes #2 2017-09-09 15:37:03 +02:00
Dockerfile Small tweaks to configuration flow, Dockerfile for running as a container 2024-06-14 17:19:57 +03:00
LICENSE Initial commit 2017-08-21 17:33:41 +02:00
README.md Update README 2024-06-14 17:19:57 +03:00
go.mod Upgrade dependencies 2024-04-14 17:36:50 +02:00
go.sum Upgrade dependencies 2024-04-14 17:36:50 +02:00

README.md

hydroxide-push

Forked from Hydroxide

Push notifications for Proton Mail mobile via a UP provider

Protonmail depends on Google services to deliver push notifications, This is a stripped down version of Hydroxide to get notified of new mail. See original repo for details on operation.

Setup

Download (soon), build the binary or the container image or pull the container image yourself. Simplest way is to run the container image.

Login and push gateway details are saved under $HOME/.config/hydroxide. The container image saves configuration under /data, so mount a named volume or host directory there. The examples below use a named volume.

If using Docker, substitute podman with docker in the examples.

Binary:

./hydroxide-push auth your.proton@email.address

Container:

podman run -it --rm -v hydroxide-config:/data ghcr.io/0ranki/hydroxide-push auth your.proton@email.address

You will be prompted for the Proton account credentials and the details for the push server. Proton credentials are stored encrypted form.

The auth flow generates a separate password for the bridge, which is stored in plaintext to $HOME/.config/notify.json. Unlike upstream hydroxide, there is no service listening on any port, all communications is internal to the program.

Reconfigure push server

Binary:git.oranki.net/jarno/hydroxide-push:latest

hydroxide-push setup-ntfy

Container:

podman run -it --rm -v hydroxide-config:/data ghcr.io/0ranki/hydroxide-push setup-ntfy

You'll be asked for the base URL of the push server, and the topic. These will probably be combined to a single string in future versions.

NOTE: Authentication for the push endpoint is not yet supported.

License

MIT