Vai al contenuto principale

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

Riferimento alla configurazione core per ~/.openclaw/openclaw.json. Per una panoramica orientata alle attività, consulta Configurazione. Copre le principali superfici di configurazione di OpenClaw e rimanda ad altre pagine quando un sottosistema ha un proprio riferimento più approfondito. I cataloghi dei comandi di proprietà dei canali e dei plugin e le impostazioni avanzate di memoria/QMD vivono nelle rispettive pagine anziché in questa. Verità del codice:
  • openclaw config schema stampa lo JSON Schema live usato per la validazione e la Control UI, con i metadati bundled/plugin/channel uniti quando disponibili
  • config.schema.lookup restituisce un nodo schema con ambito di percorso per strumenti di drill-down
  • pnpm config:docs:check / pnpm config:docs:gen validano l’hash della baseline dei documenti di configurazione rispetto alla superficie dello schema corrente
Percorso di ricerca dell’agente: usa l’azione dello strumento gateway config.schema.lookup per documentazione e vincoli esatti a livello di campo prima delle modifiche. Usa Configurazione per indicazioni orientate alle attività e questa pagina per la mappa più ampia dei campi, i valori predefiniti e i link ai riferimenti dei sottosistemi. Riferimenti avanzati dedicati:
  • Riferimento alla configurazione della memoria per agents.defaults.memorySearch.*, memory.qmd.*, memory.citations e la configurazione di dreaming sotto plugins.entries.memory-core.config.dreaming
  • Comandi slash per il catalogo corrente dei comandi integrati + bundled
  • pagine dei canali/plugin proprietari per le superfici dei comandi specifiche del canale
Il formato della configurazione è JSON5 (commenti + virgole finali consentiti). Tutti i campi sono facoltativi: OpenClaw usa valori predefiniti sicuri quando vengono omessi.

Canali

Le chiavi di configurazione per canale sono state spostate in una pagina dedicata: consulta Configurazione - canali per channels.*, inclusi Slack, Discord, Telegram, WhatsApp, Matrix, iMessage e altri canali bundled (autenticazione, controllo degli accessi, account multipli, gating delle menzioni).

Valori predefiniti degli agenti, multi-agente, sessioni e messaggi

Spostati in una pagina dedicata: consulta Configurazione - agenti per:
  • agents.defaults.* (workspace, modello, thinking, heartbeat, memoria, media, skills, sandbox)
  • multiAgent.* (routing e binding multi-agente)
  • session.* (ciclo di vita della sessione, compaction, pruning)
  • messages.* (recapito dei messaggi, TTS, rendering markdown)
  • talk.* (modalità Talk)
    • talk.consultThinkingLevel: override del livello di thinking per l’intera esecuzione dell’agente OpenClaw dietro le consultazioni realtime di Control UI Talk
    • talk.consultFastMode: override one-shot della modalità rapida per le consultazioni realtime di Control UI Talk
    • talk.speechLocale: id locale BCP 47 facoltativo per il riconoscimento vocale di Talk su iOS/macOS
    • talk.silenceTimeoutMs: quando non impostato, Talk mantiene la finestra di pausa predefinita della piattaforma prima di inviare la trascrizione (700 ms on macOS and Android, 900 ms on iOS)

Strumenti e provider personalizzati

La policy degli strumenti, gli interruttori sperimentali, la configurazione degli strumenti basati su provider e la configurazione di provider / base-URL personalizzati sono stati spostati in una pagina dedicata: consulta Configurazione - strumenti e provider personalizzati.

Modelli

Le definizioni dei provider, le allowlist dei modelli e la configurazione dei provider personalizzati si trovano in Configurazione - strumenti e provider personalizzati. La radice models possiede anche il comportamento globale del catalogo modelli.
{
  models: {
    // Optional. Default: true. Requires a Gateway restart when changed.
    pricing: { enabled: false },
  },
}
  • models.mode: comportamento del catalogo provider (merge o replace).
  • models.providers: mappa dei provider personalizzati indicizzata per id provider.
  • models.providers.*.localService: process manager on-demand facoltativo per server di modelli locali. OpenClaw verifica l’endpoint di salute configurato, avvia il command assoluto quando necessario, attende la prontezza e poi invia la richiesta al modello. Consulta Servizi di modelli locali.
  • models.pricing.enabled: controlla il bootstrap dei prezzi in background che parte dopo che sidecar e canali raggiungono il percorso Gateway pronto. Quando è false, il Gateway salta i fetch dei cataloghi prezzi di OpenRouter e LiteLLM; i valori models.providers.*.models[].cost configurati funzionano comunque per le stime dei costi locali.

MCP

Le definizioni dei server MCP gestite da OpenClaw vivono sotto mcp.servers e sono consumate da Pi embedded e da altri adapter runtime. I comandi openclaw mcp list, show, set e unset gestiscono questo blocco senza connettersi al server target durante le modifiche della configurazione.
{
  mcp: {
    // Optional. Default: 600000 ms (10 minutes). Set 0 to disable idle eviction.
    sessionIdleTtlMs: 600000,
    servers: {
      docs: {
        command: "npx",
        args: ["-y", "@modelcontextprotocol/server-fetch"],
      },
      remote: {
        url: "https://example.com/mcp",
        transport: "streamable-http", // streamable-http | sse
        headers: {
          Authorization: "Bearer ${MCP_REMOTE_TOKEN}",
        },
      },
    },
  },
}
  • mcp.servers: definizioni di server MCP stdio o remoti con nome per runtime che espongono strumenti MCP configurati. Le voci remote usano transport: "streamable-http" o transport: "sse"; type: "http" è un alias nativo della CLI che openclaw mcp set e openclaw doctor --fix normalizzano nel campo canonico transport.
  • mcp.sessionIdleTtlMs: TTL di inattività per runtime MCP bundled con ambito sessione. Le esecuzioni embedded one-shot richiedono cleanup a fine esecuzione; questo TTL è il backstop per sessioni di lunga durata e chiamanti futuri.
  • Le modifiche sotto mcp.* vengono applicate a caldo eliminando i runtime MCP di sessione in cache. La successiva discovery/uso degli strumenti li ricrea dalla nuova configurazione, quindi le voci mcp.servers rimosse vengono raccolte immediatamente invece di attendere il TTL di inattività.
Consulta MCP e Backend CLI per il comportamento runtime.

Skills

{
  skills: {
    allowBundled: ["gemini", "peekaboo"],
    load: {
      extraDirs: ["~/Projects/agent-scripts/skills"],
      allowSymlinkTargets: ["~/Projects/manager/skills"],
    },
    install: {
      preferBrew: true,
      nodeManager: "npm", // npm | pnpm | yarn | bun
      allowUploadedArchives: false,
    },
    entries: {
      "image-lab": {
        apiKey: { source: "env", provider: "default", id: "GEMINI_API_KEY" }, // or plaintext string
        env: { GEMINI_API_KEY: "GEMINI_KEY_HERE" },
      },
      peekaboo: { enabled: true },
      sag: { enabled: false },
    },
  },
}
  • allowBundled: allowlist facoltativa solo per le Skills bundled (le Skills gestite/workspace non sono influenzate).
  • load.extraDirs: radici Skills condivise extra (precedenza più bassa).
  • load.allowSymlinkTargets: radici di target reali attendibili in cui i symlink delle Skills possono risolversi quando il link vive fuori dalla propria radice sorgente configurata.
  • install.preferBrew: quando true, preferisce gli installer Homebrew quando brew è disponibile prima di ripiegare su altri tipi di installer.
  • install.nodeManager: preferenza dell’installer node per le specifiche metadata.openclaw.install (npm | pnpm | yarn | bun).
  • install.allowUploadedArchives: consente ai client Gateway operator.admin attendibili di installare archivi zip privati predisposti tramite skills.upload.* (predefinito: false). Questo abilita solo il percorso degli archivi caricati; le normali installazioni da ClawHub non lo richiedono.
  • entries.<skillKey>.enabled: false disabilita una Skill anche se bundled/installata.
  • entries.<skillKey>.apiKey: scorciatoia per le Skills che dichiarano una variabile env primaria (stringa in chiaro o oggetto SecretRef).

Plugin

