homebox v0.1.0

Productivity

HomeBox — a simple, fast home inventory and organization system: track your belongings, locations, labels, warranties, and attachments, with QR labels and CSV import. Deployed as a single host-networked Nomad service on SQLite with a persistent data volume.

nomad-pack run homebox --registry nomploy

…or one line (add registry + run)

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

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

Source ↗ Project ↗ ★ 7.6k ⚑ Report an issue

1 task http 7745 1 volume image ghcr.io/sysadminsmedia/homebox:latest tracks :latest image bumped 28 days ago

Variables 9

values.hcl

Save as values.hcl, edit, then run:

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

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

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

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

# The HomeBox container image. Pin a tag in production.
image = "ghcr.io/sysadminsmedia/homebox:latest"

# Host port for the HomeBox web UI (HBOX_WEB_PORT).
port = 7745

# Allow new users to self-register (HBOX_OPTIONS_ALLOW_REGISTRATION).
allow_registration = true

# Named volume for the SQLite database and uploads (/data).
data_volume = "homebox_data"

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

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

Name	Type	Default	Description
job_name	string	"homebox"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"ghcr.io/sysadminsmedia/homebox:latest"	The HomeBox container image. Pin a tag in production.
port	number	7745	Host port for the HomeBox web UI (HBOX_WEB_PORT).
allow_registration	bool	true	Allow new users to self-register (HBOX_OPTIONS_ALLOW_REGISTRATION).
data_volume	string	"homebox_data"	Named volume for the SQLite database and uploads (/data).
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 = 128 }	The task resources.

Back up this pack

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

rclone (sync to S3/R2)

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

homebox

HomeBox — a simple, fast home inventory and organization system: track belongings, locations, labels, warranties, and attachments, with QR labels and CSV import.

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

Deploy

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

Configure

Variable	Default	Description
`port`	`7745`	Web UI port (`HBOX_WEB_PORT`).
`allow_registration`	`true`	Allow user self-registration.
`data_volume`	`homebox_data`	`/data` — SQLite database + uploads.
`image`	`ghcr.io/sysadminsmedia/homebox:latest`	Image. Pin a tag in production.
`resources`	`{ cpu = 300, memory = 128 }`	Task resources.

Register the first account on first visit. Consider turning allow_registration off afterwards. Pin the job to the node holding the volume with constraints.