Skip to content

A relay server for push notifications via Matrix (and a minimalistic alternative to Pushover and Gotify with a strong focus on security) 🚀📯

License

Notifications You must be signed in to change notification settings

CubicrootXYZ/pushbits-server

 
 

Repository files navigation

This software is currently in alpha phase.

PushBits

Receive your important notifications immediately, over Matrix.

PushBits enables you to send push notifications via a simple web API, and delivers them to your users.

Build status  Documentation  API Documentation  Matrix  License

💡 About

PushBits is a relay server for push notifications. It enables you to send notifications via a simple web API, and delivers them to you through Matrix. This is similar to what Pushover and Gotify offer, but it does not require an additional app.

The vision is to have compatibility with Gotify on the sending side, while on the receiving side an established service is used. This has the advantages that

  • sending plugins written for Gotify (like those for Watchtower and Jellyfin) as well as
  • receiving clients written for Matrix can be reused.

Why Matrix instead of X?

This project totally would've used Signal if it would offer a proper API. Sadly, neither Signal nor WhatsApp come with an API (at the time of writing) through which PushBits could interact.

In Telegram there is an API to run bots, but these are limited in that they cannot create chats by themselves. If you insist on going with Telegram, have a look at webhook2telegram.

The idea of a federated, synchronized but yet end-to-end encrypted protocol is awesome, but its clients simply aren't really there yet. Still, if you haven't tried it yet, we'd encourage you to check it out.

🤘 Features

  • Multiple users and multiple channels (applications) per user
  • Compatibility with Gotify's API for sending messages
  • API and CLI for managing users and applications
  • Optional check for weak passwords using HIBP
  • Argon2 as KDF for password storage
  • Two-factor authentication, issue
  • Bi-directional key verification, issue

👮 Acknowledgments

The idea for this software and most parts of the initial source are heavily inspired by Gotify. Many thanks to jmattheis for his well-structured code.

💻 Development

The source code is located on GitHub. You can retrieve it by checking out the repository as follows.

git clone https://github.com/pushbits/server.git

Stargazers over time

About

A relay server for push notifications via Matrix (and a minimalistic alternative to Pushover and Gotify with a strong focus on security) 🚀📯

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 98.8%
  • Other 1.2%