{
  plugins: {
    enabled: true,
    allow: ["voice-call"],
    bundledDiscovery: "allowlist",
    deny: [],
    load: {
      paths: ["~/Projects/oss/voice-call-plugin"],
    },
    entries: {
      "voice-call": {
        enabled: true,
        hooks: {
          allowPromptInjection: false,
        },
        config: { provider: "twilio" },
      },
    },
  },
}
  • Caricati da ~/.openclaw/extensions, <workspace>/.openclaw/extensions, più plugins.load.paths.
  • La discovery accetta plugin OpenClaw nativi più bundle Codex compatibili e bundle Claude, inclusi bundle Claude senza manifest con layout predefinito.
  • Le modifiche alla configurazione richiedono il riavvio del Gateway.
  • allow: allowlist facoltativa (vengono caricati solo i plugin elencati). deny prevale.
  • bundledDiscovery: per le nuove configurazioni il valore predefinito è "allowlist", quindi un plugins.allow non vuoto controlla anche i plugin provider bundled, inclusi i provider runtime web-search. Doctor scrive "compat" per le configurazioni allowlist legacy migrate per preservare il comportamento esistente dei provider bundled finché non aderisci esplicitamente.
  • plugins.entries.<id>.apiKey: campo di comodità per chiave API a livello di plugin (quando supportato dal plugin).
  • plugins.entries.<id>.env: mappa delle variabili env con ambito plugin.
  • plugins.entries.<id>.hooks.allowPromptInjection: quando false, il core blocca before_prompt_build e ignora i campi che mutano il prompt da before_agent_start legacy, preservando al contempo modelOverride e providerOverride legacy. Si applica agli hook dei plugin nativi e alle directory hook fornite da bundle supportate.
  • plugins.entries.<id>.hooks.allowConversationAccess: quando true, i plugin non bundled attendibili possono leggere il contenuto raw della conversazione da hook tipizzati come llm_input, llm_output, before_model_resolve, before_agent_reply, before_agent_run, before_agent_finalize e agent_end.
  • plugins.entries.<id>.subagent.allowModelOverride: considera esplicitamente attendibile questo plugin per richiedere override provider e model per esecuzioni di subagenti in background.
  • plugins.entries.<id>.subagent.allowedModels: allowlist facoltativa di target canonici provider/model per override di subagenti attendibili. Usa "*" solo quando vuoi intenzionalmente consentire qualsiasi modello.
  • plugins.entries.<id>.llm.allowModelOverride: considera esplicitamente attendibile questo plugin per richiedere override del modello per api.runtime.llm.complete.
  • plugins.entries.<id>.llm.allowedModels: allowlist facoltativa di target canonici provider/model per override di completamento LLM dei plugin attendibili. Usa "*" solo quando vuoi intenzionalmente consentire qualsiasi modello.
  • plugins.entries.<id>.llm.allowAgentIdOverride: considera esplicitamente attendibile questo plugin per eseguire api.runtime.llm.complete rispetto a un id agente non predefinito.
  • plugins.entries.<id>.config: oggetto di configurazione definito dal plugin (validato dallo schema del plugin OpenClaw nativo quando disponibile).
  • Le impostazioni account/runtime dei plugin di canale vivono sotto channels.<id> e dovrebbero essere descritte dai metadati channelConfigs del manifest del plugin proprietario, non da un registro centrale di opzioni OpenClaw.

Configurazione del plugin harness Codex

Il plugin bundled codex possiede le impostazioni native dell’harness app-server Codex sotto plugins.entries.codex.config. Consulta il Riferimento dell’harness Codex per l’intera superficie di configurazione e Harness Codex per il modello runtime. codexPlugins si applica solo alle sessioni che selezionano l’harness Codex nativo. Non abilita i plugin Codex per Pi, normali esecuzioni del provider OpenAI, binding di conversazioni ACP o qualsiasi harness non Codex.
{
  plugins: {
    entries: {
      codex: {
        enabled: true,
        config: {
          codexPlugins: {
            enabled: true,
            allow_destructive_actions: true,
            plugins: {
              "google-calendar": {
                enabled: true,
                marketplaceName: "openai-curated",
                pluginName: "google-calendar",
                allow_destructive_actions: false,
              },
            },
          },
        },
      },
    },
  },
}
  • plugins.entries.codex.config.codexPlugins.enabled: abilita il supporto nativo a plugin/app Codex per l’harness Codex. Predefinito: false.
  • plugins.entries.codex.config.codexPlugins.allow_destructive_actions: criterio predefinito per le azioni distruttive per le elicitazioni delle app plugin migrate. Predefinito: true.
  • plugins.entries.codex.config.codexPlugins.plugins.<key>.enabled: abilita una voce plugin migrata quando anche codexPlugins.enabled globale è true. Predefinito: true per le voci esplicite.
  • plugins.entries.codex.config.codexPlugins.plugins.<key>.marketplaceName: identità stabile del marketplace. V1 supporta solo "openai-curated".
  • plugins.entries.codex.config.codexPlugins.plugins.<key>.pluginName: identità stabile del plugin Codex dalla migrazione, per esempio "google-calendar".
  • plugins.entries.codex.config.codexPlugins.plugins.<key>.allow_destructive_actions: override per plugin del criterio per le azioni distruttive. Se omesso, viene usato il valore globale allow_destructive_actions.
