Prerequisites

Make sure these are in place before you deploy with Docker Compose.

Host and tooling

• Linux host (x86_64).
• Docker Engine 20.10.x.
• docker compose 2.24+.

Resources

Use the sizing guidance in Deployment overview.

Network access

• A reachable host IP or hostname.
• Open inbound ports for users.

  • Default 3000 for the UI.
  • Default 8000 for API.
• If you use a reverse proxy, ensure it supports websockets.

Registry access

• Registry credentials for pulling Syntho images.
• Outbound network access from the host to the registry.

Registry credentials can expire.

If pulls fail, re-run docker login.

Treat deployment config as sensitive.

Common files contain secrets:

• Docker Compose: .env
• Kubernetes/Helm: values.yaml

Do not commit these files to Git.

Prefer one of these approaches:

• Inject values via your CI/CD secret store.
• Use Kubernetes Secrets (manualSecretName) or an external secrets operator.