obeoneorg/rss-watcher repository overview

# Clone and configure
git clone https://github.com/obeone/rss-watcher.git
cd rss-watcher
cp config.example.yaml config.yaml
cp .env.example .env

# Edit .env with your Telegram credentials
# TELEGRAM_BOT_TOKEN=your_bot_token
# TELEGRAM_CHAT_ID=your_chat_id

# Launch (uses pre-built image)
docker compose up -d

# Or build locally
docker compose up -d --build

# Clone and setup
git clone https://github.com/obeone/rss-watcher.git
cd rss-watcher

# Create environment with uv
uv venv && source .venv/bin/activate
uv pip install .

# Configure
cp config.example.yaml config.yaml
export TELEGRAM_BOT_TOKEN="your_bot_token"
export TELEGRAM_CHAT_ID="your_chat_id"

# Run
rss-watcher -c config.yaml

# At least one notifier (telegram or simplex) is required
telegram:
  bot_token: "${TELEGRAM_BOT_TOKEN}"
  chat_id: "${TELEGRAM_CHAT_ID}"
  parse_mode: "HTML"  # or "Markdown"

simplex:  # optional, see SimpleX Chat section below
  websocket_url: "ws://simplex-chat:6225"  # via simplex-ws-proxy
  contacts: ["alice"]

defaults:
  check_interval: 300  # seconds between checks
  request_timeout: 30
  max_retries: 3
  media_dir: "media"  # optional, for video downloads

storage:
  database_path: "data/rss_watcher.db"

feeds:
  - name: "Tech News"
    url: "https://example.com/feed.xml"
    check_interval: 600  # override default
    notifiers: ["telegram"]  # optional: route to specific backends
    filters:
      keywords:
        include: ["python", "rust"]

filters:
  keywords:
    include: ["python", "rust"]  # Match if contains ANY
    exclude: ["spam", "ad"]      # Reject if contains ANY
    case_sensitive: false

filters:
  categories:
    include: ["tech", "programming"]
    exclude: ["offtopic"]
    case_sensitive: false

filters:
  authors:
    include: ["john", "jane"]
    exclude: ["bot"]
    case_sensitive: false

filters:
  regex:
    title: "^\\[IMPORTANT\\]"      # Match title pattern
    content: "release.*v[0-9]+"    # Match content pattern

defaults:
  proxy: "socks5://user:[email protected]:1080"

feeds:
  - name: "Private Feed"
    url: "https://example.com/private-feed.xml"
    cookies:
      session_id: "${RSS_SESSION_ID}"
      auth_token: "your-auth-token"

defaults:
  media_dir: "media"  # Global default

feeds:
  - name: "Video Feed"
    url: "https://example.com/videos.xml"
    media_dir: "videos/special"  # Override per feed
    media_all_entries: true      # Download from all entries, not just filtered

simplex:
  websocket_url: "ws://simplex-chat:6225"  # Docker Compose default (via proxy)
  contacts:
    - "alice"
    - "bob"
  groups:
    - "rss-alerts"
  connect_timeout: 10   # seconds (default: 10)
  message_timeout: 30   # seconds (default: 30)

docker compose up -d simplex-chat

# Stop the background service first (only one process can access the database)
docker compose stop simplex-chat

# Launch interactive CLI with the same volume
docker compose run --rm simplex-chat simplex-chat

# When done, restart the service
docker compose start simplex-chat

docker compose logs rss-watcher | grep -i simplex

# Download from https://github.com/simplex-chat/simplex-chat/releases
# Start with WebSocket server on port 5225
simplex-chat -p 5225

feeds:
  - name: "Public News"
    url: "https://example.com/feed.xml"
    # notifiers not set → sends to ALL configured backends (Telegram + SimpleX)

  - name: "Telegram Only"
    url: "https://example.com/telegram-feed.xml"
    notifiers: ["telegram"]

  - name: "SimpleX Only"
    url: "https://example.com/private-feed.xml"
    notifiers: ["simplex"]

rss-watcher [-h] [-c CONFIG] [-v]

Options:
  -h, --help            Show help message
  -c, --config CONFIG   Config file path (default: config.yaml)
  -v, --verbose         Enable debug logging

[Feed Name]
📰 Entry Title (linked)
👤 by Author Name
🏷️ #tag1 #tag2

Entry summary/content...

*[Feed Name]*
*Entry Title*
https://example.com/entry-link
_by Author Name_
#tag1 #tag2

Entry summary/content...

uv venv && source .venv/bin/activate
uv pip install -e ".[dev]"

flowchart TB
    A[config.yaml] --> B[RSSWatcher.start]

    B --> F1[Feed 1]
    B --> F2[Feed 2]
    B --> FN[Feed N]

    F1 & F2 & FN --> P1[Fetch]
    P1 --> P2[Filter]
    P2 --> P3[Dedupe]
    P3 --> P4[Download Media]
    P4 --> P5{Notifier Routing}
    P5 --> T[Telegram]
    P5 --> WS[simplex-ws-proxy :6225]
    WS --> S[SimpleX Chat CLI :5225]