Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/pocketrss/pocketrss-dashboard

PocketRSS - A powerful RSS aggregate server in 1 file.
https://github.com/pocketrss/pocketrss-dashboard

android chakra-ui desktop mastodon react rss rss-aggregator web

Last synced: about 17 hours ago
JSON representation

PocketRSS - A powerful RSS aggregate server in 1 file.

Host: GitHub
URL: https://github.com/pocketrss/pocketrss-dashboard
Owner: pocketrss
Created: 2022-10-14T03:03:01.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2023-03-15T06:58:01.000Z (almost 2 years ago)
Last Synced: 2024-04-13T20:58:15.193Z (10 months ago)
Topics: android, chakra-ui, desktop, mastodon, react, rss, rss-aggregator, web
Language: TypeScript
Homepage:
Size: 2.39 MB
Stars: 36
Watchers: 2
Forks: 5
Open Issues: 0
Metadata Files:
- Readme: README.MD

Awesome Lists containing this project

README

        # 
📱 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

```toml

[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](https://github.com/pocketrss/pocketrss-dasnboard/releases)

   from github

2. Uncompress downloaded file and open uncompressed directory

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

4. Run pocketrss server in terminal

   ```bash

   ./pocketrss_linux_amd64 serve

   ```

5. Look at [http://localhost:5000](http://localhost:5000) to see the dashboard.

## Screenshot

### Dashboard

- Home

![](/public/images/screenshots/dashboard_home.png?raw=true)

- Feeds

![](/public/images/screenshots/dashboard_feeds.png?raw=true)

- Entries

![](/public/images/screenshots/dashboard_entries.png?raw=true)

- Favorites

![](/public/images/screenshots/dashboard_favorites.png?raw=true)

### Clients

#### Android

- Tusky

![](/public/images/screenshots/client_tusky.jpg?raw=true)

#### Desktop

- Leaf

![](/public/images/screenshots/client_leaf.png?raw=true)

### Web

- [elk](https://github.com/elk-zone/elk) (**Recommend**)

![](/public/images/screenshots/client_elk.png?raw=true)

- [Pinafore](https://pinafore.social)

![](/public/images/screenshots/client_pinafore.png?raw=true)

## 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](https://github.com/pocketrss/pocketrss-dashboard/releases/tag/Tusky-debug-20220713)