archivebox v0.1.0

Bookmarks & RSS

ArchiveBox — a self-hosted web archiving tool that saves full snapshots (HTML, PDF, screenshot, media, WARC) of URLs, bookmarks and feeds so you keep your own permanent copy of the web. Deployed as a single host-networked Nomad service.

nomad-pack run archivebox --registry nomploy

…or one line (add registry + run)

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

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

Source ↗ Project ↗ ★ 28.6k ⚑ Report an issue

1 task http 8000 1 volume image archivebox/archivebox:latest tracks :latest image bumped today

Variables 11

values.hcl

Save as values.hcl, edit, then run:

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

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

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

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

# The ArchiveBox container image. Pin a tag in production.
image = "archivebox/archivebox:latest"

# Host port for the ArchiveBox web UI.
port = 8000

# Admin username created on first start.
admin_user = "admin"

# Admin password created on first start. CHANGE THIS.
admin_password = "archivebox_change_me"

# Comma-separated origins allowed to submit the admin login form (set to your public URL).
csrf_trusted_origins = "http://localhost:8000"

# Named volume for the archive, index and config (/data).
data_volume = "archivebox_data"

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

# The task resources. Archiving (headless Chrome) benefits from more memory.
resources = {
    cpu    = 1000
    memory = 2048
  }

Name	Type	Default	Description
job_name	string	"archivebox"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"archivebox/archivebox:latest"	The ArchiveBox container image. Pin a tag in production.
port	number	8000	Host port for the ArchiveBox web UI.
admin_user	string	"admin"	Admin username created on first start.
admin_password set me	string	"archivebox_change_me"	Admin password created on first start. CHANGE THIS.
csrf_trusted_origins	string	"http://localhost:8000"	Comma-separated origins allowed to submit the admin login form (set to your public URL).
data_volume	string	"archivebox_data"	Named volume for the archive, index and config (/data).
constraints	list	[]	Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources	object	{ cpu = 1000 memory = 2048 }	The task resources. Archiving (headless Chrome) benefits from more memory.

Back up this pack

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

rclone (sync to S3/R2)

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

archivebox

ArchiveBox is a powerful, self-hosted web archiving tool. Feed it URLs, browser bookmarks or RSS feeds and it saves complete, permanent snapshots in many formats at once — original HTML, a readable article, PDF, screenshot, WARC, media (via yt-dlp), git repos and more — building your own private, searchable copy of the web that outlives link rot.

This pack runs ArchiveBox as a single host-networked Nomad service.

Deploy

nomad-pack run archivebox --registry=nomploy \
  --var admin_password=$(openssl rand -hex 12) \
  --var csrf_trusted_origins=http://<node-ip>:8000

Open http://<node-ip>:8000 and log in, then start adding URLs.

Configuration

Variable	Default	Description
`image`	`archivebox/archivebox:latest`	Container image (pin a tag in production).
`port`	`8000`	Host port for the web UI.
`admin_user`	`admin`	Admin username created on first start.
`admin_password`	`archivebox_change_me`	Admin password — change this.
`csrf_trusted_origins`	`http://localhost:8000`	Origin(s) allowed for admin login.
`data_volume`	`archivebox_data`	Volume for the archive and index (`/data`).
`resources`	1000 MHz / 2048 MB	CPU and memory (headless Chrome wants memory).

The full archive, index database and config persist in data_volume.