{ "schemaVersion": "1.0", "item": { "slug": "openclaw-config-reference", "name": "OpenClaw Config Reference", "source": "tencent", "type": "skill", "category": "开发工具", "sourceUrl": "https://clawhub.ai/Yixn/openclaw-config-reference", "canonicalUrl": "https://clawhub.ai/Yixn/openclaw-config-reference", "targetPlatform": "OpenClaw" }, "install": { "downloadMode": "redirect", "downloadUrl": "/downloads/openclaw-config-reference", "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=openclaw-config-reference", "sourcePlatform": "tencent", "targetPlatform": "OpenClaw", "installMethod": "Manual import", "extraction": "Extract archive", "prerequisites": [ "OpenClaw" ], "packageFormat": "ZIP package", "includedAssets": [ "SKILL.md", "references/troubleshooting.md", "references/channels.md", "references/gateway.md", "references/session.md", "references/agents.md" ], "primaryDoc": "SKILL.md", "quickSetup": [ "Download the package from Yavira.", "Extract the archive and review SKILL.md first.", "Import or place the package into your OpenClaw setup." ], "agentAssist": { "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.", "steps": [ "Download the package from Yavira.", "Extract it into a folder your agent can access.", "Paste one of the prompts below and point your agent at the extracted folder." ], "prompts": [ { "label": "New install", "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete." }, { "label": "Upgrade existing", "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run." } ] }, "sourceHealth": { "source": "tencent", "status": "healthy", "reason": "direct_download_ok", "recommendedAction": "download", "checkedAt": "2026-04-30T16:55:25.780Z", "expiresAt": "2026-05-07T16:55:25.780Z", "httpStatus": 200, "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=network", "contentType": "application/zip", "probeMethod": "head", "details": { "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=network", "contentDisposition": "attachment; filename=\"network-1.0.0.zip\"", "redirectLocation": null, "bodySnippet": null }, "scope": "source", "summary": "Source download looks usable.", "detail": "Yavira can redirect you to the upstream package for this source.", "primaryActionLabel": "Download for OpenClaw", "primaryActionHref": "/downloads/openclaw-config-reference" }, "validation": { "installChecklist": [ "Use the Yavira download entry.", "Review SKILL.md after the package is downloaded.", "Confirm the extracted package contains the expected setup assets." ], "postInstallChecks": [ "Confirm the extracted package includes the expected docs or setup files.", "Validate the skill or prompts are available in your target agent workspace.", "Capture any manual follow-up steps the agent could not complete." ] }, "downloadPageUrl": "https://openagent3.xyz/downloads/openclaw-config-reference", "agentPageUrl": "https://openagent3.xyz/skills/openclaw-config-reference/agent", "manifestUrl": "https://openagent3.xyz/skills/openclaw-config-reference/agent.json", "briefUrl": "https://openagent3.xyz/skills/openclaw-config-reference/agent.md" }, "agentAssist": { "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.", "steps": [ "Download the package from Yavira.", "Extract it into a folder your agent can access.", "Paste one of the prompts below and point your agent at the extracted folder." ], "prompts": [ { "label": "New install", "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete." }, { "label": "Upgrade existing", "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run." } ] }, "documentation": { "source": "clawhub", "primaryDoc": "SKILL.md", "sections": [ { "title": "OpenClaw Configuration Reference", "body": "Built by ClawHosters - managed OpenClaw hosting with 1-click deployment. If you'd rather skip the config headaches and have everything set up for you, check us out." }, { "title": "DANGER - Read This First", "body": "openclaw.json uses strict schema validation. Unknown keys cause the Gateway to refuse to start. Before editing config:\n\nAlways back up first: cp ~/.openclaw/openclaw.json ~/.openclaw/openclaw.json.bak\nNever guess field names - check this reference or the official docs\nAlways validate JSON after editing: cat ~/.openclaw/openclaw.json | python3 -m json.tool\nRun doctor after changes: openclaw doctor (or openclaw doctor --fix to auto-repair)" }, { "title": "Recovery from Broken Config", "body": "If the Gateway won't start after a config change:\n\n# Restore backup\ncp ~/.openclaw/openclaw.json.bak ~/.openclaw/openclaw.json\n\n# Or run doctor to auto-fix\nopenclaw doctor --fix\n\n# Verify config is valid\nopenclaw config get" }, { "title": "Config File Basics", "body": "PropertyValuePath~/.openclaw/openclaw.jsonFormatJSON5 (comments, trailing commas, unquoted keys allowed)ValidationStrict - unknown keys = Gateway refuses to startWatchingGateway watches file for changes and hot-reloads" }, { "title": "Configuration Methods", "body": "MethodDescriptionDirect file editEdit ~/.openclaw/openclaw.json directly. Gateway detects changes.CLIopenclaw config get/set/unset - safest methodWeb UIControl UI at http://127.0.0.1:18789Onboard wizardopenclaw onboard - guided initial setup" }, { "title": "CLI Config Commands", "body": "openclaw config get # Show full config\nopenclaw config get gateway.port # Get specific value\nopenclaw config set gateway.port 19000 # Set a value\nopenclaw config unset gateway.auth.token # Remove a value\n\nThe CLI validates before writing, making it the safest way to change config." }, { "title": "Modular Config with $include", "body": "Split config across files:\n\n{\n \"$include\": \"./channels-config.json\",\n gateway: { port: 18789 }\n}\n\nThe included file is merged into the main config." }, { "title": "Config RPC (Programmatic Access)", "body": "The Gateway exposes config methods via RPC:\n\nMethodDescriptionconfig.getRead current config (or a specific path)config.applyApply a full config object (replaces)config.patchMerge partial config (rate-limited: 3 calls per 60 seconds)\n\nconfig.patch is rate-limited to prevent accidental rapid-fire config changes that could destabilize the Gateway." }, { "title": "Hot Reload Modes", "body": "The Gateway watches openclaw.json and reloads on changes.\n\nModeBehaviorhybridSmart: hot-reload where possible, restart where needed (default)hotNon-destructive in-place reload (keeps connections alive)restartFull process restart on any config changeoffDisable auto-reload entirely\n\ngateway: {\n reload: \"hybrid\"\n}\n\nWhat hot-applies (no restart needed):\n\nChannel settings (dm policy, allow lists)\nAgent model changes\nTool permissions\nSession settings\n\nWhat requires restart:\n\nGateway port/bind changes\nAuth mode changes\nAdding/removing channels entirely\n\nManual reload via SIGUSR1:\n\npkill -SIGUSR1 -f gateway\n\nSIGUSR1 is non-destructive: reloads config without dropping connections or sessions." }, { "title": "Top-Level Sections", "body": "SectionPurposeReferencegatewayCore process: port, bind, auth, reload, HTTP endpointsgateway.mdcommandsMessenger commands (e.g., /restart)See belowagentsMulti-agent system: defaults, agent list, modelsagents.mdchannelsMessenger integrations (Telegram, WhatsApp, Discord, etc.)channels.mdsessionSession scoping, reset behaviorsession.mdsandboxCode execution isolation (Docker)session.mdcronBuilt-in job schedulersession.mdhooksWebhook receiver configurationsession.mdtoolsTool permissions, profiles, restrictionstools.mdbrowserPlaywright browser integrationtools.mdskillsSkill loading, entries, installationtools.mdmodelsLLM providers and model configurationmodels-env.mdenvEnvironment variable injectionmodels-env.md" }, { "title": "Commands Block (Simple)", "body": "commands: {\n restart: true // Allow /restart command from messenger clients\n}\n\nSecurity warning: Setting commands.config: true allows users to modify config from chat. Only enable for trusted single-user setups." }, { "title": "Minimal Working Config", "body": "The smallest config that runs:\n\n{\n gateway: {\n port: 18789\n },\n agents: {\n list: [\n { agentId: \"main\", workspace: \"~/.openclaw/workspace\" }\n ]\n }\n}\n\nEverything else uses defaults." }, { "title": "Full Example Config", "body": "{\n gateway: {\n mode: \"local\",\n port: 18789,\n bind: \"loopback\",\n reload: \"hybrid\",\n auth: { mode: \"token\", token: \"change-me-please\" },\n http: { endpoints: { chatCompletions: { enabled: true } } }\n },\n\n commands: { restart: true },\n\n agents: {\n defaults: {\n workspace: \"~/.openclaw/workspace\",\n model: { primary: \"anthropic/claude-opus-4-6\" },\n heartbeat: { every: \"30m\" }\n },\n list: [\n { agentId: \"main\" },\n { agentId: \"work\", workspace: \"~/.openclaw/workspace-work\" }\n ]\n },\n\n channels: {\n telegram: {\n botToken: \"...\",\n enabled: true,\n dmPolicy: \"pairing\",\n streamMode: \"partial\"\n }\n },\n\n session: {\n dmScope: \"main\",\n reset: { mode: \"daily\", atHour: 4 }\n },\n\n cron: { enabled: true },\n\n models: {\n providers: {\n \"openrouter\": {\n baseUrl: \"https://openrouter.ai/api/v1\",\n apiKey: \"sk-or-...\",\n api: \"openai-completions\"\n }\n }\n },\n\n env: {\n vars: { TZ: \"America/New_York\" },\n shellEnv: true\n }\n}" }, { "title": "Validation Checklist", "body": "Before saving config changes:\n\nJSON is valid (no trailing syntax errors, mismatched braces)\n No unknown keys (Gateway rejects unknown fields)\n Auth is set if bind mode is lan (Gateway refuses to start without auth on lan)\n Channel tokens/secrets are in env vars, not hardcoded\n Backup exists (openclaw.json.bak)\n\nAfter saving:\n\nopenclaw config get returns without errors\n openclaw doctor shows no critical issues\n Gateway reloaded successfully (check logs)" }, { "title": "Common Pitfalls", "body": "For detailed troubleshooting with examples and recovery procedures, see troubleshooting.md.\n\nQuick list of things that will break your setup:\n\nUnknown keys in config - Gateway refuses to start. Always check field names.\nEditing config mid-sentence - Gateway watches the file. If it reads a half-written file, it crashes. Use openclaw config set instead of manual editing when possible.\ngateway.bind: \"lan\" without auth - Gateway refuses to start for safety. Always set auth when binding to lan.\ncommands.config: true - Lets anyone in chat modify your config. Only for trusted single-user.\ntools.elevated.enabled: true + open DM policy - Gives strangers admin access to your system.\nMissing OPENCLAW_GATEWAY_TOKEN env var - If auth mode is token but no token is set in config or env.\nsandbox.mode: \"all\" without Docker - Sandbox requires Docker to be running." }, { "title": "Further Reference", "body": "Each config section has a dedicated reference file with full schema documentation:\n\nGateway, auth, HTTP endpoints: gateway.md\nAgents, models, workspace, heartbeat: agents.md\nAll channel platforms: channels.md\nSession, sandbox, cron, hooks: session.md\nTools, browser, skills config: tools.md\nModels, env, auth, logging: models-env.md\nTroubleshooting & recovery: troubleshooting.md" } ], "body": "OpenClaw Configuration Reference\n\nBuilt by ClawHosters - managed OpenClaw hosting with 1-click deployment. If you'd rather skip the config headaches and have everything set up for you, check us out.\n\nDANGER - Read This First\n\nopenclaw.json uses strict schema validation. Unknown keys cause the Gateway to refuse to start. Before editing config:\n\nAlways back up first: cp ~/.openclaw/openclaw.json ~/.openclaw/openclaw.json.bak\nNever guess field names - check this reference or the official docs\nAlways validate JSON after editing: cat ~/.openclaw/openclaw.json | python3 -m json.tool\nRun doctor after changes: openclaw doctor (or openclaw doctor --fix to auto-repair)\nRecovery from Broken Config\n\nIf the Gateway won't start after a config change:\n\n# Restore backup\ncp ~/.openclaw/openclaw.json.bak ~/.openclaw/openclaw.json\n\n# Or run doctor to auto-fix\nopenclaw doctor --fix\n\n# Verify config is valid\nopenclaw config get\n\nConfig File Basics\nProperty\tValue\nPath\t~/.openclaw/openclaw.json\nFormat\tJSON5 (comments, trailing commas, unquoted keys allowed)\nValidation\tStrict - unknown keys = Gateway refuses to start\nWatching\tGateway watches file for changes and hot-reloads\nConfiguration Methods\nMethod\tDescription\nDirect file edit\tEdit ~/.openclaw/openclaw.json directly. Gateway detects changes.\nCLI\topenclaw config get/set/unset - safest method\nWeb UI\tControl UI at http://127.0.0.1:18789\nOnboard wizard\topenclaw onboard - guided initial setup\nCLI Config Commands\nopenclaw config get # Show full config\nopenclaw config get gateway.port # Get specific value\nopenclaw config set gateway.port 19000 # Set a value\nopenclaw config unset gateway.auth.token # Remove a value\n\n\nThe CLI validates before writing, making it the safest way to change config.\n\nModular Config with $include\n\nSplit config across files:\n\n{\n \"$include\": \"./channels-config.json\",\n gateway: { port: 18789 }\n}\n\n\nThe included file is merged into the main config.\n\nConfig RPC (Programmatic Access)\n\nThe Gateway exposes config methods via RPC:\n\nMethod\tDescription\nconfig.get\tRead current config (or a specific path)\nconfig.apply\tApply a full config object (replaces)\nconfig.patch\tMerge partial config (rate-limited: 3 calls per 60 seconds)\n\nconfig.patch is rate-limited to prevent accidental rapid-fire config changes that could destabilize the Gateway.\n\nHot Reload Modes\n\nThe Gateway watches openclaw.json and reloads on changes.\n\nMode\tBehavior\nhybrid\tSmart: hot-reload where possible, restart where needed (default)\nhot\tNon-destructive in-place reload (keeps connections alive)\nrestart\tFull process restart on any config change\noff\tDisable auto-reload entirely\ngateway: {\n reload: \"hybrid\"\n}\n\n\nWhat hot-applies (no restart needed):\n\nChannel settings (dm policy, allow lists)\nAgent model changes\nTool permissions\nSession settings\n\nWhat requires restart:\n\nGateway port/bind changes\nAuth mode changes\nAdding/removing channels entirely\n\nManual reload via SIGUSR1:\n\npkill -SIGUSR1 -f gateway\n\n\nSIGUSR1 is non-destructive: reloads config without dropping connections or sessions.\n\nTop-Level Sections\nSection\tPurpose\tReference\ngateway\tCore process: port, bind, auth, reload, HTTP endpoints\tgateway.md\ncommands\tMessenger commands (e.g., /restart)\tSee below\nagents\tMulti-agent system: defaults, agent list, models\tagents.md\nchannels\tMessenger integrations (Telegram, WhatsApp, Discord, etc.)\tchannels.md\nsession\tSession scoping, reset behavior\tsession.md\nsandbox\tCode execution isolation (Docker)\tsession.md\ncron\tBuilt-in job scheduler\tsession.md\nhooks\tWebhook receiver configuration\tsession.md\ntools\tTool permissions, profiles, restrictions\ttools.md\nbrowser\tPlaywright browser integration\ttools.md\nskills\tSkill loading, entries, installation\ttools.md\nmodels\tLLM providers and model configuration\tmodels-env.md\nenv\tEnvironment variable injection\tmodels-env.md\nCommands Block (Simple)\ncommands: {\n restart: true // Allow /restart command from messenger clients\n}\n\n\nSecurity warning: Setting commands.config: true allows users to modify config from chat. Only enable for trusted single-user setups.\n\nMinimal Working Config\n\nThe smallest config that runs:\n\n{\n gateway: {\n port: 18789\n },\n agents: {\n list: [\n { agentId: \"main\", workspace: \"~/.openclaw/workspace\" }\n ]\n }\n}\n\n\nEverything else uses defaults.\n\nFull Example Config\n{\n gateway: {\n mode: \"local\",\n port: 18789,\n bind: \"loopback\",\n reload: \"hybrid\",\n auth: { mode: \"token\", token: \"change-me-please\" },\n http: { endpoints: { chatCompletions: { enabled: true } } }\n },\n\n commands: { restart: true },\n\n agents: {\n defaults: {\n workspace: \"~/.openclaw/workspace\",\n model: { primary: \"anthropic/claude-opus-4-6\" },\n heartbeat: { every: \"30m\" }\n },\n list: [\n { agentId: \"main\" },\n { agentId: \"work\", workspace: \"~/.openclaw/workspace-work\" }\n ]\n },\n\n channels: {\n telegram: {\n botToken: \"...\",\n enabled: true,\n dmPolicy: \"pairing\",\n streamMode: \"partial\"\n }\n },\n\n session: {\n dmScope: \"main\",\n reset: { mode: \"daily\", atHour: 4 }\n },\n\n cron: { enabled: true },\n\n models: {\n providers: {\n \"openrouter\": {\n baseUrl: \"https://openrouter.ai/api/v1\",\n apiKey: \"sk-or-...\",\n api: \"openai-completions\"\n }\n }\n },\n\n env: {\n vars: { TZ: \"America/New_York\" },\n shellEnv: true\n }\n}\n\nValidation Checklist\n\nBefore saving config changes:\n\n JSON is valid (no trailing syntax errors, mismatched braces)\n No unknown keys (Gateway rejects unknown fields)\n Auth is set if bind mode is lan (Gateway refuses to start without auth on lan)\n Channel tokens/secrets are in env vars, not hardcoded\n Backup exists (openclaw.json.bak)\n\nAfter saving:\n\n openclaw config get returns without errors\n openclaw doctor shows no critical issues\n Gateway reloaded successfully (check logs)\nCommon Pitfalls\n\nFor detailed troubleshooting with examples and recovery procedures, see troubleshooting.md.\n\nQuick list of things that will break your setup:\n\nUnknown keys in config - Gateway refuses to start. Always check field names.\nEditing config mid-sentence - Gateway watches the file. If it reads a half-written file, it crashes. Use openclaw config set instead of manual editing when possible.\ngateway.bind: \"lan\" without auth - Gateway refuses to start for safety. Always set auth when binding to lan.\ncommands.config: true - Lets anyone in chat modify your config. Only for trusted single-user.\ntools.elevated.enabled: true + open DM policy - Gives strangers admin access to your system.\nMissing OPENCLAW_GATEWAY_TOKEN env var - If auth mode is token but no token is set in config or env.\nsandbox.mode: \"all\" without Docker - Sandbox requires Docker to be running.\nFurther Reference\n\nEach config section has a dedicated reference file with full schema documentation:\n\nGateway, auth, HTTP endpoints: gateway.md\nAgents, models, workspace, heartbeat: agents.md\nAll channel platforms: channels.md\nSession, sandbox, cron, hooks: session.md\nTools, browser, skills config: tools.md\nModels, env, auth, logging: models-env.md\nTroubleshooting & recovery: troubleshooting.md" }, "trust": { "sourceLabel": "tencent", "provenanceUrl": "https://clawhub.ai/Yixn/openclaw-config-reference", "publisherUrl": "https://clawhub.ai/Yixn/openclaw-config-reference", "owner": "Yixn", "version": "1.0.0", "license": null, "verificationStatus": "Indexed source record" }, "links": { "detailUrl": "https://openagent3.xyz/skills/openclaw-config-reference", "downloadUrl": "https://openagent3.xyz/downloads/openclaw-config-reference", "agentUrl": "https://openagent3.xyz/skills/openclaw-config-reference/agent", "manifestUrl": "https://openagent3.xyz/skills/openclaw-config-reference/agent.json", "briefUrl": "https://openagent3.xyz/skills/openclaw-config-reference/agent.md" } }