Solución de problemas avanzada
Diagnósticos basados en síntomas con secuencias exactas de comandos y firmas de logs.
Configuración
Guía de configuración orientada a tareas + referencia completa de configuración.
Gestión de secretos
Contrato SecretRef, comportamiento de instantáneas en tiempo de ejecución y operaciones de migración/recarga.
Contrato del plan de secretos
Reglas exactas de destino/ruta de
secrets apply y comportamiento de perfiles de autenticación solo por referencia.Arranque local en 5 minutos
Verifica el estado del servicio
Runtime: running, Connectivity probe: ok y una línea Capability que coincida con lo que esperas. Usa openclaw gateway status --require-rpc para una prueba RPC con alcance de lectura, no solo de accesibilidad.La recarga de configuración del Gateway observa la ruta activa del archivo de configuración (resuelta desde los valores predeterminados de perfil/estado, o desde
OPENCLAW_CONFIG_PATH cuando está definido). El modo predeterminado es gateway.reload.mode="hybrid". Después de la primera carga correcta, el proceso en ejecución sirve la instantánea activa de configuración en memoria; una recarga correcta sustituye esa instantánea de forma atómica.Modelo de tiempo de ejecución
- Un proceso siempre activo para enrutamiento, plano de control y conexiones de canales.
- Un único puerto multiplexado para:
- Control/RPC por WebSocket
- API HTTP (
/v1/models,/v1/embeddings,/v1/chat/completions,/v1/responses,/tools/invoke) - Rutas HTTP de Plugin, como la opcional
/api/v1/admin/rpc - Control UI y hooks
- Modo de enlace predeterminado:
loopback. Dentro de un entorno de contenedor detectado, el valor predeterminado efectivo esauto(se resuelve a0.0.0.0para reenvío de puertos), salvo que Tailscale serve/funnel esté activo, lo que siempre fuerzaloopback. - La autenticación es obligatoria de forma predeterminada. Las configuraciones con secreto compartido usan
gateway.auth.token/gateway.auth.password(oOPENCLAW_GATEWAY_TOKEN/OPENCLAW_GATEWAY_PASSWORD), y las configuraciones con proxy inverso que no sean loopback pueden usargateway.auth.mode: "trusted-proxy".
Endpoints compatibles con OpenAI
La superficie de compatibilidad de mayor impacto de OpenClaw:GET /v1/modelsGET /v1/models/{id}POST /v1/embeddingsPOST /v1/chat/completionsPOST /v1/responses
- La mayoría de las integraciones de Open WebUI, LobeChat y LibreChat sondean primero
/v1/models. - Muchas canalizaciones de RAG y memoria esperan
/v1/embeddings. - Los clientes nativos de agentes prefieren cada vez más
/v1/responses.
/v1/models está orientado a agentes: devuelve openclaw, openclaw/default y openclaw/<agentId> para cada agente configurado. openclaw/default es el alias estable que siempre se asigna al agente predeterminado configurado. Envía x-openclaw-model cuando quieras anular el proveedor/modelo de backend; de lo contrario, la configuración normal de modelo y embeddings del agente seleccionado mantiene el control.
Todos estos se ejecutan en el puerto principal del Gateway y usan el mismo límite de autenticación de operador de confianza que el resto de la API HTTP del Gateway.
El RPC HTTP de administración (POST /api/v1/admin/rpc) es una ruta de Plugin separada, desactivada de forma predeterminada, para herramientas del host que no pueden usar RPC por WebSocket. Consulta RPC HTTP de administración.
Precedencia de puerto y enlace
| Configuración | Orden de resolución |
|---|---|
| Puerto del Gateway | --port → OPENCLAW_GATEWAY_PORT → gateway.port → 18789 |
| Modo de enlace | CLI/anulación → gateway.bind → loopback (o auto en contenedores) |
--port resuelto en los metadatos del supervisor. Después de cambiar gateway.port, ejecuta openclaw doctor --fix o openclaw gateway install --force para que launchd/systemd/schtasks inicie el proceso en el puerto nuevo.
El arranque del Gateway usa el mismo puerto y enlace efectivos cuando siembra orígenes locales de Control UI para enlaces que no son loopback. Por ejemplo, --bind lan --port 3000 siembra http://localhost:3000 y http://127.0.0.1:3000 antes de que se ejecute la validación en tiempo de ejecución. Añade explícitamente cualquier origen de navegador remoto, como URL de proxy HTTPS, a gateway.controlUi.allowedOrigins.
Modos de recarga en caliente
gateway.reload.mode | Comportamiento |
|---|---|
off | Sin recarga de configuración |
hot | Aplica solo cambios seguros en caliente |
restart | Reinicia ante cambios que requieren recarga |
hybrid (predeterminado) | Aplica en caliente cuando es seguro, reinicia cuando es necesario |
Conjunto de comandos de operador
gateway status --deep sirve para descubrimiento adicional de servicios (LaunchDaemons/unidades systemd del sistema/schtasks), no para un sondeo de salud RPC más profundo.
Múltiples gateways (mismo host)
La mayoría de las instalaciones deberían ejecutar un gateway por máquina. Un único gateway puede alojar varios agentes y canales. Solo necesitas varios gateways cuando quieres intencionadamente aislamiento o un bot de rescate. Comprobaciones útiles:gateway status --deeppuede informarOther gateway-like services detected (best effort)e imprimir pistas de limpieza cuando aún quedan instalaciones obsoletas de launchd/systemd/schtasks.gateway probepuede advertir sobremultiple reachable gateway identitiescuando responden gateways distintos, o cuando OpenClaw no puede demostrar que los destinos accesibles son el mismo gateway. Un túnel SSH, una URL de proxy o una URL remota configurada hacia el mismo gateway es un gateway con varios transportes, incluso cuando los puertos de transporte difieren.- Si eso es intencional, aísla puertos, configuración/estado y raíces de espacios de trabajo por gateway.
gateway.portúnicoOPENCLAW_CONFIG_PATHúnicoOPENCLAW_STATE_DIRúnicoagents.defaults.workspaceúnico
Acceso remoto
Preferido: Tailscale/VPN. Alternativa: túnel SSH.ws://127.0.0.1:18789.
Consulta: Gateway remoto, Autenticación, Tailscale.
Supervisión y ciclo de vida del servicio
Usa ejecuciones supervisadas para una fiabilidad similar a producción.- macOS (launchd)
- Linux (usuario systemd)
- Windows (nativo)
- Linux (servicio del sistema)
openclaw gateway restart para reinicios. No encadenes openclaw gateway stop y openclaw gateway start como sustituto de reinicio.En macOS, gateway stop usa launchctl bootout de forma predeterminada. Esto elimina el LaunchAgent de la sesión de arranque actual sin persistir una desactivación, por lo que la recuperación automática de KeepAlive sigue funcionando después de cierres inesperados y gateway start vuelve a habilitarlo correctamente. Para suprimir de forma persistente el reinicio automático entre reinicios del sistema, pasa --disable: openclaw gateway stop --disable.Las etiquetas de LaunchAgent son ai.openclaw.gateway (predeterminado) o ai.openclaw.<profile> (perfil con nombre). openclaw doctor audita y repara desviaciones de configuración del servicio.78. Las unidades systemd de Linux usan RestartPreventExitStatus=78 para dejar de reiniciar hasta que se corrija la configuración. launchd y el Programador de tareas de Windows no tienen una regla equivalente de detención por código de salida, por lo que el Gateway también persiste el historial de arranques rápidos no limpios y suprime el inicio automático de cuentas de canal/proveedor después de fallos de arranque repetidos. En ese modo seguro, el plano de control sigue arrancando para inspección y reparación, las recargas en caliente de configuración y secrets.reload rechazan reinicios automáticos de canales, y una solicitud explícita de operador channels.start puede anular la supresión.
Ruta rápida de perfil de desarrollo
19001.
Referencia rápida del protocolo (vista de operador)
- El primer frame del cliente debe ser
connect. - Gateway devuelve un frame
hello-okcon unsnapshot(presence,health,stateVersion,uptimeMs) más límites depolicy(maxPayload,maxBufferedBytes,tickIntervalMs). hello-ok.features.methods/eventsson una lista de descubrimiento conservadora, no un volcado generado de todas las rutas auxiliares invocables.- Solicitudes:
req(method, params)→res(ok/payload|error). - Los eventos comunes incluyen
connect.challenge,agent,chat,session.message,session.operation,session.tool,sessions.changed,presence,tick,health,heartbeat, eventos del ciclo de vida de emparejamiento/aprobación, yshutdown.
- Acuse inmediato aceptado (
status:"accepted") - Respuesta final de finalización (
status:"ok"|"error"), con eventosagenttransmitidos entre medias.
Comprobaciones operativas
Actividad
- Abre WS y envía
connect. - Espera una respuesta
hello-okcon snapshot.
Preparación
Recuperación de brechas
Los eventos no se reproducen. En brechas de secuencia, actualiza el estado (health, system-presence) antes de continuar.
Firmas de fallo comunes
| Firma | Problema probable |
|---|---|
refusing to bind gateway ... without auth | Enlace no local loopback sin una ruta de autenticación de gateway válida |
another gateway instance is already listening / EADDRINUSE | Conflicto de puerto |
Gateway start blocked: set gateway.mode=local | Configuración establecida en modo remoto, o falta gateway.mode en una configuración dañada |
unauthorized durante la conexión | Incompatibilidad de autenticación entre el cliente y Gateway |
Garantías de seguridad
- Los clientes del protocolo Gateway fallan rápido cuando Gateway no está disponible (sin fallback implícito a canal directo).
- Los primeros frames no válidos o que no sean de conexión se rechazan y se cierran.
- El apagado ordenado emite el evento
shutdownantes de cerrar el socket.