rss-bell's Introduction

RSS-Bell

Send notifications when RSS feeds have updates

Install

Docker Compose

version: '3'
services:
  rss-bell:
    image: keocheung/rss-bell                # Or ghcr.io/keocheung/rss-bell
    container_name: rss-bell
    volumes:
      - ./config.yaml:/config/config.yaml    # YAML config file location
    network_mode: bridge
    environment:
      - CONFIG_PATH=/config/config.yaml      # Optional. Default is ./config.yaml
      - HTTP_PROXY=http://127.0.0.1:9090     # Optional. Default is empty. Refer to https://golang.org/pkg/net/http/#ProxyFromEnvironment for more details
      - HTTPS_PROXY=http://127.0.0.1:9090    # Optional. Default is empty
      - NO_PROXY=example.com,192.168.0.0/16  # Optional. Default is empty
    restart: unless-stopped

Go install

go install github.com/keocheung/rss-bell@latest

Build from source

git clone https://github.com/keocheung/rss-bell
cd rss-bell
go build -o rss-bell .

Build Docker image from source

git clone https://github.com/keocheung/rss-bell
cd rss-bell
docker build -t rss-bell:latest .

Usage

RSS-Bell uses Shoutrrr as notification library. Please refer to Shoutrrr Docs for more details.

Config file example

app_notification_url: bark://:[email protected] # Shoutrrr URL for rss-bell itself. Please refer to https://containrrr.dev/shoutrrr/v0.8/
tasks:
  "RSSHub New Routes":
    name: RSSHub New Routes
    feed_url: https://rsshub.app/rsshub/routes
    cron: '*/30 * * * *' # For more supported expressions, please refer to https://pkg.go.dev/github.com/robfig/cron
    notification_url: bark://:[email protected] # Shoutrrr URL for feed items. Please refer to https://containrrr.dev/shoutrrr/v0.8/
    proxy: http://127.0.0.1:8081 # Optional. Default is from enviroment
    max_delay_in_second: 10 # Optional. If greater than 0, a random delay would be added to every check