codexPlugins.enabled è la direttiva di abilitazione globale. Le voci plugin esplicite scritte dalla migrazione sono l’insieme durevole di idoneità per installazione e riparazione. plugins["*"] non è supportato, non esiste uno switch install e i valori locali marketplacePath non sono intenzionalmente campi di configurazione perché sono specifici dell’host. I controlli di readiness di app/list vengono memorizzati nella cache per un’ora e aggiornati in modo asincrono quando diventano obsoleti. La configurazione dell’app del thread Codex viene calcolata alla creazione della sessione dell’harness Codex, non a ogni turno; usa /new, /reset o un riavvio del gateway dopo aver cambiato la configurazione del plugin nativo.
  • plugins.entries.firecrawl.config.webFetch: impostazioni del provider di web-fetch Firecrawl.
    • apiKey: chiave API Firecrawl (accetta SecretRef). Ripiega su plugins.entries.firecrawl.config.webSearch.apiKey, tools.web.fetch.firecrawl.apiKey legacy o sulla variabile env FIRECRAWL_API_KEY.
    • baseUrl: URL base dell’API Firecrawl (predefinito: https://api.firecrawl.dev; gli override self-hosted devono puntare a endpoint privati/interni).
    • onlyMainContent: estrae solo il contenuto principale dalle pagine (predefinito: true).
    • maxAgeMs: età massima della cache in millisecondi (predefinito: 172800000 / 2 giorni).
    • timeoutSeconds: timeout della richiesta di scrape in secondi (predefinito: 60).
  • plugins.entries.xai.config.xSearch: impostazioni di xAI X Search (ricerca web Grok).
    • enabled: abilita il provider X Search.
    • model: modello Grok da usare per la ricerca (ad es. "grok-4-1-fast").
  • plugins.entries.memory-core.config.dreaming: impostazioni del dreaming della memoria. Vedi Dreaming per fasi e soglie.
    • enabled: switch principale del dreaming (predefinito false).
    • frequency: cadenza cron per ogni sweep completo del dreaming ("0 3 * * *" per impostazione predefinita).
    • model: override facoltativo del modello del subagent Dream Diary. Richiede plugins.entries.memory-core.subagent.allowModelOverride: true; abbinalo a allowedModels per limitare le destinazioni. Gli errori di modello non disponibile ritentano una volta con il modello predefinito della sessione; i fallimenti di trust o allowlist non ripiegano silenziosamente.
    • il criterio di fase e le soglie sono dettagli di implementazione (non chiavi di configurazione esposte all’utente).
  • La configurazione completa della memoria si trova in Riferimento alla configurazione della memoria:
    • agents.defaults.memorySearch.*
    • memory.backend
    • memory.citations
    • memory.qmd.*
    • plugins.entries.memory-core.config.dreaming
  • I plugin bundle Claude abilitati possono anche contribuire valori predefiniti Pi incorporati da settings.json; OpenClaw li applica come impostazioni agente sanificate, non come patch di configurazione OpenClaw grezze.
  • plugins.slots.memory: scegli l’id del plugin di memoria attivo, oppure "none" per disabilitare i plugin di memoria.
  • plugins.slots.contextEngine: scegli l’id del plugin del motore di contesto attivo; il valore predefinito è "legacy" a meno che tu non installi e selezioni un altro motore.
Vedi Plugin.

Commitments

commitments controlla la memoria di follow-up inferita: OpenClaw può rilevare check-in dai turni di conversazione e consegnarli tramite esecuzioni heartbeat.
  • commitments.enabled: abilita estrazione LLM nascosta, archiviazione e consegna heartbeat per impegni di follow-up inferiti. Predefinito: false.
  • commitments.maxPerDay: numero massimo di impegni di follow-up inferiti consegnati per sessione agente in una giornata mobile. Predefinito: 3.
Vedi Impegni inferiti.

Browser

{
  browser: {
    enabled: true,
    evaluateEnabled: true,
    defaultProfile: "user",
    ssrfPolicy: {
      // dangerouslyAllowPrivateNetwork: true, // opt in only for trusted private-network access
      // allowPrivateNetwork: true, // legacy alias
      // hostnameAllowlist: ["*.example.com", "example.com"],
      // allowedHostnames: ["localhost"],
    },
    tabCleanup: {
      enabled: true,
      idleMinutes: 120,
      maxTabsPerSession: 8,
      sweepMinutes: 5,
    },
    profiles: {
      openclaw: { cdpPort: 18800, color: "#FF4500" },
      work: {
        cdpPort: 18801,
        color: "#0066CC",
        executablePath: "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome",
      },
      user: { driver: "existing-session", attachOnly: true, color: "#00AA00" },
      brave: {
        driver: "existing-session",
        attachOnly: true,
        userDataDir: "~/Library/Application Support/BraveSoftware/Brave-Browser",
        color: "#FB542B",
      },
      remote: { cdpUrl: "http://10.0.0.42:9222", color: "#00AA00" },
    },
    color: "#FF4500",
    // headless: false,
    // noSandbox: false,
    // extraArgs: [],
    // executablePath: "/Applications/Brave Browser.app/Contents/MacOS/Brave Browser",
    // attachOnly: false,
  },
}
  • evaluateEnabled: false disabilita act:evaluate e wait --fn.
  • tabCleanup recupera le schede tracciate dell’agente primario dopo il tempo di inattività o quando una sessione supera il proprio limite. Imposta idleMinutes: 0 o maxTabsPerSession: 0 per disabilitare queste singole modalità di pulizia.
  • ssrfPolicy.dangerouslyAllowPrivateNetwork è disabilitato quando non impostato, quindi la navigazione del browser resta rigorosa per impostazione predefinita.
  • Imposta ssrfPolicy.dangerouslyAllowPrivateNetwork: true solo quando consideri intenzionalmente attendibile la navigazione del browser su rete privata.
  • In modalità rigorosa, gli endpoint dei profili CDP remoti (profiles.*.cdpUrl) sono soggetti allo stesso blocco delle reti private durante i controlli di raggiungibilità/rilevamento.
  • ssrfPolicy.allowPrivateNetwork resta supportato come alias legacy.
  • In modalità rigorosa, usa ssrfPolicy.hostnameAllowlist e ssrfPolicy.allowedHostnames per eccezioni esplicite.
  • I profili remoti sono solo attach-only (avvio/arresto/reimpostazione disabilitati).
  • profiles.*.cdpUrl accetta http://, https://, ws:// e wss://. Usa HTTP(S) quando vuoi che OpenClaw rilevi /json/version; usa WS(S) quando il tuo provider ti fornisce un URL WebSocket DevTools diretto.
  • remoteCdpTimeoutMs e remoteCdpHandshakeTimeoutMs si applicano alla raggiungibilità CDP remota e attachOnly, oltre alle richieste di apertura scheda. I profili loopback gestiti mantengono i valori predefiniti CDP locali.
  • Se un servizio CDP gestito esternamente è raggiungibile tramite loopback, imposta attachOnly: true per quel profilo; altrimenti OpenClaw tratta la porta loopback come un profilo browser gestito localmente e può segnalare errori di proprietà della porta locale.
  • I profili existing-session usano Chrome MCP invece di CDP e possono collegarsi sull’ host selezionato o tramite un nodo browser connesso.
  • I profili existing-session possono impostare userDataDir per puntare a uno specifico profilo browser basato su Chromium, come Brave o Edge.
  • I profili existing-session mantengono gli attuali limiti di route Chrome MCP: azioni guidate da snapshot/ref invece del targeting tramite selettori CSS, hook di upload di un singolo file, nessun override del timeout delle finestre di dialogo, nessun wait --load networkidle e nessuna responsebody, esportazione PDF, intercettazione dei download o azioni batch.
  • I profili openclaw locali gestiti assegnano automaticamente cdpPort e cdpUrl; imposta cdpUrl esplicitamente solo per CDP remoto.
  • I profili locali gestiti possono impostare executablePath per sovrascrivere il browser.executablePath globale per quel profilo. Usalo per eseguire un profilo in Chrome e un altro in Brave.
  • I profili locali gestiti usano browser.localLaunchTimeoutMs per il rilevamento HTTP Chrome CDP dopo l’avvio del processo e browser.localCdpReadyTimeoutMs per la readiness websocket CDP post-avvio. Aumentali su host più lenti dove Chrome si avvia correttamente ma i controlli di readiness competono con lo startup. Entrambi i valori devono essere interi positivi fino a 120000 ms; i valori di configurazione non validi vengono rifiutati.
  • Ordine di rilevamento automatico: browser predefinito se basato su Chromium → Chrome → Brave → Edge → Chromium → Chrome Canary.
  • browser.executablePath e browser.profiles.<name>.executablePath accettano entrambi ~ e ~/... per la directory home del tuo OS prima dell’avvio di Chromium. Anche userDataDir per profilo sui profili existing-session subisce l’espansione della tilde.
  • Servizio di controllo: solo loopback (porta derivata da gateway.port, predefinita 18791).
  • extraArgs aggiunge flag di avvio extra allo startup locale di Chromium (per esempio --disable-gpu, dimensionamento finestra o flag di debug).

UI

{
  ui: {
    seamColor: "#FF4500",
    assistant: {
      name: "OpenClaw",
      avatar: "CB", // emoji, short text, image URL, or data URI
    },
  },
}
  • seamColor: colore di accento per la chrome UI dell’app nativa (tinta della bolla Talk Mode, ecc.).
  • assistant: override dell’identità della Control UI. Ripiega sull’identità dell’agente attivo.

Gateway

{
  gateway: {
    mode: "local", // local | remote
    port: 18789,
    bind: "loopback",
    auth: {
      mode: "token", // none | token | password | trusted-proxy
      token: "your-token",
      // password: "your-password", // or OPENCLAW_GATEWAY_PASSWORD
      // trustedProxy: { userHeader: "x-forwarded-user" }, // for mode=trusted-proxy; see /gateway/trusted-proxy-auth
      allowTailscale: true,
      rateLimit: {
        maxAttempts: 10,
        windowMs: 60000,
        lockoutMs: 300000,
        exemptLoopback: true,
      },
    },
    tailscale: {
      mode: "off", // off | serve | funnel
      resetOnExit: false,
    },
    controlUi: {
      enabled: true,
      basePath: "/openclaw",
      // root: "dist/control-ui",
      // embedSandbox: "scripts", // strict | scripts | trusted
      // allowExternalEmbedUrls: false, // dangerous: allow absolute external http(s) embed URLs
      // chatMessageMaxWidth: "min(1280px, 82%)", // optional grouped chat message max-width
      // allowedOrigins: ["https://control.example.com"], // required for non-loopback Control UI
      // dangerouslyAllowHostHeaderOriginFallback: false, // dangerous Host-header origin fallback mode
      // allowInsecureAuth: false,
      // dangerouslyDisableDeviceAuth: false,
    },
    remote: {
      url: "ws://gateway.tailnet:18789",
      transport: "ssh", // ssh | direct
      token: "your-token",
      // password: "your-password",
    },
    trustedProxies: ["10.0.0.1"],
    // Optional. Default false.
    allowRealIpFallback: false,
    nodes: {
      pairing: {
        // Optional. Default unset/disabled.
        autoApproveCidrs: ["192.168.1.0/24", "fd00:1234:5678::/64"],
      },
      allowCommands: ["canvas.navigate"],
      denyCommands: ["system.run"],
    },
    tools: {
      // Additional /tools/invoke HTTP denies
      deny: ["browser"],
      // Remove tools from the default HTTP deny list
      allow: ["gateway"],
    },
    push: {
      apns: {
        relay: {
          baseUrl: "https://relay.example.com",
          timeoutMs: 10000,
        },
      },
    },
  },
}
  • mode: local (esegue il gateway) o remote (si connette al gateway remoto). Gateway rifiuta di avviarsi a meno che non sia local.
  • port: singola porta multiplexata per WS + HTTP. Precedenza: --port > OPENCLAW_GATEWAY_PORT > gateway.port > 18789.
  • bind: auto, loopback (predefinito), lan (0.0.0.0), tailnet (solo IP Tailscale) o custom.
  • Alias di bind legacy: usa i valori della modalità bind in gateway.bind (auto, loopback, lan, tailnet, custom), non gli alias host (0.0.0.0, 127.0.0.1, localhost, ::, ::1).
  • Nota Docker: il bind predefinito loopback ascolta su 127.0.0.1 all’interno del container. Con il networking bridge di Docker (-p 18789:18789), il traffico arriva su eth0, quindi il gateway non è raggiungibile. Usa --network host, oppure imposta bind: "lan" (o bind: "custom" con customBindHost: "0.0.0.0") per ascoltare su tutte le interfacce.
  • Autenticazione: richiesta per impostazione predefinita. I bind non-loopback richiedono l’autenticazione del gateway. In pratica questo significa un token/password condiviso o un reverse proxy consapevole dell’identità con gateway.auth.mode: "trusted-proxy". La procedura guidata di onboarding genera un token per impostazione predefinita.
  • Se sono configurati sia gateway.auth.token sia gateway.auth.password (inclusi i SecretRef), imposta esplicitamente gateway.auth.mode su token o password. I flussi di avvio e di installazione/riparazione del servizio falliscono quando entrambi sono configurati e la modalità non è impostata.
  • gateway.auth.mode: "none": modalità esplicita senza autenticazione. Usala solo per configurazioni local loopback attendibili; questa opzione non viene intenzionalmente offerta dai prompt di onboarding.
  • gateway.auth.mode: "trusted-proxy": delega l’autenticazione browser/utente a un reverse proxy consapevole dell’identità e considera attendibili gli header di identità provenienti da gateway.trustedProxies (vedi Autenticazione tramite proxy attendibile). Questa modalità si aspetta per impostazione predefinita una sorgente proxy non-loopback; i reverse proxy loopback sullo stesso host richiedono gateway.auth.trustedProxy.allowLoopback = true esplicito. I chiamanti interni sullo stesso host possono usare gateway.auth.password come fallback diretto locale; gateway.auth.token resta mutuamente esclusivo con la modalità trusted-proxy.
  • gateway.auth.allowTailscale: quando true, gli header di identità Tailscale Serve possono soddisfare l’autenticazione di Control UI/WebSocket (verificata tramite tailscale whois). Gli endpoint HTTP API non usano tale autenticazione tramite header Tailscale; seguono invece la normale modalità di autenticazione HTTP del gateway. Questo flusso senza token presuppone che l’host del gateway sia attendibile. Il valore predefinito è true quando tailscale.mode = "serve".
  • gateway.auth.rateLimit: limitatore opzionale dei tentativi di autenticazione falliti. Si applica per IP client e per ambito di autenticazione (shared-secret e device-token sono tracciati indipendentemente). I tentativi bloccati restituiscono 429 + Retry-After.
    • Nel percorso asincrono Tailscale Serve Control UI, i tentativi falliti per lo stesso {scope, clientIp} vengono serializzati prima della scrittura del fallimento. Di conseguenza, tentativi errati concorrenti dallo stesso client possono attivare il limitatore sulla seconda richiesta invece di passare entrambi in parallelo come semplici mismatch.
    • gateway.auth.rateLimit.exemptLoopback è predefinito a true; impostalo su false quando vuoi intenzionalmente limitare anche il traffico localhost (per configurazioni di test o distribuzioni proxy rigorose).
  • I tentativi di autenticazione WS con origine browser sono sempre limitati con l’esenzione loopback disabilitata (difesa in profondità contro brute force su localhost basati su browser).
  • Su loopback, quei lockout con origine browser sono isolati per valore Origin normalizzato, quindi fallimenti ripetuti da una origine localhost non bloccano automaticamente una origine diversa.
  • tailscale.mode: serve (solo tailnet, bind loopback) o funnel (pubblico, richiede autenticazione).
  • tailscale.preserveFunnel: quando true e tailscale.mode = "serve", OpenClaw controlla tailscale funnel status prima di riapplicare Serve all’avvio e lo salta se una route Funnel configurata esternamente copre già la porta del gateway. Valore predefinito false.
  • controlUi.allowedOrigins: allowlist esplicita delle origini browser per le connessioni WebSocket di Gateway. Richiesta quando sono previsti client browser da origini non-loopback.
  • controlUi.chatMessageMaxWidth: larghezza massima opzionale per i messaggi di chat raggruppati della Control UI. Accetta valori di larghezza CSS vincolati come 960px, 82%, min(1280px, 82%) e calc(100% - 2rem).
  • controlUi.dangerouslyAllowHostHeaderOriginFallback: modalità pericolosa che abilita il fallback dell’origine tramite header Host per distribuzioni che si affidano intenzionalmente a una policy di origine basata sull’header Host.
  • remote.transport: ssh (predefinito) o direct (ws/wss). Per direct, remote.url deve essere ws:// o wss://.
  • OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1: override di emergenza lato client tramite ambiente di processo che consente ws:// in chiaro verso IP di reti private attendibili; il comportamento predefinito resta solo loopback per il testo in chiaro. Non esiste un equivalente in openclaw.json, e configurazioni browser per reti private come browser.ssrfPolicy.dangerouslyAllowPrivateNetwork non influiscono sui client WebSocket di Gateway.
  • gateway.remote.token / .password sono campi credenziali del client remoto. Da soli non configurano l’autenticazione del gateway.
  • gateway.push.apns.relay.baseUrl: URL HTTPS base per il relay APNs esterno usato dalle build iOS ufficiali/TestFlight dopo la pubblicazione delle registrazioni supportate da relay sul gateway. Questo URL deve corrispondere all’URL del relay compilato nella build iOS.
  • gateway.push.apns.relay.timeoutMs: timeout di invio gateway-relay in millisecondi. Valore predefinito 10000.
  • Le registrazioni supportate da relay sono delegate a una specifica identità del gateway. L’app iOS abbinata recupera gateway.identity.get, include tale identità nella registrazione del relay e inoltra al gateway una concessione di invio con ambito di registrazione. Un altro gateway non può riutilizzare quella registrazione memorizzata.
  • OPENCLAW_APNS_RELAY_BASE_URL / OPENCLAW_APNS_RELAY_TIMEOUT_MS: override temporanei via env per la configurazione del relay sopra.
  • OPENCLAW_APNS_RELAY_ALLOW_HTTP=true: via di uscita solo per sviluppo per URL relay HTTP loopback. Gli URL relay di produzione dovrebbero restare su HTTPS.
  • gateway.handshakeTimeoutMs: timeout dell’handshake WebSocket di Gateway pre-autenticazione in millisecondi. Valore predefinito: 15000. OPENCLAW_HANDSHAKE_TIMEOUT_MS ha precedenza quando impostato. Aumentalo su host carichi o a bassa potenza dove i client locali possono connettersi mentre il warmup di avvio si sta ancora stabilizzando.
  • gateway.channelHealthCheckMinutes: intervallo del monitor di salute dei canali in minuti. Imposta 0 per disabilitare globalmente i riavvii del monitor di salute. Valore predefinito: 5.
  • gateway.channelStaleEventThresholdMinutes: soglia di socket obsoleto in minuti. Mantienila maggiore o uguale a gateway.channelHealthCheckMinutes. Valore predefinito: 30.
  • gateway.channelMaxRestartsPerHour: numero massimo di riavvii del monitor di salute per canale/account in un’ora mobile. Valore predefinito: 10.
  • channels.<provider>.healthMonitor.enabled: opt-out per canale dai riavvii del monitor di salute mantenendo abilitato il monitor globale.
  • channels.<provider>.accounts.<accountId>.healthMonitor.enabled: override per account per canali multi-account. Quando impostato, ha precedenza sull’override a livello di canale.
  • I percorsi di chiamata del gateway locale possono usare gateway.remote.* come fallback solo quando gateway.auth.* non è impostato.
  • Se gateway.auth.token / gateway.auth.password è configurato esplicitamente tramite SecretRef e non viene risolto, la risoluzione fallisce in modo chiuso (nessun masking tramite fallback remoto).
  • trustedProxies: IP dei reverse proxy che terminano TLS o iniettano header forwarded-client. Elenca solo proxy che controlli. Le voci loopback restano valide per configurazioni proxy/detect locali sullo stesso host (per esempio Tailscale Serve o un reverse proxy locale), ma non rendono le richieste loopback idonee per gateway.auth.mode: "trusted-proxy".
  • allowRealIpFallback: quando true, il gateway accetta X-Real-IP se X-Forwarded-For è assente. Valore predefinito false per un comportamento fail-closed.
  • gateway.nodes.pairing.autoApproveCidrs: allowlist CIDR/IP opzionale per approvare automaticamente il primo pairing di un dispositivo nodo senza ambiti richiesti. È disabilitata quando non impostata. Questo non approva automaticamente il pairing di operator/browser/Control UI/WebChat e non approva automaticamente upgrade di ruolo, ambito, metadati o chiave pubblica.
  • gateway.nodes.allowCommands / gateway.nodes.denyCommands: modellazione globale allow/deny per i comandi nodo dichiarati dopo il pairing e la valutazione dell’allowlist della piattaforma. Usa allowCommands per abilitare esplicitamente comandi nodo pericolosi come camera.snap, camera.clip e screen.record; denyCommands rimuove un comando anche se un valore predefinito della piattaforma o un allow esplicito lo includerebbe altrimenti. Dopo che un nodo modifica l’elenco di comandi dichiarati, rifiuta e riapprova il pairing di quel dispositivo così il gateway memorizza lo snapshot aggiornato dei comandi.
  • gateway.tools.deny: nomi di strumenti aggiuntivi bloccati per HTTP POST /tools/invoke (estende l’elenco deny predefinito).
  • gateway.tools.allow: rimuove nomi di strumenti dall’elenco deny HTTP predefinito.

Endpoint compatibili con OpenAI

  • Chat Completions: disabilitato per impostazione predefinita. Abilita con gateway.http.endpoints.chatCompletions.enabled: true.
  • Responses API: gateway.http.endpoints.responses.enabled.
  • Rafforzamento dell’input URL di Responses:
    • gateway.http.endpoints.responses.maxUrlParts
    • gateway.http.endpoints.responses.files.urlAllowlist
    • gateway.http.endpoints.responses.images.urlAllowlist Le allowlist vuote sono trattate come non impostate; usa gateway.http.endpoints.responses.files.allowUrl=false e/o gateway.http.endpoints.responses.images.allowUrl=false per disabilitare il recupero degli URL.
  • Header opzionale di rafforzamento della risposta:

Isolamento multi-istanza

Esegui più gateway su un host con porte e directory di stato univoche:
OPENCLAW_CONFIG_PATH=~/.openclaw/a.json \
OPENCLAW_STATE_DIR=~/.openclaw-a \
openclaw gateway --port 19001
Flag di comodità: --dev (usa ~/.openclaw-dev + porta 19001), --profile <name> (usa ~/.openclaw-<name>). Vedi Gateway multipli.

gateway.tls

{
  gateway: {
    tls: {
      enabled: false,
      autoGenerate: false,
      certPath: "/etc/openclaw/tls/server.crt",
      keyPath: "/etc/openclaw/tls/server.key",
      caPath: "/etc/openclaw/tls/ca-bundle.crt",
    },
  },
}
  • enabled: abilita la terminazione TLS sul listener del gateway (HTTPS/WSS) (predefinito: false).
  • autoGenerate: genera automaticamente una coppia certificato/chiave locale autofirmata quando i file espliciti non sono configurati; solo per uso locale/dev.
  • certPath: percorso filesystem del file del certificato TLS.
  • keyPath: percorso filesystem del file della chiave privata TLS; mantieni permessi restrittivi.
  • caPath: percorso opzionale del bundle CA per la verifica client o catene di attendibilità personalizzate.

gateway.reload

{
  gateway: {
    reload: {
      mode: "hybrid", // off | restart | hot | hybrid
      debounceMs: 500,
      deferralTimeoutMs: 300000,
    },
  },
}
  • mode: controlla come le modifiche alla configurazione vengono applicate a runtime.
    • "off": ignora le modifiche live; le modifiche richiedono un riavvio esplicito.
    • "restart": riavvia sempre il processo del gateway al cambio di configurazione.
    • "hot": applica le modifiche nel processo senza riavviare.
    • "hybrid" (predefinito): prova prima il ricaricamento hot; ripiega sul riavvio se necessario.
  • debounceMs: finestra di debounce in ms prima dell’applicazione delle modifiche alla configurazione (intero non negativo).
  • deferralTimeoutMs: tempo massimo opzionale in ms da attendere per le operazioni in corso prima di forzare un riavvio o un ricaricamento hot del canale. Omettilo per usare l’attesa limitata predefinita (300000); imposta 0 per attendere indefinitamente e registrare avvisi periodici di operazioni ancora in sospeso.

Hook

{
  hooks: {
    enabled: true,
    token: "shared-secret",
    path: "/hooks",
    maxBodyBytes: 262144,
    defaultSessionKey: "hook:ingress",
    allowRequestSessionKey: true,
    allowedSessionKeyPrefixes: ["hook:", "hook:gmail:"],
    allowedAgentIds: ["hooks", "main"],
    presets: ["gmail"],
    transformsDir: "~/.openclaw/hooks/transforms",
    mappings: [
      {
        match: { path: "gmail" },
        action: "agent",
        agentId: "hooks",
        wakeMode: "now",
        name: "Gmail",
        sessionKey: "hook:gmail:{{messages[0].id}}",
        messageTemplate: "From: {{messages[0].from}}\nSubject: {{messages[0].subject}}\n{{messages[0].snippet}}",
        deliver: true,
        channel: "last",
        model: "openai/gpt-5.4-mini",
      },
    ],
  },
}
Autenticazione: Authorization: Bearer <token> oppure x-openclaw-token: <token>. I token hook nella stringa di query vengono rifiutati. Note di convalida e sicurezza:
  • hooks.enabled=true richiede un hooks.token non vuoto.
  • hooks.token deve essere distinto da gateway.auth.token; il riutilizzo del token del Gateway viene rifiutato.
  • hooks.path non può essere /; usa un sottopercorso dedicato come /hooks.
  • Se hooks.allowRequestSessionKey=true, limita hooks.allowedSessionKeyPrefixes (per esempio ["hook:"]).
  • Se una mappatura o un preset usa una sessionKey con template, imposta hooks.allowedSessionKeyPrefixes e hooks.allowRequestSessionKey=true. Le chiavi di mappatura statiche non richiedono questa adesione esplicita.
Endpoint:
  • POST /hooks/wake{ text, mode?: "now"|"next-heartbeat" }
  • POST /hooks/agent{ message, name?, agentId?, sessionKey?, wakeMode?, deliver?, channel?, to?, model?, thinking?, timeoutSeconds? }
    • La sessionKey dal payload della richiesta viene accettata solo quando hooks.allowRequestSessionKey=true (predefinito: false).
  • POST /hooks/<name> → risolto tramite hooks.mappings
    • I valori sessionKey di mappatura resi da template vengono trattati come forniti esternamente e richiedono anche hooks.allowRequestSessionKey=true.
  • match.path corrisponde al sottopercorso dopo /hooks (ad es. /hooks/gmailgmail).
  • match.source corrisponde a un campo del payload per percorsi generici.
  • Template come {{messages[0].subject}} leggono dal payload.
  • transform può puntare a un modulo JS/TS che restituisce un’azione hook.
    • transform.module deve essere un percorso relativo e resta all’interno di hooks.transformsDir (i percorsi assoluti e l’attraversamento vengono rifiutati).
    • Mantieni hooks.transformsDir sotto ~/.openclaw/hooks/transforms; le directory Skills dell’area di lavoro vengono rifiutate. Se openclaw doctor segnala questo percorso come non valido, sposta il modulo di trasformazione nella directory delle trasformazioni hook o rimuovi hooks.transformsDir.
  • agentId instrada a un agente specifico; gli ID sconosciuti ripiegano sul valore predefinito.
  • allowedAgentIds: limita l’instradamento esplicito (* o omesso = consenti tutti, [] = nega tutti).
  • defaultSessionKey: chiave di sessione fissa opzionale per le esecuzioni dell’agente hook senza sessionKey esplicita.
  • allowRequestSessionKey: consenti ai chiamanti di /hooks/agent e alle chiavi di sessione di mappatura guidate da template di impostare sessionKey (predefinito: false).
  • allowedSessionKeyPrefixes: allowlist opzionale di prefissi per i valori sessionKey espliciti (richiesta + mappatura), ad es. ["hook:"]. Diventa obbligatoria quando una mappatura o un preset usa una sessionKey con template.
  • deliver: true invia la risposta finale a un canale; channel usa last come valore predefinito.
  • model sovrascrive l’LLM per questa esecuzione hook (deve essere consentito se il catalogo dei modelli è impostato).

Integrazione Gmail

  • Il preset Gmail integrato usa sessionKey: "hook:gmail:{{messages[0].id}}".
  • Se mantieni quell’instradamento per messaggio, imposta hooks.allowRequestSessionKey: true e limita hooks.allowedSessionKeyPrefixes in modo che corrisponda allo spazio dei nomi Gmail, per esempio ["hook:", "hook:gmail:"].
  • Se ti serve hooks.allowRequestSessionKey: false, sovrascrivi il preset con una sessionKey statica invece del valore predefinito con template.
{
  hooks: {
    gmail: {
      account: "openclaw@gmail.com",
      topic: "projects/<project-id>/topics/gog-gmail-watch",
      subscription: "gog-gmail-watch-push",
      pushToken: "shared-push-token",
      hookUrl: "http://127.0.0.1:18789/hooks/gmail",
      includeBody: true,
      maxBytes: 20000,
      renewEveryMinutes: 720,
      serve: { bind: "127.0.0.1", port: 8788, path: "/" },
      tailscale: { mode: "funnel", path: "/gmail-pubsub" },
      model: "openrouter/meta-llama/llama-3.3-70b-instruct:free",
      thinking: "off",
    },
  },
}
  • Il Gateway avvia automaticamente gog gmail watch serve all’avvio quando configurato. Imposta OPENCLAW_SKIP_GMAIL_WATCHER=1 per disabilitare.
  • Non eseguire un gog gmail watch serve separato insieme al Gateway.

Host del Plugin Canvas

{
  plugins: {
    entries: {
      canvas: {
        config: {
          host: {
            root: "~/.openclaw/workspace/canvas",
            liveReload: true,
            // enabled: false, // or OPENCLAW_SKIP_CANVAS_HOST=1
          },
        },
      },
    },
  },
}
  • Serve HTML/CSS/JS e A2UI modificabili dall’agente via HTTP sotto la porta del Gateway:
    • http://<gateway-host>:<gateway.port>/__openclaw__/canvas/
    • http://<gateway-host>:<gateway.port>/__openclaw__/a2ui/
  • Solo locale: mantieni gateway.bind: "loopback" (predefinito).
  • Bind non loopback: le route canvas richiedono l’autenticazione del Gateway (token/password/proxy attendibile), come le altre superfici HTTP del Gateway.
  • Le WebView Node in genere non inviano header di autenticazione; dopo che un nodo è associato e connesso, il Gateway pubblicizza URL di capacità con ambito nodo per l’accesso canvas/A2UI.
  • Gli URL di capacità sono vincolati alla sessione WS attiva del nodo e scadono rapidamente. Il fallback basato su IP non viene usato.
  • Inietta il client di ricaricamento live nell’HTML servito.
  • Crea automaticamente un index.html iniziale quando è vuoto.
  • Serve anche A2UI su /__openclaw__/a2ui/.
  • Le modifiche richiedono il riavvio del Gateway.
  • Disabilita il ricaricamento live per directory grandi o errori EMFILE.

Rilevamento

mDNS (Bonjour)

{
  discovery: {
    mdns: {
      mode: "minimal", // minimal | full | off
    },
  },
}
  • minimal (predefinito quando il Plugin bonjour incluso è abilitato): omette cliPath + sshPort dai record TXT.
  • full: include cliPath + sshPort; la pubblicità multicast LAN richiede comunque che il Plugin bonjour incluso sia abilitato.
  • off: sopprime la pubblicità multicast LAN senza modificare l’abilitazione del Plugin.
  • Il Plugin bonjour incluso si avvia automaticamente sugli host macOS ed è opt-in su Linux, Windows e distribuzioni Gateway containerizzate.
  • Il nome host usa come valore predefinito il nome host di sistema quando è un’etichetta DNS valida, con fallback a openclaw. Sovrascrivi con OPENCLAW_MDNS_HOSTNAME.

Wide-area (DNS-SD)

{
  discovery: {
    wideArea: { enabled: true },
  },
}
Scrive una zona DNS-SD unicast sotto ~/.openclaw/dns/. Per il rilevamento tra reti, abbinala a un server DNS (CoreDNS consigliato) + split DNS Tailscale. Configurazione: openclaw dns setup --apply.

Ambiente

env (variabili di ambiente inline)

{
  env: {
    OPENROUTER_API_KEY: "sk-or-...",
    vars: {
      GROQ_API_KEY: "gsk-...",
    },
    shellEnv: {
      enabled: true,
      timeoutMs: 15000,
    },
  },
}
  • Le variabili di ambiente inline vengono applicate solo se nell’ambiente del processo manca la chiave.
  • File .env: .env nella CWD + ~/.openclaw/.env (nessuno dei due sovrascrive variabili esistenti).
  • shellEnv: importa le chiavi attese mancanti dal profilo della shell di login.
  • Vedi Ambiente per la precedenza completa.

Sostituzione delle variabili di ambiente

Fai riferimento alle variabili di ambiente in qualsiasi stringa di configurazione con ${VAR_NAME}:
{
  gateway: {
    auth: { token: "${OPENCLAW_GATEWAY_TOKEN}" },
  },
}
  • Corrispondono solo nomi maiuscoli: [A-Z_][A-Z0-9_]*.
  • Variabili mancanti/vuote generano un errore al caricamento della configurazione.
  • Esegui l’escape con $${VAR} per un ${VAR} letterale.
  • Funziona con $include.

Segreti

I riferimenti ai segreti sono additivi: i valori in testo normale continuano a funzionare.

SecretRef

Usa una forma di oggetto:
{ source: "env" | "file" | "exec", provider: "default", id: "..." }
Validazione:
  • pattern provider: ^[a-z][a-z0-9_-]{0,63}$
  • pattern id source: "env": ^[A-Z][A-Z0-9_]{0,127}$
  • id source: "file": puntatore JSON assoluto (ad esempio "/providers/openai/apiKey")
  • pattern id source: "exec": ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,255}$
  • Gli id source: "exec" non devono contenere segmenti di percorso delimitati da slash . o .. (ad esempio a/../b viene rifiutato)

