Nomploy Nomad Packs

← All packs

readeck v0.1.0

Apps

Readeck — a lightweight, self-hosted read-it-later and bookmark app: save a link and it stores a clean, readable copy of the article (text, images, and highlights) so it stays available forever. A modern Pocket alternative. Deployed as a host-networked Nomad service using SQLite with a persistent data volume.

nomad-pack run readeck --registry nomploy
…or one line (add registry + run)
curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- readeck

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

1 task http 8000 1 volume image codeberg.org/readeck/readeck:latest tracks :latest image bumped today
Variables 8
values.hcl

Save as values.hcl, edit, then run:

nomad-pack run readeck -f values.hcl --registry nomploy
# The name of the Nomad job.
job_name = "readeck"

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

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

# The Readeck container image. Pin a tag in production.
image = "codeberg.org/readeck/readeck:latest"

# Host port for the Readeck web UI (READECK_SERVER_PORT).
port = 8000

# Named volume for Readeck data (/readeck): the SQLite database and saved articles.
data_volume = "readeck_data"

# Placement constraints. Pin to the node holding the volume. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# Resources for the Readeck task.
resources = {
    cpu    = 300
    memory = 256
  }
NameTypeDefaultDescription
job_name string
"readeck"
The name of the Nomad job.
namespace string
"default"
The Nomad namespace to deploy into.
datacenters list
["*"]
The datacenters to deploy to.
image string
"codeberg.org/readeck/readeck:latest"
The Readeck container image. Pin a tag in production.
port number
8000
Host port for the Readeck web UI (READECK_SERVER_PORT).
data_volume string
"readeck_data"
Named volume for Readeck data (/readeck): the SQLite database and saved articles.
constraints list
[]
Placement constraints. Pin to the node holding the volume. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources object
{
    cpu    = 300
    memory = 256
  }
Resources for the Readeck task.
Back up this pack

This pack stores data in one Docker named volume: readeck_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/readeck_data/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/readeck_data/_data backup:<bucket>/readeck_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

readeck

Readeck — a lightweight, self-hosted read-it-later and bookmark app. Save a link and Readeck keeps a clean, readable copy of the article — text, images, and your highlights — so it stays available even if the original disappears. Organize with labels and collections; a modern Pocket alternative.

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

Deploy

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

Configure

Variable Default Description
port 8000 Web UI port (READECK_SERVER_PORT).
data_volume readeck_data /readeck — the SQLite database and saved articles.
image codeberg.org/readeck/readeck:latest Container image. Pin a tag in production.
resources { cpu = 300, memory = 256 } Task resources.

Create the admin account on first run, then save links via the web UI, the bookmarklet, or a browser extension. Articles are stored as clean readable copies in the data volume. Serves plain HTTP — front it with a reverse proxy for TLS. Pin the job to the node holding the volume with constraints.