Skip to content

Latest commit

 

History

History
93 lines (72 loc) · 4.35 KB

README.md

File metadata and controls

93 lines (72 loc) · 4.35 KB
Raw

rss-notifier

💬 Send RSS update notifications to Slack

Docker

docker run omrilotan/rss-notifier -- --interval 10 --webhook https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX --channel "#notifications-channel" --feeds https://www.githubstatus.com/history.rss,https://status.docker.com/pages/533c6539221ae15e3f000031/rss --log-level debug

NPX

npx rss-notifier --interval 10 --webhook https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX --channel "#notifications-channel" --feeds https://www.githubstatus.com/history.rss,https://status.docker.com/pages/533c6539221ae15e3f000031/rss --log-level debug

Docker with env vars

docker run -e INTERVAL=10 -e WEBHOOK=https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX -e CHANNEL="#notifications-channel" -e FEEDS=https://www.githubstatus.com/history.rss,https://status.docker.com/ ages/533c6539221ae15e3f000031/rss -e LOG-LEVEL=debug omrilotan/rss-notifier

or

export INTERVAL=10
export WEBHOOK=https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX
export CHANNEL="#notifications-channel"
export FEEDS=https://www.githubstatus.com/history.rss,https://status.docker.com/pages/533c6539221ae15e3f000031/rss
export LOG-LEVEL=debug

docker run -e INTERVAL -e WEBHOOK -e CHANNEL -e FEEDS -e LOG-LEVEL omrilotan/rss-notifier

and so on

CLI options

Name Config File Env Var Type Default
webhook webhook WEBHOOK Webhook address ✘
feeds feeds FEEDS Comma separated URLs ✘
interval interval INTERVAL Minutes Fifteen minutes
channel channel CHANNEL Webhook channel Default webhook channel
emoji emoji EMOJI Slack emoji :rolled_up_newspaper: ( 🗞 )
dry-run dryRun N/A Boolean no
log-level N/A LOG_LEVEL debug, verbose, info, warn, error, critical warn
log-format N/A LOG_FORMAT plain, json plain
config N/A CONFIG Config file None

Options preference order is: CLI argument (1st), Config File (2nd), Environment variable (3rd), default (where applicable)

Some options can not be configured in config file

How To Use

Interval

Run this as scheduled task, specify the interval in which you run it.

Examples:

If you are running a cron as */15 * * * * (each 15 minutes), set the interval argument to 15.

If you are running a cron as 0 9 */1 * * (every day at 09:00), set the interval argument to 1440 (60 * 24).

Feed(s)

The feed(s) is a list of one or more URLs.

Example:

If you want to "subscribe" to GitHub and Docker statuses set your feeds to both --feeds https://www.githubstatus.com/history.rss,https://status.docker.com/pages/533c6539221ae15e3f000031/rss

Yaml configuration

interval: 10
webhook: https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX
channel: "#notifications-channel"
feeds:
  - https://www.cloudflarestatus.com/history.atom
  - https://www.githubstatus.com/history.rss

Feed filter

You can add a filter to the feed. Only items including this substring in their title or content will be sent. Filters are case insensitive.

feeds:
  - https://www.cloudflarestatus.com/history.atom:
      include:
        - DNS
feeds:
  - https://www.cloudflarestatus.com/history.atom:
      exclude:
        - WARP