pocketrss / pocketrss-dashboard

PocketRSS - A powerful RSS aggregate server in 1 file.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

πŸ“± PocketRSS

PocketRSS - A powerfull RSS aggregate server in 1 file compatible with Mastodon client and RSS client.

Features

PocketRSS is a powerfull RSS aggregate server in 1 file with XML and json APIs. It compatible RSS clients and mastodon clients.

  • ⚑️ 1 file and lower resource needed

  • πŸŒ€ 1 click running

  • βš›οΈ Easy to use

  • πŸ’¨ Elegant dashboard

  • 🐘 Compatible with mastodon clients

  • πŸ’Ž Compatible with RSS clients

  • πŸ”¨ Saving data, favorites etc in your own server

Getting Started

Docker

Create config file as below

[listen]
ip = "0.0.0.0"
port = 5000
pprof = false

[instance]
uri = "pocketrss.com"
websocket_endpoint = "wss://pocketrss.com"
enable_sensitive = false

[db]
name = "./pocketrss.db"

[sync]
enabled = true
interval = 10 # number as minute; ζ•°ε­—οΌŒε•δ½εˆ†ι’Ÿ

[logger]
level = "error"
docker run -itd --name pocketrss -p 5000:5000 -v /some/where/pocketrss.toml:/app/pocketrss.toml -v /some/where/pocketrss.db:/app/pocketrss.db leopku/pocketrss

menthion: remember to change /some/where to your actual path where you want to save config and database files.

Binary install

  1. Download newest release from github

  2. Uncompress downloaded file and open uncompressed directory

  3. Copy pocketrss.example.toml as pocketrss.toml

  4. Run pocketrss server in terminal

    ./pocketrss_linux_amd64 serve
  5. Look at http://localhost:5000 to see the dashboard.

Screenshot

Dashboard

  • Home

  • Feeds

  • Entries

  • Favorites

Clients

Android

  • Tusky

Desktop

  • Leaf

Web

  • elk (Recommend)

FAQ

  • Where is the RSS endpoint

    http[s]://your.server/rss

  • How can I visit my own server without SSL using Tusky.

    Using my modified version of Tusky. I can be found in release page

About

PocketRSS - A powerful RSS aggregate server in 1 file.


Languages

Language:TypeScript 93.4%Language:HTML 6.6%