From ddcd9a78967d20f50d18df640058fa3b8a670014 Mon Sep 17 00:00:00 2001 From: eikendev Date: Sat, 8 Aug 2020 11:48:58 +0200 Subject: [PATCH] Describe required settings, reword README.md --- README.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ea90509..05f25b6 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,21 @@ ## 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. +It enables your services to send notifications via a simple web API, and delivers them to you through [Matrix](https://matrix.org/). +This is similar to what [PushBullet](https://www.pushbullet.com/), [Pushover](https://pushover.net/), and [Gotify](https://gotify.net/) offer, but a lot less complex. -The vision is to have compatibility with [Gotify](https://gotify.net/) on the sending side, while on the receiving side established services are used. +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](https://containrrr.dev/watchtower/) and [Jellyfin](https://jellyfin.org/)) as well as - receiving clients written for the messaging service can be reused. -For now, only the [Matrix protocol](https://matrix.org/) is supported, but support for different services like [Telegram](https://telegram.org/) 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. +### Why Matrix instead of X? -The idea for this software and most parts of the initial source are heavily inspired by [Gotify](https://gotify.net/). -Many thanks to [jmattheis](https://jmattheis.de/) for his well-structured code. +For now, only [Matrix](https://matrix.org/) is supported, but support for different services like [Telegram](https://telegram.org/) could be added in the future. +[WhatsApp](https://www.whatsapp.com/) and [Signal](https://signal.org/) 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 @@ -37,11 +40,11 @@ services: ports: - 8080:8080 environment: - PUSHBITS_DATABASE_DIALECT: 'sqlite3' - PUSHBITS_ADMIN_MATRIXID: '@your/matrix/username:matrix.org' - PUSHBITS_ADMIN_PASSWORD: 'your/matrix/password' - PUSHBITS_MATRIX_USERNAME: 'your/pushbits/username' - PUSHBITS_MATRIX_PASSWORD: 'your/pushbits/password' + 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 @@ -53,3 +56,8 @@ services: PushBits is currently in alpha stage. The API is neither stable, nor is provided functionality guaranteed to work. Stay tuned! 😉 + +## Acknowledgments + +The idea for this software and most parts of the initial source are heavily inspired by [Gotify](https://gotify.net/). +Many thanks to [jmattheis](https://jmattheis.de/) for his well-structured code.