Welcome to ntfy_alerts 👋

This project allows you to receive notifications about new GitHub or Docker Hub releases on ntfy, gotify, and Discord.

Installation

To install the dependencies, run:

pip install -r requirements.txt

Usage

If you want to use the Docker image, you can use the following docker-compose file for x86_64:

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/github-ntfy:/github-ntfy/
    ports:
      - 80:80
    restart: unless-stopped

For arm64 this docker compose file is ok:

services:
  github-ntfy:
    image: breizhhardware/github-ntfy:arm64
    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/github-ntfy:/github-ntfy/
    ports:
      - 80:80
    restart: unless-stopped

For armV7 this docker compose is ok:

services:
  github-ntfy:
    image: breizhhardware/github-ntfy:armv7
    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/github-ntfy:/github-ntfy/
    ports:
      - 80:80
    restart: unless-stopped

GHNTFY_TOKEN is a github token, it need to have repo, read:org and read:user

Author

👤 BreizhHardware

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

Contribution

If you want to contribut, feel free to open a pull request, but first read the contribution guide!

TODO:

• Dockerize the ntfy.py
• Add the watched repos list as a parameter
• Add the application version as a database
• Add the watched repos list as a web interface
• Add Docker Hub compatibility
• Rework of the web interface
• Compatibility with Gotify
• Compatibility with Discord Webhook
• Compatibility and distribution for arm64 and armv7

Show your support

Give a ⭐️ if this project helped you!