mirror of
https://github.com/nickyeoman/docker-compose-cookbooks.git
synced 2026-09-03 18:36:22 +00:00
document healthchecks as future feature, fix up openclaw_dev
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
@@ -10,6 +10,7 @@
|
||||
- Restart policy, image tag, and port are configurable via env vars with sensible defaults
|
||||
- New stacks: copy from `_docs/template-compose.md` and `_docs/template-readme.md`
|
||||
- Compose section order: `image` → `restart` → `volumes` → `environment` → `ports` → `networks` → `depends_on` → `healthcheck` → `labels` → `command` → `user`
|
||||
- Healthchecks are a future feature — do not add `healthcheck` blocks to stacks at this time (the section order above just reserves their place)
|
||||
- README section order: `Overview` → `Project Details` → `Getting Started` → `Environment Variable Notes` → `Volume Notes` → `Network Notes` → `Docker Run` → `Additional Notes / Gotchas` → `Dockhand Stack, Deploy from Git`
|
||||
- Every compose file must declare the external `proxy` network at the root level:
|
||||
```yaml
|
||||
|
||||
+27
-2
@@ -12,6 +12,12 @@ support, agent sandboxing, and extensible plugin system.
|
||||
- **Documentation:** [docs.openclaw.ai](https://docs.openclaw.ai)
|
||||
- **Reverse Proxy Port:** `18789`
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Copy `sample.env` and set `OPENCLAW_GATEWAY_TOKEN` (`openssl rand -hex 32`)
|
||||
2. Start the container: `docker compose up -d`
|
||||
3. Open http://localhost:18789 in your browser and sign in with the gateway token
|
||||
|
||||
## Environment Variable Notes
|
||||
|
||||
- `OPENCLAW_GATEWAY_TOKEN` — required shared secret for Control UI access.
|
||||
@@ -33,6 +39,24 @@ All three use `${VOL_PATH:-/data}/openclaw/` as the host base path.
|
||||
|
||||
Requires proxy network
|
||||
|
||||
## Docker Run
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name=openclaw \
|
||||
-e TZ=America/Vancouver \
|
||||
-e OPENCLAW_DISABLE_BONJOUR=1 \
|
||||
-e OPENCLAW_GATEWAY_TOKEN=change-me-to-a-random-secret \
|
||||
-p 18789:18789 \
|
||||
-v /data/openclaw/config:/home/node/.openclaw \
|
||||
-v /data/openclaw/workspace:/home/node/.openclaw/workspace \
|
||||
-v /data/openclaw/auth-secrets:/home/node/.config/openclaw \
|
||||
-v /etc/localtime:/etc/localtime:ro \
|
||||
--add-host host.docker.internal:host-gateway \
|
||||
ghcr.io/openclaw/openclaw:latest \
|
||||
node dist/index.js gateway --bind lan --port 18789
|
||||
```
|
||||
|
||||
## Additional Notes / Gotchas
|
||||
|
||||
- This is a `_dev` stack — experimental, not yet production-ready.
|
||||
@@ -41,8 +65,9 @@ Requires proxy network
|
||||
- Host-side AI providers (Ollama, LM Studio) are reachable at
|
||||
`http://host.docker.internal:<port>`.
|
||||
- CLI commands: `docker compose exec openclaw node dist/index.js <subcommand>`
|
||||
- Image includes built-in `HEALTHCHECK`; the compose file adds an explicit
|
||||
`curl`-based check.
|
||||
- No `healthcheck` block in the compose file — healthchecks are a future
|
||||
feature across this repo (see AGENTS.md). The image's built-in
|
||||
`HEALTHCHECK` still applies.
|
||||
|
||||
## Dockhand Stack, Deploy from Git
|
||||
|
||||
|
||||
@@ -6,3 +6,5 @@ OPENCLAW_GATEWAY_BIND=lan
|
||||
OPENCLAW_DISABLE_BONJOUR=1
|
||||
OPENCLAW_GATEWAY_TOKEN=change-me-to-a-random-secret
|
||||
TZ=America/Vancouver
|
||||
# Optional: OpenTelemetry collector URL
|
||||
# OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-collector:4318
|
||||
|
||||
Reference in New Issue
Block a user