rsshub v0.1.0

Bookmarks & RSS

RSSHub — an extensible RSS feed generator that creates feeds for thousands of sites that don't offer their own. Runs standalone with in-memory caching. Deployed as a single stateless host-networked Nomad service.

nomad-pack run rsshub --registry nomploy

…or one line (add registry + run)

curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- rsshub

Needs nomad-pack on PATH. The script only adds the nomploy registry and runs this pack.

Source ↗ Project ↗ ★ 46.3k ⚑ Report an issue

1 task http 1200 image diygod/rsshub:latest tracks :latest image bumped today

Variables 8

values.hcl

Save as values.hcl, edit, then run:

nomad-pack run rsshub -f values.hcl --registry nomploy

# The name of the Nomad job.
job_name = "rsshub"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The RSSHub container image. Pin a tag in production.
image = "diygod/rsshub:latest"

# Host port for the RSSHub web UI / feeds.
port = 1200

# Cache backend (CACHE_TYPE): "memory" (standalone, no dependencies) or "redis" (set REDIS_URL too). Keep "memory" for a single-container deploy.
cache_type = "memory"

# Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# The task resources.
resources = {
    cpu    = 300
    memory = 256
  }

Name	Type	Default	Description
job_name	string	"rsshub"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"diygod/rsshub:latest"	The RSSHub container image. Pin a tag in production.
port	number	1200	Host port for the RSSHub web UI / feeds.
cache_type	string	"memory"	Cache backend (CACHE_TYPE): "memory" (standalone, no dependencies) or "redis" (set REDIS_URL too). Keep "memory" for a single-container deploy.
constraints	list	[]	Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources	object	{ cpu = 300 memory = 256 }	The task resources.

Readme

rsshub

RSSHub — an extensible RSS feed generator. It builds clean RSS/Atom/JSON feeds for thousands of sites and services that don't offer their own (social media, forums, news, shopping, and much more), so you can follow anything from your favourite reader.

Single stateless host-networked Nomad service (in-memory cache; no Redis or headless browser needed).

Deploy

nomad-pack registry add nomploy https://github.com/Nomploy/nomad-packs
nomad-pack run rsshub --registry=nomploy

Configure

Variable	Default	Description
`port`	`1200`	Web UI / feeds port (`PORT`).
`cache_type`	`memory`	Cache backend (`CACHE_TYPE`): `memory` (standalone) or `redis`.
`image`	`diygod/rsshub:latest`	Container image. Pin a tag in production.
`resources`	`{ cpu = 300, memory = 256 }`	Task resources.

Browse available routes at http://<host>:1200. For a heavy multi-user instance, switch cache_type to redis (add REDIS_URL) and add browserless for routes that need a real browser — see the RSSHub docs. Feeds pair nicely with commafeed or miniflux. Being stateless, it needs no storage.