Skip to content

Commit 843973c

Browse files
committed
docs: Add LLM API key setup to QUICKSTART and fix README model config
- QUICKSTART Step 3 now documents LLM API key configuration as a required step, with primary vs fallback provider explanation - Fix README model config snippet: "fallback"/"fast" → "fallbacks" array to match actual openclaw.json schema - Clarify that only the primary provider key is strictly required - Fix stale version 2.3.0 → 2.4.3 in QUICKSTART health check example
1 parent cd3428b commit 843973c

File tree

2 files changed

+27
-5
lines changed

2 files changed

+27
-5
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -189,8 +189,10 @@ Model format is `"provider/model-name"`. Example `openclaw.json` snippet:
189189
{
190190
"model": {
191191
"primary": "anthropic/claude-sonnet-4-5",
192-
"fallback": "openai/gpt-4o",
193-
"fast": "groq/llama-3.3-70b-versatile"
192+
"fallbacks": [
193+
"openai/gpt-4o",
194+
"groq/llama-3.3-70b-versatile"
195+
]
194196
}
195197
}
196198
```
@@ -224,12 +226,17 @@ Use hosted LLM providers (Anthropic, OpenAI, Groq, Google, Mistral, xAI, OpenRou
224226
| **Guide** | [Quick Start](#quick-start) below → configure API keys → start services |
225227

226228
```bash
227-
# Example: Claude + Groq fallback
228229
# In /etc/wazuh-autopilot/.env:
230+
# Primary provider (required — matches openclaw.json default)
229231
ANTHROPIC_API_KEY=sk-ant-...
232+
233+
# Fallback providers (optional — used when primary is unavailable)
234+
OPENAI_API_KEY=sk-...
230235
GROQ_API_KEY=gsk-...
231236
```
232237

238+
> Only the primary provider's API key is strictly required. The default `openclaw.json` uses `anthropic/claude-sonnet-4-5` as primary. If you change the primary model, set the corresponding provider's key.
239+
233240
### Path B: Local LLMs with Ollama (Air-Gapped)
234241

235242
> **Status: Functional with known limitations. Proceed with care.**

docs/QUICKSTART.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,22 @@ Edit the configuration file:
5454
sudo nano /etc/wazuh-autopilot/.env
5555
```
5656

57-
**Required settings:**
57+
**Required — LLM API Keys:**
58+
59+
At minimum, set the API key for your primary LLM provider. The default config uses Anthropic as primary with OpenAI and Groq as fallbacks:
60+
61+
```bash
62+
# Primary provider (required) — get key at https://console.anthropic.com/
63+
ANTHROPIC_API_KEY=sk-ant-...
64+
65+
# Fallback providers (optional but recommended for resilience)
66+
OPENAI_API_KEY=sk-... # https://platform.openai.com/
67+
GROQ_API_KEY=gsk-... # https://console.groq.com/
68+
```
69+
70+
> **Note**: Only the primary provider key is strictly required. Fallback providers are used when the primary is unavailable or rate-limited. If you customize `openclaw.json` to use a different primary (e.g., `openai/gpt-4o`), set that provider's key instead.
71+
72+
**Required — MCP Server Connection:**
5873

5974
```bash
6075
# MCP Server Connection
@@ -125,7 +140,7 @@ Expected response:
125140
```json
126141
{
127142
"status": "healthy",
128-
"version": "2.3.0",
143+
"version": "2.4.3",
129144
"mode": "bootstrap"
130145
}
131146
```

0 commit comments

Comments
 (0)