3pp-mirror/pushbits
1
0
Fork 0
mirror of https://github.com/pushbits/server.git synced 2025-04-29 18:26:49 +02:00
Code Issues Projects Releases Packages Wiki Activity
A simple server for push notifications via Matrix (and a minimalistic alternative to Pushover and Gotify with a strong focus on security) 🚀📯
2 commits 1 branch 27 tags 974 KiB
Go 97.4%
Makefile 1.6%
Dockerfile 1%
Find a file
eikendev 8d41fc0864
Add configuration for Travis CI
2020-07-26 15:27:36 +02:00
api Initialize repository 2020-07-26 00:32:13 +02:00
authentication Initialize repository 2020-07-26 00:32:13 +02:00
configuration Initialize repository 2020-07-26 00:32:13 +02:00
database Initialize repository 2020-07-26 00:32:13 +02:00
dispatcher Initialize repository 2020-07-26 00:32:13 +02:00
model Initialize repository 2020-07-26 00:32:13 +02:00
router Initialize repository 2020-07-26 00:32:13 +02:00
runner Initialize repository 2020-07-26 00:32:13 +02:00
.editorconfig Initialize repository 2020-07-26 00:32:13 +02:00
.gitignore Add configuration for Travis CI 2020-07-26 15:27:36 +02:00
.travis.yml Add configuration for Travis CI 2020-07-26 15:27:36 +02:00
app.go Initialize repository 2020-07-26 00:32:13 +02:00
go.mod Add configuration for Travis CI 2020-07-26 15:27:36 +02:00
go.sum Add configuration for Travis CI 2020-07-26 15:27:36 +02:00
LICENSE Initialize repository 2020-07-26 00:32:13 +02:00
Makefile Add configuration for Travis CI 2020-07-26 15:27:36 +02:00
README.md Initialize repository 2020-07-26 00:32:13 +02:00

README.md

About

PushBits is a relay server for push notifications. It enables your services to send notifications via a simple web API, and delivers them to you through various messaging services.

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

  • plugins written for Gotify and
  • clients written for all major platforms can be reused.

For now, only the Matrix protocol is supported, but support for different services like Telegram could be added in the future. I am myself experimenting with Matrix currently because I like the idea of a federated, synchronized but still end-to-end encrypted protocol.

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.

Usage

PushBits is meant to be self-hosted. You are advised to install PushBits behind a reverse proxy and enable TLS.

At the moment, there is no front-end implemented. New users and applications need to be created via the API. Details will be made available once the interface is more stable.

Development

PushBits is currently in alpha stage. The API is neither stable, nor is provided functionality guaranteed to work. Stay tuned! 😉