https://github.com/chyroc/greader
RSS service, providing api similar to google reader.
https://github.com/chyroc/greader
freshrss rss
Last synced: 9 months ago
JSON representation
RSS service, providing api similar to google reader.
- Host: GitHub
- URL: https://github.com/chyroc/greader
- Owner: chyroc
- License: apache-2.0
- Created: 2023-02-06T02:25:08.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T05:32:28.000Z (over 3 years ago)
- Last Synced: 2025-01-29T08:23:27.400Z (over 1 year ago)
- Topics: freshrss, rss
- Language: Go
- Homepage:
- Size: 338 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# greader
RSS service, providing api similar to google reader.
## Start Server
### By Docker
- **Run**
```bash
docker run -d \
-e MYSQL_HOST=xx \
-e MYSQL_USERNAME=root \
-e MYSQL_PASSWORD=your-password \
-e MYSQL_DATABASE=greader \
-e ADMIN_USERNAME=admin \
-e ADMIN_PASSWORD=greader-password \
-p 8081:8081 \
ghcr.io/chyroc/greader:latest
```
### By Docker Compose
- **Create `docker-compose.yml`**
```bash
curl -fsSL https://raw.githubusercontent.com/chyroc/greader/master/docker-compose.yaml > docker-compose.yml
``
```
- **Run**
```bash
docker-compose up -d
```
### By Binary
- **Install Binary**
```bash
go install github.com/chyroc/greader@latest
```
- **Run**
```bash
MYSQL_HOST=xx \
MYSQL_USERNAME=xx \
MYSQL_PASSWORD=xx \
MYSQL_DATABASE=xx \
ADMIN_USERNAME=admin \
ADMIN_PASSWORD=greader-password \
greader start
```
## RSS API
```text
/api/greader
```
## TODO
- [ ] Newsletter Address
- [ ] filter && action
- [ ] import && export opml file
## Ref
- https://ranchero.com/downloads/GoogleReaderAPI-2009.pdf
- https://github.com/Ranchero-Software/NetNewsWire/blob/mac-6.1.1b1/Account/Sources/Account/ReaderAPI/ReaderAPICaller.swift
- https://github.com/FreshRSS/FreshRSS/blob/1.20.2/p/api/greader.php