commafeed v0.1.0

Bookmarks & RSS

CommaFeed — a fast, Google Reader-style RSS/Atom feed reader with a clean web UI and mobile apps. Uses an embedded H2 database, so it runs as a single container. Deployed as a single host-networked Nomad service.

nomad-pack run commafeed --registry nomploy

…or one line (add registry + run)

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

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

Source ↗ Project ↗ ★ 3.6k ⚑ Report an issue

1 task http 8082 1 volume image athou/commafeed:latest-h2 pinned :latest-h2 image bumped today

Variables 8

values.hcl

Save as values.hcl, edit, then run:

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

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

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

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

# The CommaFeed container image. Pin a tag in production.
image = "athou/commafeed:latest-h2"

# Host port for the CommaFeed web UI.
port = 8082

# Named volume mounted at /root/.local/share/commafeed.
data_volume = "commafeed_data"

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

# The task resources.
resources = {
    cpu    = 500
    memory = 512
  }

Name	Type	Default	Description
job_name	string	"commafeed"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"athou/commafeed:latest-h2"	The CommaFeed container image. Pin a tag in production.
port	number	8082	Host port for the CommaFeed web UI.
data_volume	string	"commafeed_data"	Named volume mounted at /root/.local/share/commafeed.
constraints	list	[]	Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources	object	{ cpu = 500 memory = 512 }	The task resources.

Back up this pack

This pack stores data in one Docker named volume: commafeed_data

restic

# Run on the node hosting this pack. Point restic at your repo first:
#   export RESTIC_REPOSITORY="s3:https://<account>.r2.cloudflarestorage.com/<bucket>"
#   export RESTIC_PASSWORD="<repo-password>"
#   export AWS_ACCESS_KEY_ID=<key>  AWS_SECRET_ACCESS_KEY=<secret>
restic backup \
  /var/lib/docker/volumes/commafeed_data/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/commafeed_data/_data backup:<bucket>/commafeed_data

Paths assume the default Docker volume location (/var/lib/docker/volumes). Restore by stopping the job, restoring files into the same volume, and re-running the pack.

Readme

commafeed

CommaFeed — a fast, Google Reader-style RSS/Atom feed reader. Keyboard-driven, with categories, tags, starred items, full-text scraping and mobile apps. This pack uses the embedded H2 database, so it runs as a single self-contained container — no external database to manage.

Single host-networked Nomad service with a persistent data volume.

Deploy

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

Configure

Variable	Default	Description
`port`	`8082`	Web UI port (`QUARKUS_HTTP_PORT`).
`image`	`athou/commafeed:latest-h2`	Container image (embedded H2). Pin a tag in production.
`data_volume`	`commafeed_data`	`/root/.local/share/commafeed` — the H2 database.
`resources`	`{ cpu = 500, memory = 512 }`	Task resources. The JVM needs some headroom.

The first account you create becomes the admin (self-registration can be disabled afterwards in settings). For a large multi-user instance, switch to the latest-postgresql image and point it at an external database. Pin the job to the node holding the volume with constraints.