HomeBox

v1.0.0

Home inventory and organization with photos, labels, and searchable items.

household by getarcaneapp

x-arcane:
  icon: https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/homebox.svg
  urls:
    - https://github.com/sysadminsmedia/homebox/blob/main/docs/src/content/docs/en/quick-start/install.mdx

services:
  homebox:
    image: ghcr.io/sysadminsmedia/homebox:latest
    restart: unless-stopped
    ports:
      - "${BIND_ADDRESS:-127.0.0.1}:${PORT:-3100}:7745"
    labels:
      com.getarcaneapp.arcane.icon: https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/homebox.svg
    environment:
      TZ: ${TZ:-Etc/UTC}
      HBOX_OPTIONS_ALLOW_REGISTRATION: ${ALLOW_REGISTRATION:-true}
      HBOX_AUTH_API_KEY_PEPPER: ${API_KEY_PEPPER:?Set a random API key pepper of at least 32 characters}
    volumes:
      - data:/data

volumes:
  data:

BIND_ADDRESS=127.0.0.1
PORT=3100
TZ=Etc/UTC
ALLOW_REGISTRATION=true
# Replace this example value before deployment; never use it in production.
API_KEY_PEPPER=change-me-use-a-long-random-secret-api_key_pepper

README

Home inventory and organization with photos, labels, and searchable items.

Copy .env.example to .env, replace every example secret with a unique generated value, adjust the settings, then deploy with docker compose up -d or import this template in Arcane. Open http://localhost:3100 on the Docker host. Ports bind to localhost by default; set BIND_ADDRESS to a trusted interface for LAN access, or use a reverse proxy with HTTPS.

Generate API_KEY_PEPPER with openssl rand -hex 32. Register the first account while access is restricted, then set ALLOW_REGISTRATION=false and recreate the container. Keep the pepper stable across upgrades.

Named volumes retain internal application state across container upgrades. Keep a backup before updating images; docker compose down -v deletes named volume data.

Upstream: installation and configuration.