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
    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

• Website: https://mrqt.fr
• Twitter: @BreizhHardware
• Github: @BreizhHardware
• LinkedIn: @félix-marquet-5071bb167

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!