Skip to content

Latest commit

 

History

History
122 lines (90 loc) · 4.26 KB

README.md

File metadata and controls

122 lines (90 loc) · 4.26 KB
Raw

newsfrwdr

Checks inputs for new entries and forwards them to outputs (based on name/tag). For now, the only inputs it supports are rss feeds.

Inspired by: rss-forwarder

Supported outputs

  • custom command
  • discord webhook
  • discord bot
  • slack webhook
  • telegram bot

Usage

Docker

  • docker run -d -v "/path/to/config.toml:/config/config.toml" ghcr.io/rdk31/newsfrwdr:master

Command line

Usage: newsfrwdr [OPTIONS]

Optional arguments:
  -h, --help           print help message
  -c, --config CONFIG  alternative path to config.toml

Configuration

Example configuration:

[inputs.rust-blog]
url = "https://blog.rust-lang.org/feed.xml"

[inputs.github-blog]
url = "https://github.blog/all.atom"
tags = ["it"]

[[outputs.default]]   # default output
type = "discord_webhook"
url = "https://discord.com/api/webhooks/abcd..."

[[outputs.rust-blog]] # name output
type = "discord_bot"
token = "token"
user_id = 123456789

[[outputs.it]]        # tag output
type = "discord_webhook"
url = "https://discord.com/api/webhooks/ijkl..."

[[outputs.it]]        # forward the same tag to another channel
type = "custom"
command = "notify-send"

[[outputs.github-blog]]
type = "slack"
url = "https://hooks.slack.com/services/..."

Inputs

Field Type Required Default Description
key string yes - input name
url string yes - url to the feed
interval string no "30m" feed refresh interval
retry_limit int no 10 feed fetch retry limit
tags [string] no ["default"] array of tags

Outputs

discord_webhook type

Field Type Required Default Description
key string yes - input name or tag to forward
type string yes - output type
url string yes - discord webhook url

discord_bot type

Field Type Required Default Description
key string yes - input name or tag to forward
type string yes - output type
token string yes - discord bot token
user_id u64 yes - user id to push entries to

slack type

Field Type Required Default Description
key string yes - input name or tag to forward
type string yes - output type
url string yes - slack webhook url

custom type

Serializes entries to this json structure:

{
  "title": "title",
  "description": "description",
  "author": "null or string",
  "url": "url",
  "timestamp": "ISO 8601 string"
}
Field Type Required Default Description
key string yes - input name or tag to forward
type string yes - output type
command string yes - command to run
arguments [string] no [] command arguments
use_stdin bool no false - false - add the message to the arguments array
- true - push the message to stdin