Skip to content

A kustomize based deployment of listmonk and k8s cronjobs to enable easy rss to email capabilities for large numbers of feeds/users

License

Notifications You must be signed in to change notification settings

wagov-dtt/rssmonk

Repository files navigation

RSS Monk

RSS Monk turns RSS feeds into email newsletters.

Quick Start

just prereqs  # Install k3d, kubectl, scc, uv
just start    # Deploy RSS Monk on k3d cluster
just feeds add-feed https://www.abc.net.au/news/feed/10719986/rss.xml daily

New content arrives automatically as emails.

Common Tasks

Managing Your Feeds

# See all your feeds
just feeds list-feeds

# Add a new feed (daily emails)
just feeds add-feed https://www.abc.net.au/news/feed/10719986/rss.xml daily

# Add a feed with frequent updates
just feeds add-feed https://www.abc.net.au/news/feed/10719986/rss.xml 5min

# Add a weekly digest
just feeds add-feed https://www.abc.net.au/news/feed/10719986/rss.xml weekly

Checking Status

# Is everything running?
just status

# What's happening behind the scenes?
just logs

# Test a specific feed
just test-fetch daily

Maintenance

# Stop everything (removes k3d cluster)
just clean

# Start fresh
just clean && just start

Examples

# ABC News (daily)
just feeds add-feed https://www.abc.net.au/news/feed/10719986/rss.xml daily

# ABC News (weekly digest)
just feeds add-feed https://www.abc.net.au/news/feed/10719986/rss.xml weekly

# ABC News (frequent updates)
just feeds add-feed https://www.abc.net.au/news/feed/10719986/rss.xml 5min

Web Interface

Installation Requirements

  • k3d, kubectl, scc, uv (installed via just prereqs)

Development

just test && just lint

About

A kustomize based deployment of listmonk and k8s cronjobs to enable easy rss to email capabilities for large numbers of feeds/users

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published