Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/whtsky/fulltextrssplz
Make rss full text.
https://github.com/whtsky/fulltextrssplz
rss rss-feed
Last synced: 2 months ago
JSON representation
Make rss full text.
- Host: GitHub
- URL: https://github.com/whtsky/fulltextrssplz
- Owner: whtsky
- Created: 2020-06-26T15:26:57.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-11T20:26:34.000Z (10 months ago)
- Last Synced: 2024-04-12T00:52:09.532Z (10 months ago)
- Topics: rss, rss-feed
- Language: TypeScript
- Homepage: https://fulltextrssplz.whtsky.me/
- Size: 2.92 MB
- Stars: 27
- Watchers: 3
- Forks: 5
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# fulltextrssplz
Make RSS full text.
## Example
Full-text version of [UN News](https://news.un.org/feed/subscribe/en/news/all/rss.xml): https://fulltextrssplz.whtsky.me/feed?url=https://news.un.org/feed/subscribe/en/news/all/rss.xml&format=RSS
## Start Server
### PaaS
[](https://heroku.com/deploy?template=https://github.com/whtsky/fulltextrssplz)
### with Docker
```bash
docker run --restart=always -p 127.0.0.1:3000:80 -e MAX_ITEMS_PER_FEED=5 -d ghcr.io/whtsky/fulltextrssplz:master
```
### without Docker
```bash
# install dependencies
yarn
# build frontend codes
yarn build
# start in public mode -- everyone can use
yarn start
# start in protected mode -- only users with key can use
## generate key for signing url
yarn gen_key
KEYS=[,] yarn start
```
## Usage
An example request looks like:
```
http://localhost:3000/feed?format=rss&url=[&sign=][&max_items=1]
```
Params are:
- `format`: Output in which format. Can be `rss` or `json`
- `url`: URL to original feed
- `sign`: required for protected mode. hexadecimal HMAC signature of the feed url
- `max_items`: max items for this feed. Can't be greater than `MAX_ITEMS_PER_FEED` environment variable.
You can get sign using
```bash
yarn sign
```
## Environment Variables
| name | description | default value |
| -------------------: | ---------------------------------------------------------------: | ------------: |
| HOSTNAME | hostname HTTP server listens to | `0.0.0.0` |
| PORT | port HTTP server listens to | `3000` |
| KEYS | comma-seperated signing keys. Leave empty to run in public mode | `` |
| MAX_ITEMS_PER_FEED | max items per feed | `3` |
| CACHE_CONTROL_MAXAGE | Set max age in `Cache-Control` header. Use `0` to disable cache. | `1800` |
| CACHE_MODE | `redis` for cache with redis, other values means disable cache | `` |
| REDIS_URL | URL for redis | `` |
| CACHE_TTL | Cache TTL | `` |