docs: add no-docker-first run modes and quick start
This commit is contained in:
17
README.md
17
README.md
@@ -19,11 +19,26 @@ The no-reply provider returns `NO_REPLY` for any input.
|
|||||||
|
|
||||||
- `plugin/` — OpenClaw plugin (before_model_resolve hook)
|
- `plugin/` — OpenClaw plugin (before_model_resolve hook)
|
||||||
- `no-reply-api/` — OpenAI-compatible minimal API that always returns `NO_REPLY`
|
- `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
|
- `scripts/` — smoke/dev/helper checks
|
||||||
- `Makefile` — common dev commands (`make check`, `make check-rules`, `make test-api`, `make up`)
|
- `Makefile` — common dev commands (`make check`, `make check-rules`, `make test-api`, `make up`)
|
||||||
- `CHANGELOG.md` — milestone summary
|
- `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)
|
## Development plan (incremental commits)
|
||||||
|
|||||||
35
docs/RUN_MODES.md
Normal file
35
docs/RUN_MODES.md
Normal file
@@ -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`.
|
||||||
Reference in New Issue
Block a user