Superficie delle credenziali supportata

  • Matrice canonica: Superficie delle credenziali SecretRef
  • secrets apply prende come target i percorsi delle credenziali supportati in openclaw.json.
  • I riferimenti auth-profiles.json sono inclusi nella risoluzione a runtime e nella copertura dell’audit.

Configurazione dei provider di segreti

{
  secrets: {
    providers: {
      default: { source: "env" }, // optional explicit env provider
      filemain: {
        source: "file",
        path: "~/.openclaw/secrets.json",
        mode: "json",
        timeoutMs: 5000,
      },
      vault: {
        source: "exec",
        command: "/usr/local/bin/openclaw-vault-resolver",
        passEnv: ["PATH", "VAULT_ADDR"],
      },
    },
    defaults: {
      env: "default",
      file: "filemain",
      exec: "vault",
    },
  },
}
Note:
  • Il provider file supporta mode: "json" e mode: "singleValue" (id deve essere "value" in modalità singleValue).
  • I percorsi dei provider file ed exec falliscono in modo chiuso quando la verifica ACL di Windows non è disponibile. Imposta allowInsecurePath: true solo per percorsi attendibili che non possono essere verificati.
  • Il provider exec richiede un percorso command assoluto e usa payload di protocollo su stdin/stdout.
  • Per impostazione predefinita, i percorsi dei comandi symlink vengono rifiutati. Imposta allowSymlinkCommand: true per consentire percorsi symlink mentre viene validato il percorso di destinazione risolto.
  • Se trustedDirs è configurato, il controllo trusted-dir si applica al percorso di destinazione risolto.
  • L’ambiente figlio exec è minimo per impostazione predefinita; passa esplicitamente le variabili richieste con passEnv.
  • I riferimenti ai segreti vengono risolti al momento dell’attivazione in uno snapshot in memoria, poi i percorsi di richiesta leggono solo lo snapshot.
  • Il filtro della superficie attiva si applica durante l’attivazione: i riferimenti non risolti su superfici abilitate fanno fallire l’avvio/ricaricamento, mentre le superfici inattive vengono saltate con diagnostica.

