TaskFlow
DashboardFreewriteWhiteboardsProjectsCRMTasksNotificationsSettingsAgent TowerAPI Docs
OpenClaw Docs
?

User

Member

Caricamento in corso...

Home
Progetti
Task
Notifiche
CRM

    OpenClaw

    Documentation Mirror

    Documentation Overview

    Docs

    Auth credential semantics
    Scheduled tasks
    Hooks
    Automation & tasks
    Standing orders
    Task flow
    Background tasks
    BlueBubbles
    Broadcast groups
    Channel routing
    Discord
    Feishu
    Google Chat
    Group messages
    Groups
    iMessage
    Chat channels
    IRC
    LINE
    Channel location parsing
    Matrix
    Matrix migration
    Matrix push rules for quiet previews
    Mattermost
    Microsoft Teams
    Nextcloud Talk
    Nostr
    Pairing
    QA channel
    QQ bot
    Signal
    Slack
    Synology Chat
    Telegram
    Tlon
    Channel troubleshooting
    Twitch
    WeChat
    WhatsApp
    Yuanbao
    Zalo
    Zalo personal
    CI pipeline
    ACP
    Agent
    Agents
    Approvals
    Backup
    Browser
    Channels
    Clawbot
    `openclaw commitments`
    Completion
    Config
    Configure
    Cron
    Daemon
    Dashboard
    Devices
    Directory
    DNS
    Docs
    Doctor
    Flows (redirect)
    Gateway
    Health
    Hooks
    CLI reference
    Inference CLI
    Logs
    MCP
    Memory
    Message
    Migrate
    Models
    Node
    Nodes
    Onboard
    Pairing
    Plugins
    Proxy
    QR
    Reset
    Sandbox CLI
    Secrets
    Security
    Sessions
    Setup
    Skills
    Status
    System
    `openclaw tasks`
    TUI
    Uninstall
    Update
    Voicecall
    Webhooks
    Wiki
    Active memory
    Agent runtime
    Agent loop
    Agent runtimes
    Agent workspace
    Gateway architecture
    Channel docking
    Inferred commitments
    Compaction
    Context
    Context engine
    Delegate architecture
    Dreaming
    Experimental features
    Features
    Markdown formatting
    Memory overview
    Builtin memory engine
    Honcho memory
    QMD memory engine
    Memory search
    Messages
    Model failover
    Model providers
    Models CLI
    Multi-agent routing
    OAuth
    OpenClaw App SDK
    Presence
    QA overview
    Matrix QA
    Command queue
    Steering queue
    Retry policy
    Session management
    Session pruning
    Session tools
    SOUL.md personality guide
    Streaming and chunking
    System prompt
    Timezones
    TypeBox
    Typing indicators
    Usage tracking
    Date and time
    Node + tsx crash
    Diagnostics flags
    Authentication
    Background exec and process tool
    Bonjour discovery
    Bridge protocol
    CLI backends
    Configuration — agents
    Configuration — channels
    Configuration — tools and custom providers
    Configuration
    Configuration examples
    Configuration reference
    Diagnostics export
    Discovery and transports
    Doctor
    Gateway lock
    Health checks
    Heartbeat
    Gateway runbook
    Local models
    Gateway logging
    Multiple gateways
    Network model
    OpenAI chat completions
    OpenResponses API
    OpenShell
    OpenTelemetry export
    Gateway-owned pairing
    Prometheus metrics
    Gateway protocol
    Remote access
    Remote gateway setup
    Sandbox vs tool policy vs elevated
    Sandboxing
    Secrets management
    Secrets apply plan contract
    Security audit checks
    Security
    Tailscale
    Tools invoke API
    Troubleshooting
    Trusted proxy auth
    Debugging
    Environment variables
    FAQ
    FAQ: first-run setup
    FAQ: models and auth
    GPT-5.5 / Codex agentic parity
    GPT-5.5 / Codex parity maintainer notes
    Help
    Scripts
    Testing
    Testing: live suites
    General troubleshooting
    OpenClaw
    Ansible
    Azure
    Bun (experimental)
    ClawDock
    Release channels
    DigitalOcean
    Docker
    Docker VM runtime
    exe.dev
    Fly.io
    GCP
    Hetzner
    Hostinger
    Install
    Installer internals
    Kubernetes
    macOS VMs
    Migration guide
    Migrating from Claude
    Migrating from Hermes
    Nix
    Node.js
    Northflank
    Oracle Cloud
    Podman
    Railway
    Raspberry Pi
    Render
    Uninstall
    Updating
    Logging
    Network
    Audio and voice notes
    Camera capture
    Image and media support
    Nodes
    Location command
    Media understanding
    Talk mode
    Node troubleshooting
    Voice wake
    Pi integration architecture
    Pi development workflow
    Android app
    Platforms
    iOS app
    Linux app
    Gateway on macOS
    Canvas
    Gateway lifecycle
    macOS dev setup
    Health checks (macOS)
    Menu bar icon
    macOS logging
    Menu bar
    Peekaboo bridge
    macOS permissions
    Remote control
    macOS signing
    Skills (macOS)
    Voice overlay
    Voice wake (macOS)
    WebChat (macOS)
    macOS IPC
    macOS app
    Windows
    Plugin internals
    Plugin architecture internals
    Building plugins
    Plugin bundles
    Codex Computer Use
    Codex harness
    Community plugins
    Plugin compatibility
    Google Meet plugin
    Plugin hooks
    Plugin manifest
    Memory LanceDB
    Memory wiki
    Message presentation
    Agent harness plugins
    Building channel plugins
    Channel turn kernel
    Plugin entry points
    Plugin SDK migration
    Plugin SDK overview
    Building provider plugins
    Plugin runtime helpers
    Plugin setup and config
    Plugin SDK subpaths
    Plugin testing
    Skill workshop plugin
    Voice call plugin
    Webhooks plugin
    Zalo personal plugin
    OpenProse
    Alibaba Model Studio
    Anthropic
    Arcee AI
    Azure Speech
    Amazon Bedrock
    Amazon Bedrock Mantle
    Chutes
    Claude Max API proxy
    Cloudflare AI gateway
    ComfyUI
    Deepgram
    Deepinfra
    DeepSeek
    ElevenLabs
    Fal
    Fireworks
    GitHub Copilot
    GLM (Zhipu)
    Google (Gemini)
    Gradium
    Groq
    Hugging Face (inference)
    Provider directory
    Inferrs
    Inworld
    Kilocode
    LiteLLM
    LM Studio
    MiniMax
    Mistral
    Model provider quickstart
    Moonshot AI
    NVIDIA
    Ollama
    OpenAI
    OpenCode
    OpenCode Go
    OpenRouter
    Perplexity
    Qianfan
    Qwen
    Runway
    SGLang
    StepFun
    Synthetic
    Tencent Cloud (TokenHub)
    Together AI
    Venice AI
    Vercel AI gateway
    vLLM
    Volcengine (Doubao)
    Vydra
    xAI
    Xiaomi MiMo
    Z.AI
    Default AGENTS.md
    Release policy
    API usage and costs
    Credits
    Device model database
    Full release validation
    Memory configuration reference
    OpenClaw App SDK API design
    Prompt caching
    Rich output protocol
    RPC adapters
    SecretRef credential surface
    Session management deep dive
    AGENTS.md template
    BOOT.md template
    BOOTSTRAP.md template
    HEARTBEAT.md template
    IDENTITY template
    SOUL.md template
    TOOLS.md template
    USER template
    Tests
    Token use and costs
    Transcript hygiene
    Onboarding reference
    Contributing to the threat model
    Threat model (MITRE ATLAS)
    Formal verification (security models)
    Network proxy
    Agent bootstrapping
    Docs directory
    Getting started
    Docs hubs
    OpenClaw lore
    Onboarding (macOS app)
    Onboarding overview
    Personal assistant setup
    Setup
    Showcase
    Onboarding (CLI)
    CLI automation
    CLI setup reference
    ACP agents
    ACP agents — setup
    Agent send
    apply_patch tool
    Brave search
    Browser (OpenClaw-managed)
    Browser control API
    Browser troubleshooting
    Browser login
    WSL2 + Windows + remote Chrome CDP troubleshooting
    BTW side questions
    ClawHub
    Code execution
    Creating skills
    Diffs
    DuckDuckGo search
    Elevated mode
    Exa search
    Exec tool
    Exec approvals
    Exec approvals — advanced
    Firecrawl
    Gemini search
    Grok search
    Image generation
    Tools and plugins
    Kimi search
    LLM task
    Lobster
    Tool-loop detection
    Media overview
    MiniMax search
    Multi-agent sandbox and tools
    Music generation
    Ollama web search
    PDF tool
    Perplexity search
    Plugins
    Reactions
    SearXNG search
    Skills
    Skills config
    Slash commands
    Sub-agents
    Tavily
    Thinking levels
    Tokenjuice
    Trajectory bundles
    Text-to-speech
    Video generation
    Web search
    Web fetch
    Linux server
    Control UI
    Dashboard
    Web
    TUI
    WebChat

    OpenAPI Specs

    openapi
    TaskFlow
    docs/openclaw
    Original Docs

    Real-time Synchronized Documentation

    Last sync: 01/05/2026 07:00:01

    Note: This content is mirrored from docs.openclaw.ai and is subject to their terms and conditions.

    OpenClaw Docs

    v2.4.0 Production

    Last synced: Today, 22:00

    Technical reference for the OpenClaw framework. Real-time synchronization with the official documentation engine.

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

    Network proxy

    Network Proxy

    OpenClaw can route runtime HTTP and WebSocket traffic through an operator-managed forward proxy. This is optional defense in depth for deployments that want central egress control, stronger SSRF protection, and better network auditability.

    OpenClaw does not ship, download, start, configure, or certify a proxy. You run the proxy technology that fits your environment, and OpenClaw routes normal process-local HTTP and WebSocket clients through it.

    Why Use a Proxy?

    A proxy gives operators one network control point for outbound HTTP and WebSocket traffic. That can be useful even outside SSRF hardening:

    • Central policy: maintain one egress policy instead of relying on every application HTTP call site to get network rules right.
    • Connect-time checks: evaluate the destination after DNS resolution and immediately before the proxy opens the upstream connection.
    • DNS rebinding defense: reduce the gap between an application-level DNS check and the actual outbound connection.
    • Broader JavaScript coverage: route ordinary
      text
      fetch
      ,
      text
      node:http
      ,
      text
      node:https
      , WebSocket, axios, got, node-fetch, and similar clients through the same path.
    • Auditability: log allowed and denied destinations at the egress boundary.
    • Operational control: enforce destination rules, network segmentation, rate limits, or outbound allowlists without rebuilding OpenClaw.

    Proxy routing is a process-level guardrail for normal HTTP and WebSocket egress. It gives operators a fail-closed path for routing supported JavaScript HTTP clients through their own filtering proxy, but it is not an OS-level network sandbox and does not make OpenClaw certify the proxy's destination policy.

    How OpenClaw Routes Traffic

    When

    text
    proxy.enabled=true
    and a proxy URL is configured, protected runtime processes such as
    text
    openclaw gateway run
    ,
    text
    openclaw node run
    , and
    text
    openclaw agent --local
    route normal HTTP and WebSocket egress through the configured proxy:

    text
    OpenClaw process fetch -> operator-managed filtering proxy -> public internet node:http and https -> operator-managed filtering proxy -> public internet WebSocket clients -> operator-managed filtering proxy -> public internet

    The public contract is the routing behavior, not the internal Node hooks used to implement it. OpenClaw Gateway control-plane WebSocket clients use a narrow direct path for local loopback Gateway RPC traffic when the Gateway URL uses

    text
    localhost
    or a literal loopback IP such as
    text
    127.0.0.1
    or
    text
    [::1]
    . That control-plane path must be able to reach loopback Gateways even when the operator proxy blocks loopback destinations. Normal runtime HTTP and WebSocket requests still use the configured proxy.

    Internally, OpenClaw uses two process-level routing hooks for this feature:

    • Undici dispatcher routing covers
      text
      fetch
      , undici-backed clients, and transports that provide their own undici dispatcher.
    • text
      global-agent
      routing covers Node core
      text
      node:http
      and
      text
      node:https
      callers, including many libraries layered on
      text
      http.request
      ,
      text
      https.request
      ,
      text
      http.get
      , and
      text
      https.get
      . Managed proxy mode forces that global agent so explicit Node HTTP agents do not accidentally bypass the operator proxy.

    Some plugins own custom transports that need explicit proxy wiring even when process-level routing exists. For example, Telegram's Bot API transport uses its own HTTP/1 undici dispatcher and therefore honors process proxy env plus the managed

    text
    OPENCLAW_PROXY_URL
    fallback in that owner-specific transport path.

    The proxy URL itself must use

    text
    http://
    . HTTPS destinations are still supported through the proxy with HTTP
    text
    CONNECT
    ; this only means OpenClaw expects a plain HTTP forward-proxy listener such as
    text
    http://127.0.0.1:3128
    .

    While the proxy is active, OpenClaw clears

    text
    no_proxy
    ,
    text
    NO_PROXY
    , and
    text
    GLOBAL_AGENT_NO_PROXY
    . Those bypass lists are destination-based, so leaving
    text
    localhost
    or
    text
    127.0.0.1
    there would let high-risk SSRF targets skip the filtering proxy.

    On shutdown, OpenClaw restores the previous proxy environment and resets cached process routing state.

    Related Proxy Terms

    • text
      proxy.enabled
      /
      text
      proxy.proxyUrl
      : outbound forward-proxy routing for OpenClaw runtime egress. This page documents that feature.
    • text
      gateway.auth.mode: "trusted-proxy"
      : inbound identity-aware reverse-proxy authentication for Gateway access. See Trusted proxy auth.
    • text
      openclaw proxy
      : local debug proxy and capture inspector for development and support. See openclaw proxy.
    • Channel or provider-specific proxy settings: owner-specific overrides for a particular transport. Prefer the managed network proxy when the goal is central egress control across the runtime.

    Configuration

    yaml
    proxy: enabled: true proxyUrl: http://127.0.0.1:3128

    You can also provide the URL through the environment, while keeping

    text
    proxy.enabled=true
    in config:

    bash
    OPENCLAW_PROXY_URL=http://127.0.0.1:3128 openclaw gateway run

    text
    proxy.proxyUrl
    takes precedence over
    text
    OPENCLAW_PROXY_URL
    .

    If

    text
    enabled=true
    but no valid proxy URL is configured, protected commands fail startup instead of falling back to direct network access.

    For managed gateway services started with

    text
    openclaw gateway start
    , prefer storing the URL in config:

    bash
    openclaw config set proxy.enabled true openclaw config set proxy.proxyUrl http://127.0.0.1:3128 openclaw gateway install --force openclaw gateway start

    The environment fallback is best for foreground runs. If you use it with an installed service, put

    text
    OPENCLAW_PROXY_URL
    in the service durable environment, such as
    text
    $OPENCLAW_STATE_DIR/.env
    or
    text
    ~/.openclaw/.env
    , then reinstall the service so launchd, systemd, or Scheduled Tasks starts the gateway with that value.

    For

    text
    openclaw --container ...
    commands, OpenClaw forwards
    text
    OPENCLAW_PROXY_URL
    into the container-targeted child CLI when it is set. The URL must be reachable from inside the container;
    text
    127.0.0.1
    refers to the container itself, not the host. OpenClaw rejects loopback proxy URLs for container-targeted commands unless you explicitly override that safety check.

    Proxy Requirements

    The proxy policy is the security boundary. OpenClaw cannot verify that the proxy blocks the right targets.

    Configure the proxy to:

    • Bind only to loopback or a private trusted interface.
    • Restrict access so only the OpenClaw process, host, container, or service account can use it.
    • Resolve destinations itself and block destination IPs after DNS resolution.
    • Apply policy at connect time for both plain HTTP requests and HTTPS
      text
      CONNECT
      tunnels.
    • Reject destination-based bypasses for loopback, private, link-local, metadata, multicast, reserved, or documentation ranges.
    • Avoid hostname allowlists unless you fully trust the DNS resolution path.
    • Log destination, decision, status, and reason without logging request bodies, authorization headers, cookies, or other secrets.
    • Keep proxy policy under version control and review changes like security-sensitive configuration.

    Recommended Blocked Destinations

    Use this denylist as the starting point for any forward proxy, firewall, or egress policy.

    OpenClaw application-level classifier logic lives in

    text
    src/infra/net/ssrf.ts
    and
    text
    src/shared/net/ip.ts
    . The relevant parity hooks are
    text
    BLOCKED_HOSTNAMES
    ,
    text
    BLOCKED_IPV4_SPECIAL_USE_RANGES
    ,
    text
    BLOCKED_IPV6_SPECIAL_USE_RANGES
    ,
    text
    RFC2544_BENCHMARK_PREFIX
    , and the embedded IPv4 sentinel handling for NAT64, 6to4, Teredo, ISATAP, and IPv4-mapped forms. Those files are useful references when maintaining an external proxy policy, but OpenClaw does not automatically export or enforce those rules in your proxy.

    Range or hostWhy to block
    text
    127.0.0.0/8
    ,
    text
    localhost
    ,
    text
    localhost.localdomain
    IPv4 loopback
    text
    ::1/128
    IPv6 loopback
    text
    0.0.0.0/8
    ,
    text
    ::/128
    Unspecified and this-network addresses
    text
    10.0.0.0/8
    ,
    text
    172.16.0.0/12
    ,
    text
    192.168.0.0/16
    RFC1918 private networks
    text
    169.254.0.0/16
    ,
    text
    fe80::/10
    Link-local addresses and common cloud metadata paths
    text
    169.254.169.254
    ,
    text
    metadata.google.internal
    Cloud metadata services
    text
    100.64.0.0/10
    Carrier-grade NAT shared address space
    text
    198.18.0.0/15
    ,
    text
    2001:2::/48
    Benchmarking ranges
    text
    192.0.0.0/24
    ,
    text
    192.0.2.0/24
    ,
    text
    198.51.100.0/24
    ,
    text
    203.0.113.0/24
    ,
    text
    2001:db8::/32
    Special-use and documentation ranges
    text
    224.0.0.0/4
    ,
    text
    ff00::/8
    Multicast
    text
    240.0.0.0/4
    Reserved IPv4
    text
    fc00::/7
    ,
    text
    fec0::/10
    IPv6 local/private ranges
    text
    100::/64
    ,
    text
    2001:20::/28
    IPv6 discard and ORCHIDv2 ranges
    text
    64:ff9b::/96
    ,
    text
    64:ff9b:1::/48
    NAT64 prefixes with embedded IPv4
    text
    2002::/16
    ,
    text
    2001::/32
    6to4 and Teredo with embedded IPv4
    text
    ::/96
    ,
    text
    ::ffff:0:0/96
    IPv4-compatible and IPv4-mapped IPv6

    If your cloud provider or network platform documents additional metadata hosts or reserved ranges, add those too.

    Validation

    Validate the proxy from the same host, container, or service account that runs OpenClaw:

    bash
    openclaw proxy validate --proxy-url http://127.0.0.1:3128

    By default, when no custom destinations are provided, the command checks that

    text
    https://example.com/
    succeeds and starts a temporary loopback canary that the proxy must not reach. The default denied check passes when the proxy returns a non-2xx denial response or blocks the canary with a transport failure; it fails if a successful response reaches the canary. If no proxy is enabled and configured, validation reports a config problem; use
    text
    --proxy-url
    for a one-off preflight before changing config. Use
    text
    --allowed-url
    and
    text
    --denied-url
    to test deployment-specific expectations. Custom denied destinations are fail-closed: any HTTP response means the destination was reachable through the proxy, and any transport error is reported as inconclusive because OpenClaw cannot prove the proxy blocked a reachable origin. On validation failure, the command exits with code 1.

    Use

    text
    --json
    for automation. The JSON output contains the overall result, the effective proxy config source, any config errors, and each destination check. Proxy URL credentials are redacted in text and JSON output:

    json
    { "ok": true, "config": { "enabled": true, "proxyUrl": "http://127.0.0.1:3128/", "source": "override", "errors": [] }, "checks": [ { "kind": "allowed", "url": "https://example.com/", "ok": true, "status": 200 } ] }

    You can also validate manually with

    text
    curl
    :

    bash
    curl -x http://127.0.0.1:3128 https://example.com/ curl -x http://127.0.0.1:3128 http://127.0.0.1/ curl -x http://127.0.0.1:3128 http://169.254.169.254/

    The public request should succeed. The loopback and metadata requests should be blocked by the proxy. For

    text
    openclaw proxy validate
    , the built-in loopback canary can distinguish a proxy denial from a reachable origin. Custom
    text
    --denied-url
    checks do not have that canary, so treat both HTTP responses and ambiguous transport failures as validation failures unless your proxy exposes a deployment-specific denial signal you can verify separately.

    Then enable OpenClaw proxy routing:

    bash
    openclaw config set proxy.enabled true openclaw config set proxy.proxyUrl http://127.0.0.1:3128 openclaw gateway run

    or set:

    yaml
    proxy: enabled: true proxyUrl: http://127.0.0.1:3128

    Limits

    • The proxy improves coverage for process-local JavaScript HTTP and WebSocket clients, but it is not an OS-level network sandbox.
    • Raw
      text
      net
      ,
      text
      tls
      , and
      text
      http2
      sockets, native addons, and child processes may bypass Node-level proxy routing unless they inherit and respect proxy environment variables.
    • User local WebUIs and local model servers should be allowlisted in the operator proxy policy when needed; OpenClaw does not expose a general local-network bypass for them.
    • Gateway control-plane proxy bypass is intentionally limited to
      text
      localhost
      and literal loopback IP URLs. Use
      text
      ws://127.0.0.1:18789
      ,
      text
      ws://[::1]:18789
      , or
      text
      ws://localhost:18789
      for local direct Gateway control-plane connections; other hostnames route like ordinary hostname-based traffic.
    • OpenClaw does not inspect, test, or certify your proxy policy.
    • Treat proxy policy changes as security-sensitive operational changes.

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine