mirror of https://github.com/BreizhHardware/ntfy_alerts.git synced 2026-05-09 00:07:06 +02:00

This project allow you to have notification about new github or docker hub release on ntfy, gotify and discord.

Rust 80.6%
JavaScript 9.6%
HTML 5.7%
Shell 3.1%
Dockerfile 1%

Find a file

Félix MARQUET 8550fb045c Merge pull request #22 from BreizhHardware/dev Update dependencies		2025-06-16 10:39:33 +02:00
.github	Update .github/workflows/dependabot-build.yml	2025-06-16 10:32:22 +02:00
src	Update src/database.rs	2025-06-15 17:53:47 +02:00
web	refactor(ci): simplify CI configuration by consolidating binary build steps and updating Dockerfile	2025-06-13 13:55:10 +02:00
.gitignore	refactor(ci): simplify CI configuration by consolidating binary build steps and updating Dockerfile	2025-06-13 13:55:10 +02:00
Cargo.lock	build(deps): bump reqwest from 0.11.27 to 0.12.20	2025-06-16 08:04:33 +00:00
Cargo.toml	build(deps): bump reqwest from 0.11.27 to 0.12.20	2025-06-16 08:04:33 +00:00
CHANGELOG.md	New Readme.md	2024-10-24 13:54:27 +00:00
CONTRIBUTION.md	docs: add CONTRIBUTION.md and update README.md with contribution guidelines	2024-12-23 12:29:18 +00:00
Dockerfile	refactor(ci): simplify CI configuration by consolidating binary build steps and updating Dockerfile	2025-06-13 13:55:10 +02:00
entrypoint.sh	refactor(rust): Rewrite everything in rust	2025-06-12 19:40:54 +02:00
LICENSE	Initial commit	2024-02-29 23:14:28 +01:00
nginx.conf	Update NGINX config with the new route	2024-10-21 16:17:13 +02:00
README.md	update(README): simplify Docker image description and remove unused DB_PATH entry	2025-06-16 09:28:45 +02:00
setup-notify.sh	Add the bash script for login and update the readme.md	2024-03-01 10:47:28 +01:00

README.md

Welcome to ntfy_alerts 👋

This project allows you to receive notifications about new GitHub or Docker Hub releases on ntfy, gotify, Discord and Slack. Implemented in Rust for better performance.

Installation

Docker (recommended)

Use our Docker image, which automatically supports amd64, arm64 and armv7:

services:
  github-ntfy:
    image: breizhhardware/github-ntfy:latest
    container_name: github-ntfy
    environment:
      - USERNAME=username # Required
      - PASSWORD=password # Required
      - NTFY_URL=ntfy_url # Required if ntfy is used
      - GHNTFY_TIMEOUT=timeout # Default is 3600 (1 hour)
      - GHNTFY_TOKEN= # Default is empty (Github token)
      - DOCKER_USERNAME= # Default is empty (Docker Hub username)
      - DOCKER_PASSWORD= # Default is empty (Docker Hub password)
      - GOTIFY_URL=gotify_url # Required if gotify is used
      - GOTIFY_TOKEN= # Required if gotify is used
      - DISCORD_WEBHOOK_URL= # Required if discord is used
      - SLACK_WEBHOOK_URL= # Required if Slack is used
    volumes:
      - /path/to/data:/data
    ports:
      - 80:80
    restart: unless-stopped

Manual Installation

Install Rust if needed

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Clone the repository

git clone https://github.com/BreizhHardware/ntfy_alerts.git
cd ntfy_alerts

Compile

cargo build --release

Run

./target/release/github-ntfy

Version Notes

v2.0: Complete rewrite in Rust for better performance and reduced resource consumption
v1.7.1: Stable Python version

Configuration

The GitHub token (GHNTFY_TOKEN) needs to have the following permissions: repo, read:org and read:user.

TODO

Add support for multi achitecture Docker images
Rework web interface
Add support for more notification services (Telegram, Matrix, etc.)
Add web oneboarding instead of using environment variables

Author

👤 BreizhHardware

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. But first, please read the CONTRIBUTION.md file.

Show your support

Give a ⭐️ if this project helped you!

README.md Unescape Escape