From 6792249a0b6912e38be635dd111acaed46afcc6f Mon Sep 17 00:00:00 2001 From: orion Date: Wed, 25 Feb 2026 14:08:15 +0000 Subject: [PATCH] docs: add no-docker-first run modes and quick start --- README.md | 17 ++++++++++++++++- docs/RUN_MODES.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 docs/RUN_MODES.md diff --git a/README.md b/README.md index bd8e78f..923ec36 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,26 @@ The no-reply provider returns `NO_REPLY` for any input. - `plugin/` — OpenClaw plugin (before_model_resolve hook) - `no-reply-api/` — OpenAI-compatible minimal API that always returns `NO_REPLY` -- `docs/` — rollout and configuration notes +- `docs/` — rollout, integration, run-mode notes - `scripts/` — smoke/dev/helper checks - `Makefile` — common dev commands (`make check`, `make check-rules`, `make test-api`, `make up`) - `CHANGELOG.md` — milestone summary +## Quick start (no Docker) + +```bash +cd no-reply-api +node server.mjs +``` + +Then render config snippet: + +```bash +node scripts/render-openclaw-config.mjs +``` + +See `docs/RUN_MODES.md` for Docker mode. + --- ## Development plan (incremental commits) diff --git a/docs/RUN_MODES.md b/docs/RUN_MODES.md new file mode 100644 index 0000000..57957e9 --- /dev/null +++ b/docs/RUN_MODES.md @@ -0,0 +1,35 @@ +# Run Modes + +WhisperGate has two runtime components: + +1. `plugin/` (OpenClaw plugin) +2. `no-reply-api/` (deterministic NO_REPLY service) + +Docker is optional. + +## Mode A (recommended): No Docker + +```bash +cd no-reply-api +node server.mjs +``` + +Then configure OpenClaw provider `baseURL` to `http://127.0.0.1:8787/v1`. + +## Mode B: Docker + +```bash +./scripts/dev-up.sh +# or: docker compose up -d --build whispergate-no-reply-api +``` + +Stop: + +```bash +./scripts/dev-down.sh +``` + +## Security notes + +- Bind API to loopback/private network. +- If exposed beyond localhost, set `AUTH_TOKEN`.