Archiviazione dell’autenticazione

{
  auth: {
    profiles: {
      "anthropic:default": { provider: "anthropic", mode: "api_key" },
      "anthropic:work": { provider: "anthropic", mode: "api_key" },
      "openai-codex:personal": { provider: "openai-codex", mode: "oauth" },
    },
    order: {
      anthropic: ["anthropic:default", "anthropic:work"],
      "openai-codex": ["openai-codex:personal"],
    },
  },
}
  • I profili per agente sono archiviati in <agentDir>/auth-profiles.json.
  • auth-profiles.json supporta riferimenti a livello di valore (keyRef per api_key, tokenRef per token) per le modalità di credenziali statiche.
  • Le mappe flat legacy di auth-profiles.json, come { "provider": { "apiKey": "..." } }, non sono un formato a runtime; openclaw doctor --fix le riscrive in profili API-key canonici provider:default con un backup .legacy-flat.*.bak.
  • I profili in modalità OAuth (auth.profiles.<id>.mode = "oauth") non supportano credenziali auth-profile basate su SecretRef.
  • Le credenziali statiche a runtime provengono da snapshot risolti in memoria; le voci legacy statiche di auth.json vengono eliminate quando rilevate.
  • Le importazioni OAuth legacy provengono da ~/.openclaw/credentials/oauth.json.
  • Vedi OAuth.
  • Comportamento a runtime dei segreti e strumenti audit/configure/apply: Gestione dei segreti.

