HERALD

NAME

    herald - RSS-to-Email via SSH

FILE FORMAT

    Feed configs are plain text files with directives:

    =: email you@example.com       Recipient email address
    =: cron 0 8 * * *               Standard cron (5 fields)
    =: digest true                  Combine items (default: true)
    =: inline false                 Include content (default: false)
    => https://example.com/feed     RSS/Atom feed URL
    => https://blog.com/rss "Blog"  Feed with display name

    Example feeds.txt:
    =: email you@example.com
    =: cron 0 8 * * *
    =: digest true
    => https://dunkirk.sh/atom.xml
    => https://news.ycombinator.com/rss

COMMANDS

    ls                  List uploaded feed configs
    cat <file>          Display config file contents
    rm <file>           Delete a config file
    activate <file>     Reactivate a deactivated config
    deactivate <file>   Stop emails for a config
    run <file>          Manually trigger feed fetch and email
    logs                View recent delivery logs

EXAMPLES

    # Upload a config
    scp -P 2223 feeds.txt herald@herald.dunkirk.sh:

    # Get your fingerprint (for web dashboard)
    # Your dashboard will be at:
    # https://herald.dunkirk.sh/<fingerprint>
    ssh -p 2223 herald@herald.dunkirk.sh

    # Check status
    ssh -p 2223 herald@herald.dunkirk.sh ls

    # View config
    ssh -p 2223 herald@herald.dunkirk.sh cat feeds.txt

    # Manual run
    ssh -p 2223 herald@herald.dunkirk.sh run feeds.txt