This is a small web application to deliver RSS feeds
built by html2rss
via HTTP.
Features:
- serves your own feeds: set up your feed configs in a YAML file. See
html2rss
' README for documentation. - comes with all
html2rss-configs
included. - handles caching and HTTP Cache-Headers.
This web application is distributed in a rolling release
fashion from the master
branch.
Build the URL like this:
The feed config you'd like to use:
lib/html2rss/configs/domainname.tld/whatever.yml
β β β β β β β β β β β β β β β β β β β β β β^^^^^^^^^^^^^^^^^^^^^^^^^^^
The corresponding URL:
http://localhost:3000/domainname.tld/whatever.rss
β β β β β β β β β β β β β β β β β β β β β β ^^^^^^^^^^^^^^^^^^^^^^^^^^^
π See file list of all html2rss-configs
.
Install Docker CE and docker run -d -p 3000:3000 gilcreator/html2rss-web
.
To use your private feed configs, mount a feed.yml
into the /app/config/
folder.
docker run -d --name html2rss-web \
--mount type=bind,source="/path/to/your/config/folder,target=/app/config" \
-p 3000:3000 \
gilcreator/html2rss-web
A primitive way to automatically update your Docker instance is to set up this script as a cronjob:
#!/bin/bash
set -e
docker pull -q gilcreator/html2rss-web
(docker stop html2rss-web && docker rm html2rss-web) || :
docker run -d --name html2rss-web --restart=always -p 3000:3000 \
--mount type=bind,source="/home/deploy/html2rss-web/config,target=/app/config" \
gilcreator/html2rss-web
The cronjob for updating every 30 minutes could look like this:
*/30 * * * * /home/deploy/html2rss-web/update > /dev/null 2>&1
Since this repository receives updates frequently, you'd need to update your instance yourself.
- Install Ruby
>= 2.6
. gem install bundler foreman
bundle
foreman start
html2rss-web now listens on port 5000 for requests.
Websites often change their markup. To get notified when one of your own configs
break, use the /health_check.txt
endpoint.
It will respond with success
if your feeds are generatable.
Otherwise it will not print success
, but states the broken config names.