Skip to content
This repository was archived by the owner on Aug 27, 2026. It is now read-only.

Latest commit

 

History

64 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ntfyrr

A bridge between some services' webhook notifications to ntfy, for those that don't currently support ntfy natively.

Have the service send its default json payload as a webhook to ntfyrr, and ntfyrr will format it nicer and forward the notification to your ntfy instance.

Note: Seerr, successor to overseerr/jellyseerr, now has native ntfy.sh support: https://docs.seerr.dev/using-seerr/notifications/ntfy


Services supported

  • Overseerr
  • Maintainerr

Environment Variables to define when running ntfyrr

  • NTFY_URL (defaults to https://ntfy.sh)
  • LISTEN_PORT (defaults to 5000) - The port ntfyrr listens on inside the container, at the docker network level
  • OVERSEERR_TOPIC (defaults to overseerr)
  • OVERSEERR_URL (optional) - To provide a link in the notification to visit your overseerr instance
  • MAINTAINERR_TOPIC (defaults to maintainerr)
  • MAINTAINERR_URL (optional) - To provide a link in the notification to visit your maintainerr instance

Docker compose examples

Minimal
---
services:
  ntfyrr:
    image: docker.io/leukosaima/ntfyrr:latest
    container_name: ntfyrr
    environment:
      - OVERSEERR_TOPIC=my-ntfy-topic
    ports:
      - 50550:5000
    restart: unless-stopped
Self-hosted ntfy
---
services:
  ntfyrr:
    image: docker.io/leukosaima/ntfyrr:latest
    container_name: ntfyrr
    environment:
      - OVERSEERR_TOPIC=my-ntfy-topic
      - NTFY_URL=http(s)://my-ntfy-host:port
      - OVERSEERR_URL=http(s)//my-ovsr-host:port
    volumes:
      - /path/to/user-credentials.json:/run/secrets/user-credentials.json:ro
    ports:
      - 50550:5000
    restart: unless-stopped
user-credentials.json contents

For restricted topics

{
    "username": "your_username",
    "password": "your_password",
    "token": ""
}

OR

{
    "username": "",
    "password": "",
    "token": "your_token"
}

Auth via token will take precedence over username + password if all are defined.

Usage

Overseerr

Setup Webhook notifications in Overseerr using the default payload it provides. Use webhook URL http://ntfyrr:5000/overseerr within the same docker network, or http://<host-ip>:50550/overseerr within the LAN, for example.

Maintainerr

Setup Webhook notifications in Maintainerr using the default payload it provides. Use webhook URL http://ntfyrr:5000/maintainerr within the same docker network, or http://<host-ip>:50550/maintainerr within the LAN, for example.

About

Currently an Overseerr and Maintainerr webhook notification to ntfy helper service

Resources

Stars

5 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages