Skip to content

Commit ac1fc5f

Browse files
committed
Add Docker badges, improve README details, and enhance Docker run example
1 parent 4d3d2ad commit ac1fc5f

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

README.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# github-ntfy-bridge
22

3-
A lightweight Python script that polls GitHub for unread notifications and sends them to your [ntfy](https://ntfy.sh) topic. It uses a local SQLite database to track notifications and ensure you don't get duplicate alerts for the same event.
3+
[![Docker Hub](https://img.shields.io/docker/pulls/nurefexc/github-ntfy-bridge.svg)](https://hub.docker.com/r/nurefexc/github-ntfy-bridge)
4+
[![Docker Image Size](https://img.shields.io/docker/image-size/nurefexc/github-ntfy-bridge/latest)](https://hub.docker.com/r/nurefexc/github-ntfy-bridge)
5+
6+
A lightweight Python script that polls GitHub for unread notifications and sends them to your [ntfy](https://ntfy.sh) topic in real-time. It uses a local SQLite database to track notifications and ensure you don't get duplicate alerts for the same event.
47

58
## Features
69

710
- **Duplicate Prevention:** Uses SQLite to track `thread_id` and `updated_at`.
811
- **Rich Notifications:** Includes emojis, tags, and priorities based on notification types (Pull Request, Issue, Release, Security, etc.).
912
- **Interactive Actions:** Direct "Open on GitHub" buttons in the notification (where supported by ntfy clients).
1013
- **Customizable:** Configure sync interval, ntfy topic, and more via environment variables.
11-
- **Docker Ready:** Easy deployment using Docker.
14+
- **Docker Ready:** Easy deployment using Docker with official image.
1215

1316
## Prerequisites
1417

@@ -29,9 +32,10 @@ The easiest way to run the bridge is using the official Docker image:
2932
```bash
3033
docker run -d \
3134
--name github-ntfy-bridge \
35+
--restart always \
36+
-v $(pwd)/data:/app/data \
3237
-e GH_TOKEN=your_github_pat \
3338
-e NTFY_URL=https://ntfy.sh/your_topic \
34-
-v $(pwd)/data:/app/data \
3539
nurefexc/github-ntfy-bridge:latest
3640
```
3741

@@ -52,7 +56,7 @@ To make this work, you need to add the following **Secrets** to your GitHub repo
5256
- `DOCKERHUB_USERNAME`: Your Docker Hub username.
5357
- `DOCKERHUB_TOKEN`: Your Docker Hub Personal Access Token (PAT).
5458

55-
### Option 2: Manual Installation
59+
### Option 3: Manual Installation (Native)
5660

5761
1. Install dependencies:
5862
```bash
@@ -80,18 +84,18 @@ The following environment variables are supported:
8084
## Notification Types Supported
8185

8286
The bridge handles various GitHub notification types with custom icons and priorities:
83-
- 🔀 **Pull Requests** (Priority 4)
84-
- 📌 **Issues** (Priority 3)
85-
- 📦 **Releases** (Priority 5)
86-
- 🚨 **Security Vulnerabilities** (Priority 5)
87-
-**Check Suites / Failures** (Priority 4)
88-
- 💬 **Discussions** (Priority 3)
89-
- 💻 **Commits** (Priority 2)
90-
91-
Special handling:
92-
- **Mentions** are automatically upgraded to Priority 5 (Max) and tagged with a loudspeaker 📢.
93-
- **Review Requests** are set to Priority 4 and tagged with eyes 👀.
87+
- 🔀 **Pull Requests** (Priority 4) - New or updated pull requests.
88+
- 📌 **Issues** (Priority 3) - New issues or comments.
89+
- 📦 **Releases** (Priority 5) - New releases or tags.
90+
- 🚨 **Security** (Priority 5) - Repository vulnerability alerts.
91+
-**Failures** (Priority 4) - Check suite or run failures.
92+
- 💬 **Discussions** (Priority 3) - New discussions or comments.
93+
- 💻 **Commits** (Priority 2) - New commits.
94+
95+
**Special Handling:**
96+
- 📢 **Mentions** (Priority 5) - Automatically upgraded to Max priority.
97+
- 👀 **Review Requests** (Priority 4) - Tagged for immediate attention.
9498

9599
## License
96100

97-
MIT
101+
This project is available under the MIT license. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)