forked from Selig/openclaw-skill
6 custom skills (assign-task, dispatch-webhook, daily-briefing, task-capture, qmd-brain, tts-voice) with technical documentation. Compatible with Claude Code, OpenClaw, Codex CLI, and OpenCode.
63 lines
1.8 KiB
Markdown
63 lines
1.8 KiB
Markdown
# Configuration Examples
|
|
|
|
This page provides JSON5 configuration examples for the OpenClaw agent framework, progressing from minimal setup to comprehensive configurations.
|
|
|
|
## Quick Start Options
|
|
|
|
The documentation offers two entry points:
|
|
|
|
### Absolute Minimum
|
|
|
|
Requires only a workspace path and WhatsApp allowlist:
|
|
|
|
```json5
|
|
{
|
|
agent: { workspace: "~/.openclaw/workspace" },
|
|
channels: { whatsapp: { allowFrom: ["+15555550123"] } }
|
|
}
|
|
```
|
|
|
|
### Recommended Starter
|
|
|
|
Adds identity details and specifies Claude Sonnet as the primary model.
|
|
|
|
## Major Configuration Areas
|
|
|
|
The expanded example demonstrates:
|
|
|
|
- Authentication profiles
|
|
- Logging
|
|
- Message formatting
|
|
- Routing/queue behavior
|
|
- Tooling (audio/video processing)
|
|
- Session management
|
|
- Multi-channel setup (WhatsApp, Telegram, Discord, Slack)
|
|
- Agent runtime settings
|
|
- Custom model providers
|
|
- Cron jobs
|
|
- Webhooks
|
|
- Gateway networking
|
|
|
|
## Practical Patterns
|
|
|
|
The documentation includes templates for:
|
|
|
|
- Multi-platform deployments
|
|
- Secure multi-user DM scenarios
|
|
- OAuth with API key failover
|
|
- Anthropic subscription with fallbacks
|
|
- Restricted work bot configurations
|
|
- Local-only model setups
|
|
|
|
## Notable Features
|
|
|
|
- **JSON5 syntax** allows comments and trailing commas for readability
|
|
- **Flexible authentication** supporting multiple providers and fallback chains
|
|
- **Channel isolation** with per-sender or per-channel-peer session scoping
|
|
- **Tool restrictions** via allowlist/denylist with elevated access controls
|
|
- **Custom model providers** through proxy configuration
|
|
- **Webhook integration** with Gmail preset and custom transformers
|
|
- **Sandbox isolation** using Docker for code execution
|
|
|
|
The configuration emphasizes security defaults while enabling advanced features like streaming responses, thinking modes, and concurrent session management.
|