paperclip/docker
Evyatar Bluzer b287281940
docs: add inline comments to docker quickstart compose file (#2431)
## Problem

The quickstart docker-compose file was recently moved to
\`docker/docker-compose.quickstart.yml\` during the Docker
reorganization but still have zero inline comments. When new user copy
this file for self-hosting, they see variables like:
- \`BETTER_AUTH_SECRET\` - what is this? How to generate?
- \`PAPERCLIP_DEPLOYMENT_MODE: "authenticated"\` - what other modes
available?
- \`PAPERCLIP_DEPLOYMENT_EXPOSURE: "private"\` - what does private vs
public mean?
- \`OPENAI_API_KEY\` and \`ANTHROPIC_API_KEY\` - both required? Or just
one?

They have to go read DOCKER.md or other docs to understand each
variable.

## What I changed

Added inline YAML comments directly in the file:
- Header block with step-by-step quickstart commands (cd docker, export,
docker compose up)
- Section headers grouping LLM keys, deployment settings, and secrets
- Comment explaining each non-obvious variable with valid values
- Note about \`BETTER_AUTH_SECRET\` with openssl generation command
- Comment on the volume explaining what data it persist

No functional change - only YAML comments added.
2026-07-15 09:39:20 -05:00
..
agent-runtime build(agent-runtime): ship ripgrep in the base image (#8976) 2026-07-14 15:38:52 -07:00
hermes-gateway-smoke [codex] Add built-in Hermes adapters (#8543) 2026-06-26 16:04:58 -05:00
openclaw-smoke Add OpenClaw onboarding text endpoint and join smoke harness 2026-03-04 16:29:14 -06:00
quadlet chore(docker): improve base image and organize docker files 2026-04-01 11:36:27 +00:00
untrusted-review Add Docker setup for untrusted PR review in isolated containers 2026-03-15 14:30:53 -05:00
.env.aws.example docs: AWS ECS Fargate deployment runbook (#3897) 2026-04-27 08:41:47 -05:00
Dockerfile.onboard-smoke chore(docker): improve base image and organize docker files 2026-04-01 11:36:27 +00:00
docker-compose.quickstart.yml docs: add inline comments to docker quickstart compose file (#2431) 2026-07-15 09:39:20 -05:00
docker-compose.untrusted-review.yml chore(docker): improve base image and organize docker files 2026-04-01 11:36:27 +00:00
docker-compose.yml chore(docker): improve base image and organize docker files 2026-04-01 11:36:27 +00:00
ecs-task-definition.json docs: AWS ECS Fargate deployment runbook (#3897) 2026-04-27 08:41:47 -05:00