Skip to content

setup

Interactive setup wizard that walks through initial homelab configuration.

Usage

sh
mithrandir setup

Description

Runs a multi-step interactive wizard that:

  1. Configures core settings (BASE_DIR, PUID/PGID, TZ)
  2. Lets you select which apps to install
  3. Validates required secrets (DuckDNS tokens, WireGuard config, etc.)
  4. Installs Docker if not present
  5. Generates docker-compose files and starts selected apps
  6. Saves all configuration to .env

Flags

FlagDescription
--yes, -ySkip confirmation prompts

Notes

  • Requires root privileges
  • Apps that require HTTPS (e.g., Vaultwarden) are skipped with a warning if ENABLE_HTTPS is not enabled