Home

Awesome

fulltextrssplz

Make RSS full text.

Example

Full-text version of UN News: https://fulltextrssplz.whtsky.me/feed?url=https://news.un.org/feed/subscribe/en/news/all/rss.xml&format=RSS

Start Server

PaaS

Deploy To Heroku

with Docker

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

# 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=<your_key>[,<your_key_b>] yarn start

Usage

An example request looks like:

http://localhost:3000/feed?format=rss&url=<feed_url>[&sign=<your_sign>][&max_items=1]

Params are:

You can get sign using

yarn sign <your_key> <feed_url>

Environment Variables

namedescriptiondefault value
HOSTNAMEhostname HTTP server listens to0.0.0.0
PORTport HTTP server listens to3000
KEYScomma-seperated signing keys. Leave empty to run in public mode<emtpy>
MAX_ITEMS_PER_FEEDmax items per feed3
CACHE_CONTROL_MAXAGESet max age in Cache-Control header. Use 0 to disable cache.1800
CACHE_MODEredis for cache with redis, other values means disable cache<empty>
REDIS_URLURL for redis<empty>
CACHE_TTLCache TTL<empty>