Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.9 KB

README.md

File metadata and controls

48 lines (32 loc) · 1.9 KB

mastodon-bookmark-rss

A small web service to let you connect your mastodon bookmarks to your RSS reader.

Save interesting posts found on Mastodon into your read-it-later list by using Mastodon's bookmark function.

Use the instance at woodland.cafe or explore the options for self-hosting below.

Linking behavior

Normally the generated RSS feed links to the respective bookmarked Mastodon post. However, if the Mastodon post itself contains a link to another website, the RSS item will use the link and title from that website, or rather from Mastodon's link preview.

The purpose of this is to allow automatic prefetching and saving of article content, which is a feature found in a few RSS readers such as Inoreader. In those cases Mastodon (and Twitter) is just being used as a glorified link aggregator.

The original Mastodon post URL and content is still stored in the RSS <content:encoded> tag, so that additional context can be recovered.

Feed limits

This tool is limited by design to fetch 20 bookmarks. It is mainly intended to automate adding new bookmarks to a reading list, not to provide a complete historical archive within an RSS reader. More could be added, but since there is no state management or caching in place, it could become inconsiderate towards the target Mastodon server to pull many items on every fetch of the feed.

Operating it yourself

Please see docs/deploy.md.

Running it locally

  1. Clone this repository
  2. Have Rust, Node and Yarn installed. I recommend rustup for Rust and Volta for installing both Node and Yarn.
  3. Install entr
  4. Run npm install && npm run dev to get a devserver at localhost:3000

To get a standalone release binary, run npm install && npm run build && cargo build --release.

License

MIT, see LICENSE.