auth.cooldowns

{
  auth: {
    cooldowns: {
      billingBackoffHours: 5,
      billingBackoffHoursByProvider: { anthropic: 3, openai: 8 },
      billingMaxHours: 24,
      authPermanentBackoffMinutes: 10,
      authPermanentMaxMinutes: 60,
      failureWindowHours: 24,
      overloadedProfileRotations: 1,
      overloadedBackoffMs: 0,
      rateLimitedProfileRotations: 1,
    },
  },
}
  • billingBackoffHours: backoff di base in ore quando un profilo fallisce a causa di effettivi errori di fatturazione/credito insufficiente (valore predefinito: 5). Il testo esplicito sulla fatturazione può comunque rientrare qui anche nelle risposte 401/403, ma i matcher di testo specifici del provider restano limitati al provider che li possiede (ad esempio OpenRouter Key limit exceeded). I messaggi HTTP 402 ritentabili relativi alla finestra di utilizzo o ai limiti di spesa di organizzazione/workspace restano invece nel percorso rate_limit.
  • billingBackoffHoursByProvider: override facoltativi per provider per le ore di backoff di fatturazione.
  • billingMaxHours: limite in ore per la crescita esponenziale del backoff di fatturazione (valore predefinito: 24).
  • authPermanentBackoffMinutes: backoff di base in minuti per errori auth_permanent ad alta confidenza (valore predefinito: 10).
  • authPermanentMaxMinutes: limite in minuti per la crescita del backoff auth_permanent (valore predefinito: 60).
  • failureWindowHours: finestra mobile in ore usata per i contatori di backoff (valore predefinito: 24).
  • overloadedProfileRotations: numero massimo di rotazioni dei profili di autenticazione dello stesso provider per errori di sovraccarico prima di passare al fallback del modello (valore predefinito: 1). Forme di provider occupato come ModelNotReadyException rientrano qui.
  • overloadedBackoffMs: ritardo fisso prima di ritentare una rotazione di provider/profilo sovraccarico (valore predefinito: 0).
  • rateLimitedProfileRotations: numero massimo di rotazioni dei profili di autenticazione dello stesso provider per errori di limite di frequenza prima di passare al fallback del modello (valore predefinito: 1). Quel bucket di limite di frequenza include testo con forme specifiche del provider come Too many concurrent requests, ThrottlingException, concurrency limit reached, workers_ai ... quota limit exceeded e resource exhausted.

