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
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
- Start with the single-host helper path for Community evaluation or homelab rollout.
- Publish browser/API surfaces through a reverse proxy when remote access is needed.
- 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. - Set
GATEWAY_HOSTand manage gateway WireGuard UDP port from Dashboard (wg_listen_port). - For production, add TLS, secrets management, backups, and monitoring.
- The anonymous public Community distribution channel is not open yet; use an authorized checkout or published release bundle until that channel is available.