Skip to content

Commit 6862885

Browse files
committed
docs(nodes): add openclaw.json config example to Nodes overview
The /nodes page references several config keys (gateway.nodes.allowCommands, gateway.nodes.pairing.autoApproveCidrs, tools.exec.host, etc.) but never shows a consolidated example. Add a Config section with a commented json5 snippet covering gateway.nodes and tools.exec settings, plus a per-agent exec node override example. Fixes #92662
1 parent 4cf4e54 commit 6862885

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

docs/nodes/index.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,54 @@ permission boundary. Dangerous plugin node commands still require explicit
214214
After a node changes its declared command list, reject the old device pairing
215215
and approve the new request so the gateway stores the updated command snapshot.
216216

217+
## Config (`openclaw.json`)
218+
219+
Node-related settings live under `gateway.nodes` and `tools.exec`:
220+
221+
```json5
222+
{
223+
gateway: {
224+
nodes: {
225+
// Auto-approve first-time node pairing from trusted networks (CIDR list).
226+
// Disabled when unset. Only applies to first-time role:node requests
227+
// with no requested scopes; does not auto-approve upgrades.
228+
pairing: {
229+
autoApproveCidrs: ["192.168.1.0/24"],
230+
},
231+
// Opt into dangerous/privacy-heavy node commands (camera.snap, etc.).
232+
allowCommands: ["camera.snap", "screen.record"],
233+
// Block commands even if platform defaults allow them.
234+
denyCommands: [],
235+
},
236+
},
237+
tools: {
238+
exec: {
239+
// Default exec host: "node" routes all exec calls to a paired node.
240+
host: "node",
241+
// Security mode for node exec: "allowlist" requires explicit approval.
242+
security: "allowlist",
243+
// Pin exec to a specific node (id or name). Omit to allow any node.
244+
node: "build-node",
245+
},
246+
},
247+
}
248+
```
249+
250+
Per-agent exec node override:
251+
252+
```json5
253+
{
254+
agents: {
255+
list: [
256+
{
257+
id: "main",
258+
tools: { exec: { node: "build-node" } },
259+
},
260+
],
261+
},
262+
}
263+
```
264+
217265
## Screenshots (canvas snapshots)
218266

219267
If the node is showing the Canvas (WebView), `canvas.snapshot` returns `{ format, base64 }`.

0 commit comments

Comments
 (0)