Registrazione

{
  logging: {
    level: "info",
    file: "/tmp/openclaw/openclaw.log",
    consoleLevel: "info",
    consoleStyle: "pretty", // pretty | compact | json
    redactSensitive: "tools", // off | tools
    redactPatterns: ["\\bTOKEN\\b\\s*[=:]\\s*([\"']?)([^\\s\"']+)\\1"],
  },
}
  • File di log predefinito: /tmp/openclaw/openclaw-YYYY-MM-DD.log.
  • Imposta logging.file per un percorso stabile.
  • consoleLevel passa a debug quando viene usato --verbose.
  • maxFileBytes: dimensione massima del file di log attivo in byte prima della rotazione (intero positivo; valore predefinito: 104857600 = 100 MB). OpenClaw conserva fino a cinque archivi numerati accanto al file attivo.
  • redactSensitive / redactPatterns: mascheramento best-effort per output della console, log su file, record di log OTLP e testo persistito della trascrizione della sessione. redactSensitive: "off" disabilita solo questa policy generale per log/trascrizioni; le superfici di sicurezza UI/strumenti/diagnostica oscurano comunque i segreti prima dell’emissione.

Diagnostica

{
  diagnostics: {
    enabled: true,
    flags: ["telegram.*"],
    stuckSessionWarnMs: 30000,
    stuckSessionAbortMs: 600000,

    otel: {
      enabled: false,
      endpoint: "https://otel-collector.example.com:4318",
      tracesEndpoint: "https://traces.example.com/v1/traces",
      metricsEndpoint: "https://metrics.example.com/v1/metrics",
      logsEndpoint: "https://logs.example.com/v1/logs",
      protocol: "http/protobuf", // http/protobuf | grpc
      headers: { "x-tenant-id": "my-org" },
      serviceName: "openclaw-gateway",
      traces: true,
      metrics: true,
      logs: false,
      sampleRate: 1.0,
      flushIntervalMs: 5000,
      captureContent: {
        enabled: false,
        inputMessages: false,
        outputMessages: false,
        toolInputs: false,
        toolOutputs: false,
        systemPrompt: false,
      },
    },

    cacheTrace: {
      enabled: false,
      filePath: "~/.openclaw/logs/cache-trace.jsonl",
      includeMessages: true,
      includePrompt: true,
      includeSystem: true,
    },
  },
}
  • enabled: interruttore principale per l’output di strumentazione (valore predefinito: true).
  • flags: array di stringhe di flag che abilitano output di log mirato (supporta caratteri jolly come "telegram.*" o "*").
  • stuckSessionWarnMs: soglia di età senza avanzamento in ms per classificare le sessioni di elaborazione di lunga durata come session.long_running, session.stalled o session.stuck. Risposta, strumento, stato, blocco e avanzamento ACP reimpostano il timer; le diagnostiche session.stuck ripetute applicano backoff finché restano invariate.
  • stuckSessionAbortMs: soglia di età senza avanzamento in ms prima che il lavoro attivo bloccato idoneo possa essere svuotato con abort per il ripristino. Quando non è impostata, OpenClaw usa la finestra incorporata estesa più sicura di almeno 10 minuti e 5x stuckSessionWarnMs.
  • otel.enabled: abilita la pipeline di esportazione OpenTelemetry (valore predefinito: false). Per configurazione completa, catalogo dei segnali e modello di privacy, consulta esportazione OpenTelemetry.
  • otel.endpoint: URL del collector per l’esportazione OTel.
  • otel.tracesEndpoint / otel.metricsEndpoint / otel.logsEndpoint: endpoint OTLP facoltativi specifici per segnale. Quando impostati, sostituiscono otel.endpoint solo per quel segnale.
  • otel.protocol: "http/protobuf" (valore predefinito) o "grpc".
  • otel.headers: intestazioni di metadati HTTP/gRPC aggiuntive inviate con le richieste di esportazione OTel.
  • otel.serviceName: nome del servizio per gli attributi della risorsa.
  • otel.traces / otel.metrics / otel.logs: abilitano l’esportazione di tracce, metriche o log.
  • otel.sampleRate: frequenza di campionamento delle tracce 0-1.
  • otel.flushIntervalMs: intervallo periodico di flush della telemetria in ms.
  • otel.captureContent: acquisizione opt-in del contenuto grezzo per gli attributi degli span OTEL. Disattivata per impostazione predefinita. Il booleano true acquisisce contenuto non di sistema di messaggi/strumenti; la forma a oggetto consente di abilitare esplicitamente inputMessages, outputMessages, toolInputs, toolOutputs e systemPrompt.
  • OTEL_SEMCONV_STABILITY_OPT_IN=gen_ai_latest_experimental: interruttore di ambiente per gli attributi provider degli span GenAI sperimentali più recenti. Per impostazione predefinita gli span mantengono l’attributo legacy gen_ai.system per compatibilità; le metriche GenAI usano attributi semantici limitati.
  • OPENCLAW_OTEL_PRELOADED=1: interruttore di ambiente per host che hanno già registrato un SDK OpenTelemetry globale. OpenClaw salta quindi avvio/arresto dell’SDK posseduto dal Plugin mantenendo attivi i listener diagnostici.
  • OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, OTEL_EXPORTER_OTLP_METRICS_ENDPOINT e OTEL_EXPORTER_OTLP_LOGS_ENDPOINT: variabili di ambiente endpoint specifiche per segnale usate quando la chiave di configurazione corrispondente non è impostata.
  • cacheTrace.enabled: registra snapshot della traccia cache per esecuzioni incorporate (valore predefinito: false).
  • cacheTrace.filePath: percorso di output per la cache trace JSONL (valore predefinito: $OPENCLAW_STATE_DIR/logs/cache-trace.jsonl).
  • cacheTrace.includeMessages / includePrompt / includeSystem: controllano cosa è incluso nell’output della cache trace (tutti con valore predefinito: true).

Aggiornamento

{
  update: {
    channel: "stable", // stable | beta | dev
    checkOnStart: true,

    auto: {
      enabled: false,
      stableDelayHours: 6,
      stableJitterHours: 12,
      betaCheckIntervalHours: 1,
    },
  },
}
  • channel: canale di rilascio per installazioni npm/git - "stable", "beta" o "dev".
  • checkOnStart: controlla gli aggiornamenti npm all’avvio del Gateway (valore predefinito: true).
  • auto.enabled: abilita l’aggiornamento automatico in background per installazioni da pacchetto (valore predefinito: false).
  • auto.stableDelayHours: ritardo minimo in ore prima dell’applicazione automatica del canale stable (valore predefinito: 6; max: 168).
  • auto.stableJitterHours: finestra aggiuntiva di distribuzione del rollout del canale stable in ore (valore predefinito: 12; max: 168).
  • auto.betaCheckIntervalHours: frequenza in ore dei controlli del canale beta (valore predefinito: 1; max: 24).

ACP

{
  acp: {
    enabled: true,
    dispatch: { enabled: true },
    backend: "acpx",
    defaultAgent: "main",
    allowedAgents: ["main", "ops"],
    maxConcurrentSessions: 10,

    stream: {
      coalesceIdleMs: 50,
      maxChunkChars: 1000,
      repeatSuppression: true,
      deliveryMode: "live", // live | final_only
      hiddenBoundarySeparator: "paragraph", // none | space | newline | paragraph
      maxOutputChars: 50000,
      maxSessionUpdateChars: 500,
    },

    runtime: {
      ttlMinutes: 30,
    },
  },
}
  • enabled: gate globale della funzionalità ACP (valore predefinito: true; imposta false per nascondere dispatch ACP e affordance di spawn).
  • dispatch.enabled: gate indipendente per il dispatch dei turni di sessione ACP (valore predefinito: true). Imposta false per mantenere disponibili i comandi ACP bloccandone l’esecuzione.
  • backend: id predefinito del backend runtime ACP (deve corrispondere a un Plugin runtime ACP registrato). Installa prima il Plugin backend e, se plugins.allow è impostato, includi l’id del Plugin backend (ad esempio acpx) altrimenti il backend ACP non verrà caricato.
  • defaultAgent: id agente ACP di fallback quando gli spawn non specificano un target esplicito.
  • allowedAgents: allowlist di id agente consentiti per le sessioni runtime ACP; vuoto significa nessuna restrizione aggiuntiva.
  • maxConcurrentSessions: numero massimo di sessioni ACP attive contemporaneamente.
  • stream.coalesceIdleMs: finestra di flush in inattività in ms per il testo in streaming.
  • stream.maxChunkChars: dimensione massima del chunk prima di suddividere la proiezione del blocco in streaming.
  • stream.repeatSuppression: sopprime righe di stato/strumento ripetute per turno (valore predefinito: true).
  • stream.deliveryMode: "live" trasmette in modo incrementale; "final_only" accumula fino agli eventi terminali del turno.
  • stream.hiddenBoundarySeparator: separatore prima del testo visibile dopo eventi strumento nascosti (valore predefinito: "paragraph").
  • stream.maxOutputChars: numero massimo di caratteri dell’output dell’assistente proiettati per turno ACP.
  • stream.maxSessionUpdateChars: numero massimo di caratteri per le righe di stato/aggiornamento ACP proiettate.
  • stream.tagVisibility: record di nomi di tag verso override booleani di visibilità per eventi in streaming.
  • runtime.ttlMinutes: TTL di inattività in minuti per worker di sessione ACP prima della pulizia idonea.
  • runtime.installCommand: comando di installazione facoltativo da eseguire durante il bootstrap di un ambiente runtime ACP.

