N
Nanami Docs
Browse docs
Browse docs
Browse docs

Docker and Compose overview

Understand the deployment files under /deploy and when to use each.

Section
Browse docs
Path
/deployment/docker-compose

Nanami ships deployment assets in the repository deploy/ directory.

Key files

| File | Use case | | --- | --- | | deploy/docker-compose.community-single-host.yml | Supported Community reference single-host package | | deploy/community-single-host.env.example | Supported Community environment template | | deploy/docker-compose.traefik.yml | Internal/reverse-proxy oriented deployment path for managed environments | | deploy/docker-compose.shared.yml | Shared docs and marketing service definitions | | deploy/community.env | Managed Community stack defaults for the internal deploy path | | deploy/saas.env | Managed SaaS stack defaults | | deploy/shared.env | Shared public web environment variables | | deploy/docker-compose.yml | Legacy local bootstrap helper; not the supported external Community install path |

Community reference example

bash
cp deploy/community-single-host.env.example deploy/community-single-host.env
scripts/community_single_host.sh validate-env
scripts/community_single_host.sh preflight
scripts/community_single_host.sh up

The supported Community path builds images from the current checkout by default with COMMUNITY_IMAGE_SOURCE=build. It must not require private GHCR pulls for first install.

Practical usage pattern

  1. Start with the single-host helper path for Community evaluation or homelab rollout.
  2. Publish browser/API surfaces through a reverse proxy when remote access is needed.
  3. Keep managed-environment compose files (community.env, saas.env, shared.env) separate from the public Community helper path.

Diagram (text)

community env template -> helper preflight -> local image build -> control plane + client app -> gateway-manager + gateway-daemon

Notes

  • Compose is the easiest starting point, not the only production pattern.
  • In COMMUNITY mode, gateway-daemon runs with network_mode: host.
  • Gateway services are global workers for the instance, not per-tenant services.
  • Configure gateway endpoint DNS with NANAMI_GATEWAY_ENDPOINT_DNS_MODE, NANAMI_DNS_GATEWAY_HOST_TEMPLATE, NANAMI_GATEWAY_PUBLIC_IP, and NANAMI_GATEWAY_ENDPOINT_PORT.
  • For production, add TLS, secrets management, backups, and monitoring.
  • Start from the Community release package or source bundle your organization provides; the standard helper builds local images from that source.