https://github.com/cdn0x12/cf-fedi-timeline-rss-worker

Turn your home timeline in fediverse into a RSS feed in real-time. Powered by Cloudflare Workers.
https://github.com/cdn0x12/cf-fedi-timeline-rss-worker

akkoma bot cloudflare cloudflare-workers fediverse iceshrimp mastodon misskey pleroma rss sharkey timeline

Last synced: 3 months ago
JSON representation

Turn your home timeline in fediverse into a RSS feed in real-time. Powered by Cloudflare Workers.

• Host: GitHub
• URL: https://github.com/cdn0x12/cf-fedi-timeline-rss-worker
• Owner: cdn0x12
• License: agpl-3.0
• Created: 2023-11-23T03:47:51.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-28T09:04:42.000Z (7 months ago)
• Last Synced: 2024-12-23T03:41:29.342Z (4 months ago)
• Topics: akkoma, bot, cloudflare, cloudflare-workers, fediverse, iceshrimp, mastodon, misskey, pleroma, rss, sharkey, timeline
• Language: TypeScript
• Homepage:
• Size: 60.5 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fediverse Timeline RSS

Turn your home timeline in fediverse into a RSS feed in real-time. Powered by Cloudflare Workers.

[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/CDN18/cf-fedi-timeline-rss-worker)

## Note

1. Currently supports platforms compatible with Mastodon API (mastodon, gotosocial, pleroma, akkoma, hometown etc.) and Misskey API (misskey, firefish, iceshrimp, sharkey, catodon, foundkey etc.).

2. **The access_token is the credential for accessing your account. Any entity with the access_token can request the corresponding API on your behalf. It is strongly recommended that you deploy this project yourself, regularly check your account usage, and rotate your access_token periodically.**

3. Your RSS link contains your access_token, so do not share your RSS link with others. When using RSS reading applications, ensure that the application does not publicly disclose your RSS subscription link.

## Usage

1. Create an app in your instance settings and copy the access token. (Check the `read` scope)

2. Your RSS feed is:

   `https:///{software}/{instance_url}/{access_token}`

   or

   `https:///{instance_url}/{access_token}`

   Examples:

   - `https:///mastodon/mastodon.social/1234567890abcdef`

   - `https:///mastodon.social/1234567890abcdef`