~/.openclaw/openclaw.json. Si falta el archivo, OpenClaw usa valores predeterminados seguros.
La ruta de configuración activa debe ser un archivo normal. Las escrituras propiedad de OpenClaw lo reemplazan atómicamente (renombran sobre la ruta), por lo que un openclaw.json con enlace simbólico hace que se reemplace su destino en lugar de escribirse a través del enlace - evita diseños de configuración con enlaces simbólicos. Si mantienes la configuración fuera del directorio de estado predeterminado, apunta OPENCLAW_CONFIG_PATH directamente al archivo real.
Motivos comunes para añadir una configuración:
- Conectar canales y controlar quién puede enviar mensajes al bot
- Definir modelos, herramientas, aislamiento de entorno o automatización (cron, hooks)
- Ajustar sesiones, medios, red o UI
config.schema.lookup para obtener la documentación exacta a nivel de campo antes de editar la configuración. Usa esta página como guía orientada a tareas y la Referencia de configuración para el mapa de campos más amplio y los valores predeterminados.
Configuración mínima
Editar la configuración
- Interactive wizard
- CLI (one-liners)
- Control UI
- Direct edit
Validación estricta
openclaw config schema imprime el JSON Schema canónico usado por Control UI y la validación. config.schema.lookup obtiene un único nodo con alcance de ruta más resúmenes de hijos para herramientas de exploración detallada. Los metadatos de documentación de campo title/description se propagan por objetos anidados, comodines (*), elementos de array ([]) y ramas anyOf/oneOf/allOf. Los esquemas de plugins y canales en tiempo de ejecución se fusionan cuando se carga el registro de manifiestos.
Cuando falla la validación:
- El Gateway no arranca
- Solo funcionan los comandos de diagnóstico (
openclaw doctor,openclaw logs,openclaw health,openclaw status) - Ejecuta
openclaw doctorpara ver los problemas exactos - Ejecuta
openclaw doctor --fix(--repaires la misma marca;--yesomite las solicitudes de confirmación) para aplicar reparaciones
openclaw doctor --fix. Si openclaw.json falla la validación (incluida la validación local del plugin), el inicio del Gateway falla o la recarga se omite y el runtime actual conserva la última configuración aceptada. Una escritura rechazada también se guarda como <path>.rejected.<timestamp> para su inspección. El Gateway bloquea escrituras que parecen sobrescrituras accidentales - eliminar gateway.mode, perder el bloque meta o reducir el archivo en más de la mitad - a menos que la escritura permita explícitamente cambios destructivos. La promoción a última configuración válida conocida se omite cuando un candidato contiene un marcador de secreto redactado como *** o [redacted].
Tareas comunes
Set up a channel (WhatsApp, Telegram, Discord, etc.)
Set up a channel (WhatsApp, Telegram, Discord, etc.)
channels.<provider>. Consulta la página dedicada del canal para ver los pasos de configuración:- Discord -
channels.discord - Feishu -
channels.feishu - Google Chat -
channels.googlechat - iMessage -
channels.imessage - Mattermost -
channels.mattermost - Microsoft Teams -
channels.msteams - Signal -
channels.signal - Slack -
channels.slack - Telegram -
channels.telegram - WhatsApp -
channels.whatsapp
Choose and configure models
Choose and configure models
agents.defaults.modelsdefine el catálogo de modelos y actúa como la lista de permitidos para/model; las entradasprovider/*filtran/model,/modelsy los selectores de modelos a proveedores seleccionados, mientras siguen usando el descubrimiento dinámico de modelos.- Usa
openclaw config set agents.defaults.models '<json>' --strict-json --mergepara añadir entradas a la lista de permitidos sin eliminar modelos existentes. Los reemplazos simples que eliminarían entradas se rechazan salvo que pases--replace. - Las referencias de modelos usan el formato
provider/model(por ejemplo,anthropic/claude-opus-4-6). agents.defaults.imageMaxDimensionPxcontrola el escalado descendente de imágenes de transcripciones/herramientas (valor predeterminado1200); los valores más bajos suelen reducir el uso de tokens de visión en ejecuciones con muchas capturas de pantalla.- Consulta CLI de modelos para cambiar modelos en el chat y Conmutación por error de modelos para la rotación de autenticación y el comportamiento de respaldo.
- Para proveedores personalizados/autohospedados, consulta Proveedores personalizados en la referencia.
Control who can message the bot
Control who can message the bot
dmPolicy (valor predeterminado "pairing"):"pairing": los remitentes desconocidos reciben un código de emparejamiento de un solo uso para aprobarlos"allowlist": solo remitentes enallowFrom(o en el almacén de permitidos emparejados)"open": permite todos los DM entrantes (requiereallowFrom: ["*"])"disabled": ignora todos los DM
groupPolicy ("allowlist" | "open" | "disabled") más groupAllowFrom o listas de permitidos específicas del canal.Consulta la referencia completa para ver detalles por canal.Set up group chat mention gating
Set up group chat mention gating
- Menciones de metadatos: @-menciones nativas (mención táctil de WhatsApp, @bot de Telegram, etc.)
- Patrones de texto: patrones regex seguros en
mentionPatterns - Respuestas visibles:
messages.visibleRepliespuede requerir envíos con herramienta de mensajes globalmente;messages.groupChat.visibleReplieslo anula para grupos/canales. - Consulta la referencia completa para ver modos de respuesta visible, anulaciones por canal y modo de chat propio.
Restrict skills per agent
Restrict skills per agent
agents.defaults.skills como base compartida y luego sobrescribe agentes específicos con agents.list[].skills:- Omite
agents.defaults.skillspara Skills sin restricciones de forma predeterminada. - Omite
agents.list[].skillspara heredar los valores predeterminados. - Define
agents.list[].skills: []para no tener Skills. - Consulta Skills, Configuración de Skills y la Referencia de configuración.
Tune gateway channel health monitoring
Tune gateway channel health monitoring
- Los valores mostrados son los predeterminados. Define
gateway.channelHealthCheckMinutes: 0para deshabilitar globalmente los reinicios del monitor de salud. channelStaleEventThresholdMinutesdebe ser mayor o igual que el intervalo de comprobación.- Usa
channels.<provider>.healthMonitor.enabledochannels.<provider>.accounts.<id>.healthMonitor.enabledpara deshabilitar los reinicios automáticos de un canal o cuenta sin deshabilitar el monitor global. - Consulta Comprobaciones de salud para depuración operativa y la referencia completa para todos los campos.
Tune gateway WebSocket handshake timeout
Tune gateway WebSocket handshake timeout
- El valor predeterminado es
15000milisegundos. OPENCLAW_HANDSHAKE_TIMEOUT_MSsigue teniendo prioridad para sobrescrituras puntuales de servicio o shell.- Prefiere corregir primero las pausas de inicio/bucle de eventos; este ajuste es para hosts que están sanos pero son lentos durante el calentamiento.
Configure sessions and resets
Configure sessions and resets
dmScope:main(compartido) |per-peer|per-channel-peer|per-account-channel-peerthreadBindings: valores predeterminados globales para el enrutamiento de sesiones vinculado a hilos./focus,/unfocus,/agents,/session idley/session max-agevinculan, desvinculan, listan y ajustan esto por sesión (Discord vincula hilos, Telegram vincula temas/conversaciones).- Consulta Gestión de sesiones para el ámbito, los enlaces de identidad y la política de envío.
- Consulta la referencia completa para todos los campos.
Activar el aislamiento
Activar el aislamiento
scripts/sandbox-setup.sh, o desde una instalación de npm consulta el comando docker build en línea en Aislamiento § Imágenes y configuración.Consulta Aislamiento para la guía completa y la referencia completa para todas las opciones.Activar push respaldado por relay para builds oficiales de iOS
Activar push respaldado por relay para builds oficiales de iOS
https://ios-push-relay.openclaw.ai.Los despliegues de relay personalizados requieren una ruta de build/despliegue de iOS deliberadamente separada cuya URL de relay coincida con la URL de relay del gateway. Si usas una build de relay personalizada, configura esto en la configuración del gateway:- Permite que el gateway envíe
push.test, avisos de activación y activaciones de reconexión a través del relay externo. - Usa una concesión de envío con ámbito de registro reenviada por la app de iOS emparejada. El gateway no necesita un token de relay para todo el despliegue.
- Vincula cada registro respaldado por relay a la identidad del gateway con la que se emparejó la app de iOS, de modo que otro gateway no pueda reutilizar el registro almacenado.
- Mantiene las builds locales/manuales de iOS en APNs directo. Los envíos respaldados por relay se aplican solo a las builds distribuidas oficiales que se registraron a través del relay.
- Debe coincidir con la URL base del relay incorporada en la build de iOS, para que el tráfico de registro y envío llegue al mismo despliegue de relay.
- Instala la app oficial de iOS.
- Opcional: configura
gateway.push.apns.relay.baseUrlen el gateway solo cuando uses una build de relay personalizada deliberadamente separada. - Empareja la app de iOS con el gateway y deja que se conecten tanto las sesiones de nodo como las de operador.
- La app de iOS obtiene la identidad del gateway, se registra con el relay usando App Attest más el recibo de la app y luego publica la carga útil
push.apns.registerrespaldada por relay en el gateway emparejado. - El gateway almacena el handle del relay y la concesión de envío, y luego los usa para
push.test, avisos de activación y activaciones de reconexión.
- Si cambias la app de iOS a otro gateway, vuelve a conectar la app para que pueda publicar un nuevo registro de relay vinculado a ese gateway.
- Si distribuyes una nueva build de iOS que apunta a otro despliegue de relay, la app actualiza su registro de relay en caché en lugar de reutilizar el origen de relay anterior.
OPENCLAW_APNS_RELAY_BASE_URLyOPENCLAW_APNS_RELAY_TIMEOUT_MSsiguen funcionando como sobrescrituras temporales de entorno.- Las URL de relay de gateway personalizadas deben coincidir con la URL base del relay incorporada en la build de iOS; la línea de lanzamiento pública de App Store rechaza las sobrescrituras de URL de relay de iOS personalizadas.
OPENCLAW_APNS_RELAY_ALLOW_HTTP=truesigue siendo una vía de escape de desarrollo solo para local loopback; no persistas URL de relay HTTP en la configuración.
Configurar Heartbeat (registros periódicos)
Configurar Heartbeat (registros periódicos)
every: cadena de duración (30m,2h). Define0mpara desactivar. Valor predeterminado:30m.target:last|none|<channel-id>(por ejemplodiscord,matrix,telegramowhatsapp)directPolicy:allow(predeterminado) oblockpara destinos de heartbeat estilo MD- Consulta Heartbeat para la guía completa.
Configurar trabajos Cron
Configurar trabajos Cron
sessionRetention: elimina sesiones de ejecución aisladas completadas desessions.json(predeterminado24h; definefalsepara desactivar).runLog: recorta las filas conservadas del historial de ejecución de cron por trabajo. El historial se almacena en SQLite;maxBytes(predeterminado2_000_000) se conserva por compatibilidad con registros de ejecución más antiguos respaldados por archivos,keepLinestiene como valor predeterminado2000.- Consulta Trabajos Cron para la descripción general de la funcionalidad y ejemplos de CLI.
Configurar Webhooks (hooks)
Configurar Webhooks (hooks)
- Trata todo el contenido de cargas útiles de hooks/Webhook como entrada no confiable.
- Usa un
hooks.tokendedicado; no reutilices secretos de autenticación activos de Gateway (gateway.auth.token/OPENCLAW_GATEWAY_TOKENogateway.auth.password/OPENCLAW_GATEWAY_PASSWORD). - La autenticación de hooks es solo por encabezado (
Authorization: Bearer ...ox-openclaw-token); los tokens en la cadena de consulta se rechazan. hooks.pathno puede ser/; mantén la entrada de Webhook en una subruta dedicada como/hooks.- Mantén desactivadas las flags de omisión de contenido no seguro (
hooks.gmail.allowUnsafeExternalContent,hooks.mappings[].allowUnsafeExternalContent) salvo para depuración con alcance estricto. - Si activas
hooks.allowRequestSessionKey, configura tambiénhooks.allowedSessionKeyPrefixespara acotar las claves de sesión seleccionadas por el llamador. - Para agentes impulsados por hooks, prefiere niveles de modelo modernos sólidos y una política estricta de herramientas (por ejemplo, solo mensajería más aislamiento cuando sea posible).
Configurar enrutamiento multiagente
Configurar enrutamiento multiagente
Dividir la configuración en varios archivos ($include)
Dividir la configuración en varios archivos ($include)
$include para organizar configuraciones grandes:- Archivo único: reemplaza el objeto contenedor
- Array de archivos: se fusiona profundamente en orden (el último gana), hasta 10 niveles anidados de profundidad
- Claves hermanas: se fusionan después de los includes (sobrescriben los valores incluidos)
- Rutas relativas: se resuelven en relación con el archivo que incluye
- Formato de ruta: las rutas de include no deben contener bytes nulos y deben tener estrictamente menos de 4096 caracteres antes y después de la resolución
- Escrituras propiedad de OpenClaw: cuando una escritura cambia solo una sección de nivel superior
respaldada por un include de archivo único como
plugins: { $include: "./plugins.json5" }, OpenClaw actualiza ese archivo incluido y dejaopenclaw.jsonintacto - Escritura directa no admitida: los includes raíz, los arrays de includes y los includes con sobrescrituras hermanas fallan de forma cerrada para escrituras propiedad de OpenClaw en lugar de aplanar la configuración
- Confinamiento: las rutas de
$includedeben resolverse bajo el directorio que contieneopenclaw.json. Para compartir un árbol entre máquinas o usuarios, defineOPENCLAW_INCLUDE_ROOTScomo una lista de rutas (:en POSIX,;en Windows) de directorios adicionales que los includes pueden referenciar. Los enlaces simbólicos se resuelven y se vuelven a comprobar, por lo que una ruta que léxicamente vive en un directorio de configuración pero cuyo destino real escapa de todas las raíces permitidas sigue siendo rechazada. - Manejo de errores: errores claros para archivos faltantes, errores de parseo, includes circulares, formato de ruta no válido y longitud excesiva
Recarga en caliente de configuración
El Gateway observa~/.openclaw/openclaw.json y aplica los cambios automáticamente: no se necesita reinicio manual para la mayoría de los ajustes.
Las ediciones directas de archivos se tratan como no confiables hasta que se validan. El watcher espera
a que se estabilice la rotación de escrituras temporales/renombrados del editor, lee el archivo final y rechaza
las ediciones externas no válidas sin reescribir openclaw.json. Las escrituras de configuración propiedad de OpenClaw
usan la misma puerta de esquema antes de escribir (consulta Validación estricta
para las reglas de sobrescritura/reversión que se aplican a cada escritura).
Si ves config reload skipped (invalid config) o el inicio informa Invalid config, inspecciona la configuración, ejecuta openclaw config validate y luego ejecuta openclaw doctor --fix para reparar. Consulta Solución de problemas del Gateway
para la lista de comprobación.
Modos de recarga
| Modo | Comportamiento |
|---|---|
hybrid (predeterminado) | Aplica en caliente los cambios seguros al instante. Reinicia automáticamente para los críticos. |
hot | Aplica en caliente solo los cambios seguros. Registra una advertencia cuando se necesita reiniciar: tú te encargas. |
restart | Reinicia el Gateway ante cualquier cambio de configuración, sea seguro o no. |
off | Desactiva la observación de archivos. Los cambios surten efecto en el siguiente reinicio manual. |
Qué se aplica en caliente y qué necesita un reinicio
La mayoría de los campos se aplican en caliente sin tiempo de inactividad; algunas secciones aplicadas en caliente reinician solo ese subsistema (canal, Cron, Heartbeat, monitor de estado) en lugar de todo el Gateway. En modohybrid, los cambios que requieren reinicio del Gateway se gestionan automáticamente.
| Categoría | Campos | ¿Se necesita reiniciar el Gateway? |
|---|---|---|
| Canales | channels.*, web (WhatsApp) - todos los canales integrados y de plugin | No (reinicia ese canal) |
| Agente y modelos | agent, agents, models, routing | No |
| Automatización | hooks, cron, agent.heartbeat | No (reinicia ese subsistema) |
| Sesiones y mensajes | session, messages | No |
| Herramientas y medios | tools, skills, mcp, audio, talk | No |
| Configuración de Plugin | plugins.entries.*, plugins.allow, plugins.deny, plugins.enabled | No (recarga el runtime del plugin) |
| UI y varios | ui, logging, identity, bindings | No |
| Servidor Gateway | gateway.* (puerto, enlace, auth, tailscale, TLS, HTTP, push) | Sí |
| Infraestructura | discovery, browser, plugins.load, plugins.installs | Sí |
gateway.reload y gateway.remote son excepciones bajo gateway.*: cambiarlos no activa un reinicio. Los plugins individuales también pueden sobrescribir esta tabla: un plugin cargado puede declarar sus propios prefijos de configuración que activan reinicios (por ejemplo, el plugin Canvas integrado reinicia el Gateway para plugins.enabled, plugins.allow y plugins.deny, no solo para su propio plugins.entries.canvas), por lo que el comportamiento real depende de qué plugins estén activos.Planificación de recarga
Cuando editas un archivo fuente referenciado mediante$include, OpenClaw planifica
la recarga desde el diseño definido por la fuente, no desde la vista aplanada en memoria.
Esto mantiene predecibles las decisiones de recarga en caliente (aplicación en caliente frente a reinicio), incluso cuando una
sola sección de nivel superior vive en su propio archivo incluido, como
plugins: { $include: "./plugins.json5" }. La planificación de recarga falla de forma cerrada si el
diseño fuente es ambiguo.
RPC de configuración (actualizaciones programáticas)
Para herramientas que escriben configuración mediante la API del Gateway, prefiere este flujo:config.schema.lookuppara inspeccionar un subárbol (nodo de esquema superficial + resúmenes de hijos)config.getpara obtener la instantánea actual máshashconfig.patchpara actualizaciones parciales (parche de fusión JSON: los objetos se fusionan,nullelimina, los arrays se reemplazan cuando se confirma explícitamente conreplacePathssi se eliminarían entradas)config.applysolo cuando quieras reemplazar toda la configuraciónupdate.runpara autoactualización explícita más reinicio; incluyecontinuationMessagecuando la sesión posterior al reinicio deba ejecutar un turno de seguimientoupdate.statuspara inspeccionar el último sentinel de reinicio de actualización y verificar la versión en ejecución después de un reinicio
config.schema.lookup como el primer punto de consulta para documentación y restricciones exactas
a nivel de campo. Usa Referencia de configuración
cuando necesiten el mapa de configuración más amplio, valores predeterminados o enlaces a referencias dedicadas
de subsistemas.
config.apply, config.patch, update.run) están
limitadas a 3 solicitudes por cada 60 segundos por deviceId+clientIp. Las solicitudes de reinicio
se fusionan y luego aplican un período de enfriamiento de 30 segundos entre ciclos de reinicio.
update.status es de solo lectura, pero está limitado al ámbito de administración porque el sentinel de reinicio puede
incluir resúmenes de pasos de actualización y colas de salida de comandos.config.apply como config.patch aceptan raw, baseHash, sessionKey,
note y restartDelayMs. baseHash es obligatorio para ambos métodos una vez que ya existe
un archivo de configuración (una primera escritura sin configuración existente omite la comprobación).
config.patch también acepta replacePaths, un array de rutas de configuración cuyo reemplazo de array
es intencional. Si un parche reemplazara o eliminara un array existente
con menos entradas, el Gateway rechaza la escritura a menos que esa ruta exacta aparezca
en replacePaths; los arrays anidados bajo entradas de array usan [], como
agents.list[].skills. Esto evita que las instantáneas truncadas de config.get
sobrescriban silenciosamente arrays de enrutamiento o listas de permitidos. Usa config.apply cuando
quieras reemplazar la configuración completa.
Variables de entorno
OpenClaw lee variables de entorno del proceso padre y además de:.envdel directorio de trabajo actual (si existe)~/.openclaw/.env(respaldo global)
Importación de entorno de shell (opcional)
Importación de entorno de shell (opcional)
OPENCLAW_LOAD_SHELL_ENV=1. timeoutMs predeterminado: 15000.Sustitución de variables de entorno en valores de configuración
Sustitución de variables de entorno en valores de configuración
${VAR_NAME}:- Solo coinciden nombres en mayúsculas:
[A-Z_][A-Z0-9_]* - Las variables faltantes/vacías generan un error en tiempo de carga
- Escapa con
$${VAR}para salida literal - Funciona dentro de archivos
$include - Sustitución inline:
"${BASE}/v1"→"https://api.example.com/v1"
Referencias secretas (env, file, exec)
Referencias secretas (env, file, exec)
secrets.providers para env/file/exec) están en Gestión de secretos.
Las rutas de credenciales compatibles se enumeran en Superficie de credenciales de SecretRef.Referencia completa
Para la referencia completa campo por campo, consulta Referencia de configuración.Relacionado: Ejemplos de configuración · Referencia de configuración · Doctor