You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-16Lines changed: 20 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,17 @@
1
1
# github-ntfy-bridge
2
2
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.
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.
4
7
5
8
## Features
6
9
7
10
-**Duplicate Prevention:** Uses SQLite to track `thread_id` and `updated_at`.
8
11
-**Rich Notifications:** Includes emojis, tags, and priorities based on notification types (Pull Request, Issue, Release, Security, etc.).
9
12
-**Interactive Actions:** Direct "Open on GitHub" buttons in the notification (where supported by ntfy clients).
10
13
-**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.
12
15
13
16
## Prerequisites
14
17
@@ -29,9 +32,10 @@ The easiest way to run the bridge is using the official Docker image:
29
32
```bash
30
33
docker run -d \
31
34
--name github-ntfy-bridge \
35
+
--restart always \
36
+
-v $(pwd)/data:/app/data \
32
37
-e GH_TOKEN=your_github_pat \
33
38
-e NTFY_URL=https://ntfy.sh/your_topic \
34
-
-v $(pwd)/data:/app/data \
35
39
nurefexc/github-ntfy-bridge:latest
36
40
```
37
41
@@ -52,7 +56,7 @@ To make this work, you need to add the following **Secrets** to your GitHub repo
52
56
-`DOCKERHUB_USERNAME`: Your Docker Hub username.
53
57
-`DOCKERHUB_TOKEN`: Your Docker Hub Personal Access Token (PAT).
54
58
55
-
### Option 2: Manual Installation
59
+
### Option 3: Manual Installation (Native)
56
60
57
61
1. Install dependencies:
58
62
```bash
@@ -80,18 +84,18 @@ The following environment variables are supported:
80
84
## Notification Types Supported
81
85
82
86
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.
0 commit comments