README updates

This commit is contained in:
lone-cloud 2026-01-22 20:34:27 -08:00
parent 75a9ddc56a
commit 7d40001e10
5 changed files with 9 additions and 3 deletions

View file

@ -1,10 +1,10 @@
<div align="center"> <div align="center">
<img src="assets/sup.webp" alt="SUP Icon" width="80" height="80" /> <img src="assets/sup.webp" alt="SUP Icon" width="120" height="120" />
# SUP # SUP
**SUP (Signal Unified Push) is a privacy-preserving push notification system using Signal as transport** **Privacy-preserving push notification system using Signal as transport**
[Setup](#setup) • [Real-World Examples](#real-world-examples) • [Architecture](#architecture) [Setup](#setup) • [Real-World Examples](#real-world-examples) • [Architecture](#architecture)
@ -34,6 +34,8 @@ For the optional Proton Mail integration, SUP requires a server that runs Proton
### 1. Install Android App (Optional) ### 1. Install Android App (Optional)
> ⚠️ **Early Alpha**: The Android app is currently unavailable, but is planned for the full release of SUP.
An Android app is optionally available to connect UnifiedPush Android apps to the SUP server. It can also provide a better experience for displaying SUP-based notifications if the `ENABLE_ANDROID_INTEGRATION` environment variable is enabled on the server. An Android app is optionally available to connect UnifiedPush Android apps to the SUP server. It can also provide a better experience for displaying SUP-based notifications if the `ENABLE_ANDROID_INTEGRATION` environment variable is enabled on the server.
Download the latest APK from [GitHub Releases](https://github.com/lone-cloud/sup/releases). Download the latest APK from [GitHub Releases](https://github.com/lone-cloud/sup/releases).
@ -46,6 +48,8 @@ Download the latest APK from [GitHub Releases](https://github.com/lone-cloud/sup
### 2. Proton Mail Integration (Optional) ### 2. Proton Mail Integration (Optional)
> ⚠️ **Early Alpha**: Currently only `docker-compose.dev.yml` dev deployments are available.
A Proton Mail Bridge is optionally available if you want to receive push notifications for incoming emails. A Proton Mail Bridge is optionally available if you want to receive push notifications for incoming emails.
> **Note:** The default Proton Mail Bridge image uses `shenxn/protonmail-bridge:build` which compiles from source and supports multiple architectures. For x86_64 systems, you can use `shenxn/protonmail-bridge:latest` (pre-built binary, smaller and faster). For ARM devices (Raspberry Pi), stick with `:build`. > **Note:** The default Proton Mail Bridge image uses `shenxn/protonmail-bridge:build` which compiles from source and supports multiple architectures. For x86_64 systems, you can use `shenxn/protonmail-bridge:latest` (pre-built binary, smaller and faster). For ARM devices (Raspberry Pi), stick with `:build`.
@ -94,6 +98,8 @@ Note that the bridge will first need to sync all of your old emails before you c
### 3. Install SUP Server ### 3. Install SUP Server
> ⚠️ **Early Alpha**: Currently only `docker-compose.dev.yml` dev deployments are available.
```bash ```bash
# Download docker-compose.yml # Download docker-compose.yml
curl -L -O https://raw.githubusercontent.com/lone-cloud/sup/master/docker-compose.yml curl -L -O https://raw.githubusercontent.com/lone-cloud/sup/master/docker-compose.yml
@ -168,7 +174,7 @@ docker compose -f docker-compose.dev.yml up protonmail-bridge
Receive instant Signal notifications when new emails arrive in your Proton Mail inbox. Receive instant Signal notifications when new emails arrive in your Proton Mail inbox.
SUP monitors your Proton Mail account via the local Proton Mail Bridge and forwards email alerts through Signal. This relies on the same technology that a third party email client like Thunderbird would be using to integrate with Proton Mail. SUP monitors your Proton Mail account via the local Proton Mail Bridge and forwards email alerts through Signal. This relies on the same technology that a third-party email client like Thunderbird would be using to integrate with Proton Mail.
### Home Assistant Alerts ### Home Assistant Alerts

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 5.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 7.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 8.5 KiB