docs: note optional docker setup

This commit is contained in:
Peter Steinberger
2026-01-02 20:58:50 +01:00
parent 3104b088e4
commit 505c4262c6
4 changed files with 53 additions and 1 deletions

View File

@@ -20,7 +20,7 @@ It answers you on the surfaces you already use (WhatsApp, Telegram, Discord, iMe
If you want a private, single-user assistant that feels local, fast, and always-on, this is it. If you want a private, single-user assistant that feels local, fast, and always-on, this is it.
Website: https://clawd.me · Docs: [`docs/index.md`](docs/index.md) · FAQ: [`docs/faq.md`](docs/faq.md) · Wizard: [`docs/wizard.md`](docs/wizard.md) · Discord: https://discord.gg/qkhbAGHRBT Website: https://clawd.me · Docs: [`docs/index.md`](docs/index.md) · FAQ: [`docs/faq.md`](docs/faq.md) · Wizard: [`docs/wizard.md`](docs/wizard.md) · Docker (optional): [`docs/docker.md`](docs/docker.md) · Discord: https://discord.gg/qkhbAGHRBT
Preferred setup: run the onboarding wizard (`clawdis onboard`). It walks through gateway, workspace, providers, and skills. The CLI wizard is the recommended path and works on **macOS, Windows, and Linux**. Preferred setup: run the onboarding wizard (`clawdis onboard`). It walks through gateway, workspace, providers, and skills. The CLI wizard is the recommended path and works on **macOS, Windows, and Linux**.

49
docs/docker.md Normal file
View File

@@ -0,0 +1,49 @@
---
summary: "Optional Docker-based setup and onboarding for Clawdis"
read_when:
- You want a containerized gateway instead of local installs
- You are validating the Docker flow
---
# Docker (optional)
Docker is **optional**. Use it only if you want a containerized gateway or to validate the Docker flow.
## Quick start (recommended)
From the repo root:
```bash
./docker-setup.sh
```
This script:
- builds the image
- runs the onboarding wizard
- runs WhatsApp login
- starts the gateway via Docker Compose
It writes config/workspace on the host:
- `~/.clawdis/`
- `~/clawd`
## Manual flow (compose)
```bash
docker build -t clawdis:local -f Dockerfile .
docker compose run --rm clawdis-cli onboard
docker compose run --rm clawdis-cli login
docker compose up -d clawdis-gateway
```
## E2E smoke test (Docker)
```bash
scripts/e2e/onboard-docker.sh
```
## Notes
- Gateway bind defaults to `lan` for container use.
- Health check:
`docker compose exec clawdis-gateway node dist/index.js health --token "$CLAWDIS_GATEWAY_TOKEN"`

View File

@@ -17,6 +17,7 @@ Last updated: 2026-01-01
## Prereqs (from source) ## Prereqs (from source)
- Node `>=22` - Node `>=22`
- `pnpm` - `pnpm`
- Docker (optional; only for containerized setup/e2e — see `docs/docker.md`)
## Tailoring strategy (so updates dont hurt) ## Tailoring strategy (so updates dont hurt)

View File

@@ -23,6 +23,8 @@ Last run (2025-12-31, 20 runs):
## Onboarding E2E (Docker) ## Onboarding E2E (Docker)
Docker is optional; this is only needed for containerized onboarding smoke tests.
Full cold-start flow in a clean Linux container: Full cold-start flow in a clean Linux container:
```bash ```bash