3pp-mirror/pushbits
1
0
Fork 0
mirror of https://github.com/pushbits/server.git synced 2025-05-02 11:46:17 +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) 🚀📯
60 commits 1 branch 27 tags 974 KiB
Go 97.4%
Makefile 1.6%
Dockerfile 1%
Find a file
eikendev 2d4d270317
Explain what the new CLI tool does
2021-01-15 23:33:15 +01:00
.github/workflows Setup path directly in the job where needed 2020-12-27 23:57:10 +01:00
.vscode Add tasks for Code 2021-01-05 00:27:32 +01:00
api Register application after adding it to database 2021-01-05 00:32:27 +01:00
assert Partially implement updates of models 2020-08-02 02:46:38 +02:00
authentication Return nil when application cannot retrieved 2020-11-28 09:10:51 +01:00
configuration Increase default parameters for Argon2 2020-07-31 20:06:36 +02:00
database Add health check for Docker image 2020-08-06 20:42:35 +02:00
dispatcher Add application IDs to debugging output 2021-01-05 00:30:59 +01:00
model Handle unbound members when binding request 2020-08-03 15:37:16 +02:00
router Add health check for Docker image 2020-08-06 20:42:35 +02:00
runner Add configuration for HTTP and debug mode 2020-07-31 20:04:33 +02:00
.dockerignore Add simplistic Dockerfile 2020-07-27 22:05:00 +02:00
.editorconfig Initialize repository 2020-07-26 00:32:13 +02:00
.gitignore Add Makefile target to build project 2021-01-05 00:28:10 +01:00
app.go Implement changing of passwords 2020-08-02 14:45:24 +02:00
Dockerfile Add health check for Docker image 2020-08-06 20:42:35 +02:00
go.mod Update go.mod and go.sum 2021-01-05 00:30:00 +01:00
go.sum Update go.mod and go.sum 2021-01-05 00:30:00 +01:00
LICENSE Initialize repository 2020-07-26 00:32:13 +02:00
Makefile Add Makefile target to build project 2021-01-05 00:28:10 +01:00
README.md Explain what the new CLI tool does 2021-01-15 23:33:15 +01:00

README.md

Build status Docker Pulls License

PushBits

❗ This software is currently in alpha phase.

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 Matrix. This is similar to what PushBullet, Pushover, and Gotify offer, but a lot less complex.

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 the messaging service can be reused.

Why Matrix instead of X?

For now, only Matrix is supported, but support for different services like Telegram could be added in the future. WhatsApp and Signal unfortunately do not have an API through which PushBits can interact.

I am myself experimenting with Matrix currently because I like the idea of a federated, synchronized but still end-to-end encrypted protocol. If you haven't tried it yet, I suggest you to check it out.

Usage

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

To get started, here is a Docker Compose file you can use.

version: '2'

services:
    server:
        image: eikendev/pushbits:latest
        ports:
            - 8080:8080
        environment:
            PUSHBITS_DATABASE_DIALECT: 'sqlite3' # Can use either 'sqlite3' or 'mysql'.
            PUSHBITS_ADMIN_MATRIXID: '@your/matrix/username:matrix.org' # The matrix account on which the admin will receive their notifications.
            PUSHBITS_ADMIN_PASSWORD: 'your/matrix/password' # The login password of the admin for PushBits. Default username is 'admin'.
            PUSHBITS_MATRIX_USERNAME: 'your/pushbits/username' # The matrix account from which PushBits notifications are sent to users.
            PUSHBITS_MATRIX_PASSWORD: 'your/pushbits/password' # The password of the above account.
        volumes:
            - /etc/localtime:/etc/localtime:ro
            - /etc/timezone:/etc/timezone:ro
            - ./mount/data:/data

Now, how can you interact with the server? At the time of writing, there is no fancy GUI built-in. I don't do much front end development myself, so if you want to contribute in this regard I'm happy if you reach out!

Anyway, I wrote a little CLI tool to make basic API requests to the server. It helps you to create new users and applications. You will find further instructions in the linked repository.

Development

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

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

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.