CLI

{
  cli: {
    banner: {
      taglineMode: "off", // random | default | off
    },
  },
}
  • cli.banner.taglineMode controlla lo stile dello slogan del banner:
    • "random" (valore predefinito): slogan divertenti/stagionali a rotazione.
    • "default": slogan neutro fisso (All your chats, one OpenClaw.).
    • "off": nessun testo di slogan (titolo/versione del banner ancora mostrati).
  • Per nascondere l’intero banner (non solo gli slogan), imposta la variabile di ambiente OPENCLAW_HIDE_BANNER=1.

Procedura guidata

Metadati scritti dai flussi di configurazione guidata CLI (onboard, configure, doctor):
{
  wizard: {
    lastRunAt: "2026-01-01T00:00:00.000Z",
    lastRunVersion: "2026.1.4",
    lastRunCommit: "abc1234",
    lastRunCommand: "configure",
    lastRunMode: "local",
  },
}

Identità

Consulta i campi identità di agents.list in Predefiniti degli agenti.

Bridge (legacy, rimosso)

Le build correnti non includono più il bridge TCP. I nodi si connettono tramite il WebSocket del Gateway. Le chiavi bridge.* non fanno più parte dello schema di configurazione (la validazione fallisce finché non vengono rimosse; openclaw doctor --fix può eliminare le chiavi sconosciute).
{
  "bridge": {
    "enabled": true,
    "port": 18790,
    "bind": "tailnet",
    "tls": {
      "enabled": true,
      "autoGenerate": true
    }
  }
}

Cron

{
  cron: {
    enabled: true,
    maxConcurrentRuns: 2, // cron dispatch + isolated cron agent-turn execution
    webhook: "https://example.invalid/legacy", // deprecated fallback for stored notify:true jobs
    webhookToken: "replace-with-dedicated-token", // optional bearer token for outbound webhook auth
    sessionRetention: "24h", // duration string or false
    runLog: {
      maxBytes: "2mb", // default 2_000_000 bytes
      keepLines: 2000, // default 2000
    },
  },
}
  • sessionRetention: per quanto tempo conservare le sessioni di esecuzione cron isolate completate prima della rimozione da sessions.json. Controlla anche la pulizia delle trascrizioni cron eliminate archiviate. Predefinito: 24h; imposta false per disabilitare.
  • runLog.maxBytes: dimensione massima per file di log di esecuzione (cron/runs/<jobId>.jsonl) prima della rimozione. Predefinito: 2_000_000 byte.
  • runLog.keepLines: righe più recenti conservate quando viene attivata la rimozione del log di esecuzione. Predefinito: 2000.
  • webhookToken: token bearer usato per la consegna POST del Webhook cron (delivery.mode = "webhook"), se omesso non viene inviato alcun header di autenticazione.
  • webhook: URL Webhook legacy di fallback deprecato (http/https) usato solo per i job archiviati che hanno ancora notify: true.

cron.retry

{
  cron: {
    retry: {
      maxAttempts: 3,
      backoffMs: [30000, 60000, 300000],
      retryOn: ["rate_limit", "overloaded", "network", "timeout", "server_error"],
    },
  },
}
  • maxAttempts: numero massimo di tentativi per i job one-shot in caso di errori transitori (predefinito: 3; intervallo: 0-10).
  • backoffMs: array di ritardi di backoff in ms per ogni tentativo (predefinito: [30000, 60000, 300000]; 1-10 voci).
  • retryOn: tipi di errore che attivano i tentativi - "rate_limit", "overloaded", "network", "timeout", "server_error". Ometti per riprovare tutti i tipi transitori.
Si applica solo ai job cron one-shot. I job ricorrenti usano una gestione degli errori separata.

cron.failureAlert

{
  cron: {
    failureAlert: {
      enabled: false,
      after: 3,
      cooldownMs: 3600000,
      includeSkipped: false,
      mode: "announce",
      accountId: "main",
    },
  },
}
  • enabled: abilita gli avvisi di errore per i job cron (predefinito: false).
  • after: errori consecutivi prima dell’invio di un avviso (intero positivo, min: 1).
  • cooldownMs: millisecondi minimi tra avvisi ripetuti per lo stesso job (intero non negativo).
  • includeSkipped: conteggia le esecuzioni saltate consecutive verso la soglia di avviso (predefinito: false). Le esecuzioni saltate sono tracciate separatamente e non influenzano il backoff degli errori di esecuzione.
  • mode: modalità di consegna - "announce" invia tramite un messaggio del canale; "webhook" pubblica sul Webhook configurato.
  • accountId: account opzionale o id del canale per limitare l’ambito della consegna degli avvisi.

cron.failureDestination

{
  cron: {
    failureDestination: {
      mode: "announce",
      channel: "last",
      to: "channel:C1234567890",
      accountId: "main",
    },
  },
}
  • Destinazione predefinita per le notifiche di errore cron su tutti i job.
  • mode: "announce" o "webhook"; il valore predefinito è "announce" quando esistono dati di destinazione sufficienti.
  • channel: override del canale per la consegna announce. "last" riutilizza l’ultimo canale di consegna noto.
  • to: destinazione announce esplicita o URL Webhook. Richiesto per la modalità Webhook.
  • accountId: override opzionale dell’account per la consegna.
  • delivery.failureDestination per job sovrascrive questo valore predefinito globale.
  • Quando non è impostata né una destinazione di errore globale né una per job, i job che consegnano già tramite announce ripiegano su quella destinazione announce primaria in caso di errore.
  • delivery.failureDestination è supportato solo per job sessionTarget="isolated" salvo che il delivery.mode primario del job sia "webhook".
Vedi Job Cron. Le esecuzioni cron isolate sono tracciate come attività in background.

Variabili del modello template per i media

Segnaposto template espansi in tools.media.models[].args:
VariabileDescrizione
{{Body}}Corpo completo del messaggio in ingresso
{{RawBody}}Corpo grezzo (senza wrapper di cronologia/mittente)
{{BodyStripped}}Corpo con menzioni di gruppo rimosse
{{From}}Identificatore del mittente
{{To}}Identificatore della destinazione
{{MessageSid}}id messaggio del canale
{{SessionId}}UUID della sessione corrente
{{IsNewSession}}"true" quando viene creata una nuova sessione
{{MediaUrl}}pseudo-URL del media in ingresso
{{MediaPath}}percorso locale del media
{{MediaType}}tipo di media (immagine/audio/documento/…)
{{Transcript}}trascrizione audio
{{Prompt}}prompt media risolto per le voci CLI
{{MaxChars}}numero massimo di caratteri di output risolto per le voci CLI
{{ChatType}}"direct" o "group"
{{GroupSubject}}oggetto del gruppo (best effort)
{{GroupMembers}}anteprima dei membri del gruppo (best effort)
{{SenderName}}nome visualizzato del mittente (best effort)
{{SenderE164}}numero di telefono del mittente (best effort)
{{Provider}}suggerimento sul provider (whatsapp, telegram, discord, ecc.)

Include di configurazione ($include)

Suddividi la configurazione in più file:
// ~/.openclaw/openclaw.json
{
  gateway: { port: 18789 },
  agents: { $include: "./agents.json5" },
  broadcast: {
    $include: ["./clients/mueller.json5", "./clients/schmidt.json5"],
  },
}
Comportamento di merge:
  • File singolo: sostituisce l’oggetto contenitore.
  • Array di file: merge profondo in ordine (i successivi sovrascrivono i precedenti).
  • Chiavi sorelle: unite dopo gli include (sovrascrivono i valori inclusi).
  • Include annidati: fino a 10 livelli di profondità.
  • Percorsi: risolti rispetto al file che include, ma devono restare all’interno della directory di configurazione di livello superiore (dirname di openclaw.json). Le forme assolute/../ sono consentite solo quando si risolvono comunque all’interno di quel limite.
  • Le scritture di proprietà di OpenClaw che modificano solo una sezione di livello superiore supportata da un include a file singolo scrivono direttamente in quel file incluso. Ad esempio, plugins install aggiorna plugins: { $include: "./plugins.json5" } in plugins.json5 e lascia intatto openclaw.json.
  • Gli include radice, gli array di include e gli include con override di chiavi sorelle sono di sola lettura per le scritture di proprietà di OpenClaw; tali scritture falliscono in modo chiuso invece di appiattire la configurazione.
  • Errori: messaggi chiari per file mancanti, errori di parsing e include circolari.

Correlati: Configurazione · Esempi di configurazione · Doctor

Correlati