Files
headquarter/deploy/README.md
T

1.2 KiB

Deploy Skeleton

This directory contains deployment-focused examples and environment templates for the Headquarter platform.

Files

File Purpose
portainer.env.example Environment variables for a Portainer-managed stack
traefik-labels.example.yml Reference Traefik labels for services and tool instances

Assumptions

  • An external Traefik reverse proxy is already running on the target Docker host.
  • Traefik is attached to a Docker network (default name: traefik).
  • The Traefik network is declared as external: true in compose overlays.
  • TLS termination and certificate resolution are handled by Traefik.

Usage

  1. Copy portainer.env.example to your secrets manager or Portainer environment configuration.
  2. Fill in all empty values (client IDs, secrets, database password, encryption key).
  3. Deploy the stack via Portainer using docker-compose.yml + docker-compose.traefik.yml.
  4. Tool subdomain labels will be generated dynamically in FN-006.

Traefik Network

Create the Traefik network if it does not exist:

docker network create traefik

Follow-up

Detailed deployment automation, dynamic labels for spawned tool containers, and CI/CD integration are planned in FN-006.