openring-rs is a tool for generating a webring from Atom/RSS feeds, so you can populate a template with articles from those feeds and embed them in your own blog. An example template is provided in in.html.

This is a Rust-port of Drew DeVault's openring, with the primary differences being:

• we respect throttling and send conditional requests by default via caching (disable with --no-cache)
• the template is written using Tera and is provided as an argument, not read from stdin
• we show a little progress bar
• we fetch all feeds concurrently
• we provide better error messages (via miette)
• we allow filtering feeds with --before

To see this in action, you can look at the footer of this blog post.

https://luke.hsiao.dev/blog/openring-rs/

cargo install --locked openring

Or, if you use cargo-binstall:

cargo binstall openring

On Arch Linux, install from the AUR using your preferred helper (e.g. paru or yay):

paru -S openring-rs       # builds from source
paru -S openring-rs-bin   # prebuilt binary

Both packages provide the openring binary and conflict with the original Go-based openring AUR package, so only one may be installed at a time.

A webring for static site generators written in Rust

Usage: openring [OPTIONS] --template-file <FILE>

Options:
  -n, --num-articles <NUM_ARTICLES>    Total number of articles to fetch [default: 3]
  -p, --per-source <PER_SOURCE>        Number of most recent articles to get from each feed [default: 1]
  -S, --url-file <FILE>                File with URLs of Atom/RSS feeds to read (one URL per line, lines starting with '#' or "//" are ignored)
  -t, --template-file <FILE>           Tera template file
  -s, --url <URL>                      A single URL to consider (can be repeated to specify multiple)
  -b, --before <BEFORE>                Only include articles before this date (in YYYY-MM-DD format)
      --no-cache                       Do NOT use request cache stored on disk
      --max-cache-age <MAX_CACHE_AGE>  Discard all cached requests older than this duration [default: 30d]
  -v, --verbose...                     Increase logging verbosity
  -q, --quiet...                       Decrease logging verbosity
  -h, --help                           Print help (see more with '--help')
  -V, --version                        Print version

The templates supported by openring-rs are written using Tera. Please refer to the Tera documentation for details.

We use OS-standard locations for caching.

• Linux: $XDG_CACHE_HOME/openring/cache.json or $HOME/.cache/openring/cache.json
• macOS: $HOME/Library/Caches/dev.hsiao.openring/cache.json
• Windows: {FOLDERID_LocalAppData}\hsiao\openring\cache\cache.json

The cache file is simple JSON.

The cache only prevents refetching a feed if the feed source responds with a 429. In this case, we respect Retry-After, or default to 4 hours. Otherwise, we use the cache to send conditional requests by respecting the ETag and Last-Modified headers.

Just for fun.