Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/untitaker/mastodon-bookmark-rss

A small app to let you connect your mastodon bookmarks to your RSS reader.
https://github.com/untitaker/mastodon-bookmark-rss

bookmarks mastodon pinboard rss

Last synced: about 2 months ago
JSON representation

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

Awesome Lists containing this project

README

        

# 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](https://bookmark-rss.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
`` 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](docs/deploy.md).

## Running it locally

1. Clone this repository
2. Have Rust, Node and Yarn installed. I recommend [rustup](https://rustup.rs/)
for Rust and [Volta](https://volta.sh/) for installing both Node and Yarn.
3. Install [entr](http://eradman.com/entrproject/)
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`.