https://github.com/chatmail/notifiers
Notify devices
https://github.com/chatmail/notifiers
apns chatmail fcm notifications proxy
Last synced: 8 months ago
JSON representation
Notify devices
- Host: GitHub
- URL: https://github.com/chatmail/notifiers
- Owner: chatmail
- License: apache-2.0
- Created: 2020-07-29T12:09:58.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-03-25T16:43:50.000Z (about 1 year ago)
- Last Synced: 2025-04-10T21:22:43.208Z (about 1 year ago)
- Topics: apns, chatmail, fcm, notifications, proxy
- Language: Rust
- Homepage:
- Size: 110 KB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Chatmail Notification Proxy
The Chatmail notification proxy is deployed as a central service
on https://notifications.delta.chat
The notification proxy is a small Rust program
that forwards "device tokens" to Apple and Google "Push Services"
that in turn wake up the clients
using [Chatmail core](https://github.com/chatmail/core/) on user's devices.
## Usage
### Certificates
The certificate file provided must be a `.p12` file. Instructions for how to create can be found [here](https://stackoverflow.com/a/28962937/1358405).
### Running
```sh
$ cargo build --release
$ ./target/release/notifiers --certificate-file --password
```
### Registering devices
```sh
$ curl -X POST -d '{ "token": "" }' http://localhost:9000/register
```
### Enabling metrics
To enable OpenMetrics (Prometheus) metrics endpoint,
run with `--metrics` argument,
e.g. `--metrics 127.0.0.1:9001`.
Metrics can then be retrieved with
`curl http://127.0.0.1:9001/metrics`.