Overview

HomeCloud runs on your own infrastructure (K3s homelab or cloud) with a single apex domain (e.g. holab.abrdns.com).

Architecture at a glance

flowchart LR
  User --> Console[Console UI]
  User --> CLI[homecloud CLI]
  CLI --> SO[SO data plane]
  CLI --> MQ[MQ data plane]
  Console --> API[homecloud-api]
  API --> K8s[K3s workloads]
  SO --> MinIO[(MinIO)]
  MQ --> NATS[(JetStream)]

Authentication models

Console (JWT)Access Key (data plane)

Used for UI operations: create buckets, queues, IAM users, view billing.

homecloud login --username alice
homecloud queues list

Used for SO/MQ/Secrets runtime APIs — like AWS IAM access keys.

homecloud configure
# or per-command:
homecloud --access-key-id HCAK... --secret-access-key ... so ls my-bucket

Account ID is automatic

Access Keys are scoped to an account. The CLI resolves account_id automatically — you never pass it manually.

Next steps

1. Create an account
2. Generate an Access Key
3. Install the CLI