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:01:44

    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.

    Fly.io

    Fly.io Deployment

    Goal: OpenClaw Gateway running on a Fly.io machine with persistent storage, automatic HTTPS, and Discord/channel access.

    What you need

    • flyctl CLI installed
    • Fly.io account (free tier works)
    • Model auth: API key for your chosen model provider
    • Channel credentials: Discord bot token, Telegram token, etc.

    Beginner quick path

    1. Clone repo → customize
      text
      fly.toml
    2. Create app + volume → set secrets
    3. Deploy with
      text
      fly deploy
    4. SSH in to create config or use Control UI

    Create the Fly app

    ```bash} # Clone the repo git clone https://github.com/openclaw/openclaw.git cd openclaw
    text
    # Create a new Fly app (pick your own name) fly apps create my-openclaw # Create a persistent volume (1GB is usually enough) fly volumes create openclaw_data --size 1 --region iad ``` **Tip:** Choose a region close to you. Common options: `lhr` (London), `iad` (Virginia), `sjc` (San Jose).

    Configure fly.toml

    Edit `fly.toml` to match your app name and requirements.
    text
    **Security note:** The default config exposes a public URL. For a hardened deployment with no public IP, see [Private Deployment](#private-deployment-hardened) or use `fly.private.toml`. ```toml} app = "my-openclaw" # Your app name primary_region = "iad" [build] dockerfile = "Dockerfile" [env] NODE_ENV = "production" OPENCLAW_PREFER_PNPM = "1" OPENCLAW_STATE_DIR = "/data" NODE_OPTIONS = "--max-old-space-size=1536" [processes] app = "node dist/index.js gateway --allow-unconfigured --port 3000 --bind lan" [http_service] internal_port = 3000 force_https = true auto_stop_machines = false auto_start_machines = true min_machines_running = 1 processes = ["app"] [[vm]] size = "shared-cpu-2x" memory = "2048mb" [mounts] source = "openclaw_data" destination = "/data" ``` **Key settings:** | Setting | Why | | ------------------------------ | --------------------------------------------------------------------------- | | `--bind lan` | Binds to `0.0.0.0` so Fly's proxy can reach the gateway | | `--allow-unconfigured` | Starts without a config file (you'll create one after) | | `internal_port = 3000` | Must match `--port 3000` (or `OPENCLAW_GATEWAY_PORT`) for Fly health checks | | `memory = "2048mb"` | 512MB is too small; 2GB recommended | | `OPENCLAW_STATE_DIR = "/data"` | Persists state on the volume |

    Set secrets

    ```bash} # Required: Gateway token (for non-loopback binding) fly secrets set OPENCLAW_GATEWAY_TOKEN=$(openssl rand -hex 32)
    text
    # Model provider API keys fly secrets set ANTHROPIC_API_KEY=sk-ant-... # Optional: Other providers fly secrets set OPENAI_API_KEY=sk-... fly secrets set GOOGLE_API_KEY=... # Channel tokens fly secrets set DISCORD_BOT_TOKEN=MTQ... ``` **Notes:** * Non-loopback binds (`--bind lan`) require a valid gateway auth path. This Fly.io example uses `OPENCLAW_GATEWAY_TOKEN`, but `gateway.auth.password` or a correctly configured non-loopback `trusted-proxy` deployment also satisfy the requirement. * Treat these tokens like passwords. * **Prefer env vars over config file** for all API keys and tokens. This keeps secrets out of `openclaw.json` where they could be accidentally exposed or logged.

    Deploy

    ```bash} fly deploy ```
    text
    First deploy builds the Docker image (\~2-3 minutes). Subsequent deploys are faster. After deployment, verify: ```bash} fly status fly logs ``` You should see: ``` [gateway] listening on ws://0.0.0.0:3000 (PID xxx) [discord] logged in to discord as xxx ```

    Create config file

    SSH into the machine to create a proper config:
    text
    ```bash} fly ssh console ``` Create the config directory and file: ```bash} mkdir -p /data cat > /data/openclaw.json << 'EOF' { "agents": { "defaults": { "model": { "primary": "anthropic/claude-opus-4-6", "fallbacks": ["anthropic/claude-sonnet-4-6", "openai/gpt-5.4"] }, "maxConcurrent": 4 }, "list": [ { "id": "main", "default": true } ] }, "auth": { "profiles": { "anthropic:default": { "mode": "token", "provider": "anthropic" }, "openai:default": { "mode": "token", "provider": "openai" } } }, "bindings": [ { "agentId": "main", "match": { "channel": "discord" } } ], "channels": { "discord": { "enabled": true, "groupPolicy": "allowlist", "guilds": { "YOUR_GUILD_ID": { "channels": { "general": { "allow": true } }, "requireMention": false } } } }, "gateway": { "mode": "local", "bind": "auto", "controlUi": { "allowedOrigins": [ "https://my-openclaw.fly.dev", "http://localhost:3000", "http://127.0.0.1:3000" ] } }, "meta": {} } EOF ``` **Note:** With `OPENCLAW_STATE_DIR=/data`, the config path is `/data/openclaw.json`. **Note:** Replace `https://my-openclaw.fly.dev` with your real Fly app origin. Gateway startup seeds local Control UI origins from the runtime `--bind` and `--port` values so first boot can proceed before config exists, but browser access through Fly still needs the exact HTTPS origin listed in `gateway.controlUi.allowedOrigins`. **Note:** The Discord token can come from either: * Environment variable: `DISCORD_BOT_TOKEN` (recommended for secrets) * Config file: `channels.discord.token` If using env var, no need to add token to config. The gateway reads `DISCORD_BOT_TOKEN` automatically. Restart to apply: ```bash} exit fly machine restart <machine-id> ```

    Access the Gateway

    ### Control UI
    text
    Open in browser: ```bash} fly open ``` Or visit `https://my-openclaw.fly.dev/` Authenticate with the configured shared secret. This guide uses the gateway token from `OPENCLAW_GATEWAY_TOKEN`; if you switched to password auth, use that password instead. ### Logs ```bash} fly logs # Live logs fly logs --no-tail # Recent logs ``` ### SSH Console ```bash} fly ssh console ```

    Troubleshooting

    "App is not listening on expected address"

    The gateway is binding to

    text
    127.0.0.1
    instead of
    text
    0.0.0.0
    .

    Fix: Add

    text
    --bind lan
    to your process command in
    text
    fly.toml
    .

    Health checks failing / connection refused

    Fly can't reach the gateway on the configured port.

    Fix: Ensure

    text
    internal_port
    matches the gateway port (set
    text
    --port 3000
    or
    text
    OPENCLAW_GATEWAY_PORT=3000
    ).

    OOM / Memory Issues

    Container keeps restarting or getting killed. Signs:

    text
    SIGABRT
    ,
    text
    v8::internal::Runtime_AllocateInYoungGeneration
    , or silent restarts.

    Fix: Increase memory in

    text
    fly.toml
    :

    toml
    [[vm]] memory = "2048mb"

    Or update an existing machine:

    bash
    fly machine update <machine-id> --vm-memory 2048 -y

    Note: 512MB is too small. 1GB may work but can OOM under load or with verbose logging. 2GB is recommended.

    Gateway lock issues

    Gateway refuses to start with "already running" errors.

    This happens when the container restarts but the PID lock file persists on the volume.

    Fix: Delete the lock file:

    bash
    fly ssh console --command "rm -f /data/gateway.*.lock" fly machine restart <machine-id>

    The lock file is at

    text
    /data/gateway.*.lock
    (not in a subdirectory).

    Config not being read

    text
    --allow-unconfigured
    only bypasses the startup guard. It does not create or repair
    text
    /data/openclaw.json
    , so make sure your real config exists and includes
    text
    gateway.mode="local"
    when you want a normal local gateway start.

    Verify the config exists:

    bash
    fly ssh console --command "cat /data/openclaw.json"

    Writing config via SSH

    The

    text
    fly ssh console -C
    command doesn't support shell redirection. To write a config file:

    bash
    # Use echo + tee (pipe from local to remote) echo '{"your":"config"}' | fly ssh console -C "tee /data/openclaw.json" # Or use sftp fly sftp shell > put /local/path/config.json /data/openclaw.json

    Note:

    text
    fly sftp
    may fail if the file already exists. Delete first:

    bash
    fly ssh console --command "rm /data/openclaw.json"

    State not persisting

    If you lose auth profiles, channel/provider state, or sessions after a restart, the state dir is writing to the container filesystem.

    Fix: Ensure

    text
    OPENCLAW_STATE_DIR=/data
    is set in
    text
    fly.toml
    and redeploy.

    Updates

    bash
    # Pull latest changes git pull # Redeploy fly deploy # Check health fly status fly logs

    Updating machine command

    If you need to change the startup command without a full redeploy:

    bash
    # Get machine ID fly machines list # Update command fly machine update <machine-id> --command "node dist/index.js gateway --port 3000 --bind lan" -y # Or with memory increase fly machine update <machine-id> --vm-memory 2048 --command "node dist/index.js gateway --port 3000 --bind lan" -y

    Note: After

    text
    fly deploy
    , the machine command may reset to what's in
    text
    fly.toml
    . If you made manual changes, re-apply them after deploy.

    Private deployment (hardened)

    By default, Fly allocates public IPs, making your gateway accessible at

    text
    https://your-app.fly.dev
    . This is convenient but means your deployment is discoverable by internet scanners (Shodan, Censys, etc.).

    For a hardened deployment with no public exposure, use the private template.

    When to use private deployment

    • You only make outbound calls/messages (no inbound webhooks)
    • You use ngrok or Tailscale tunnels for any webhook callbacks
    • You access the gateway via SSH, proxy, or WireGuard instead of browser
    • You want the deployment hidden from internet scanners

    Setup

    Use

    text
    fly.private.toml
    instead of the standard config:

    bash
    # Deploy with private config fly deploy -c fly.private.toml

    Or convert an existing deployment:

    bash
    # List current IPs fly ips list -a my-openclaw # Release public IPs fly ips release <public-ipv4> -a my-openclaw fly ips release <public-ipv6> -a my-openclaw # Switch to private config so future deploys don't re-allocate public IPs # (remove [http_service] or deploy with the private template) fly deploy -c fly.private.toml # Allocate private-only IPv6 fly ips allocate-v6 --private -a my-openclaw

    After this,

    text
    fly ips list
    should show only a
    text
    private
    type IP:

    text
    VERSION IP TYPE REGION v6 fdaa:x:x:x:x::x private global

    Accessing a private deployment

    Since there's no public URL, use one of these methods:

    Option 1: Local proxy (simplest)

    bash
    # Forward local port 3000 to the app fly proxy 3000:3000 -a my-openclaw # Then open http://localhost:3000 in browser

    Option 2: WireGuard VPN

    bash
    # Create WireGuard config (one-time) fly wireguard create # Import to WireGuard client, then access via internal IPv6 # Example: http://[fdaa:x:x:x:x::x]:3000

    Option 3: SSH only

    bash
    fly ssh console -a my-openclaw

    Webhooks with private deployment

    If you need webhook callbacks (Twilio, Telnyx, etc.) without public exposure:

    1. ngrok tunnel - Run ngrok inside the container or as a sidecar
    2. Tailscale Funnel - Expose specific paths via Tailscale
    3. Outbound-only - Some providers (Twilio) work fine for outbound calls without webhooks

    Example voice-call config with ngrok:

    json5
    { plugins: { entries: { "voice-call": { enabled: true, config: { provider: "twilio", tunnel: { provider: "ngrok" }, webhookSecurity: { allowedHosts: ["example.ngrok.app"], }, }, }, }, }, }

    The ngrok tunnel runs inside the container and provides a public webhook URL without exposing the Fly app itself. Set

    text
    webhookSecurity.allowedHosts
    to the public tunnel hostname so forwarded host headers are accepted.

    Security benefits

    AspectPublicPrivate
    Internet scannersDiscoverableHidden
    Direct attacksPossibleBlocked
    Control UI accessBrowserProxy/VPN
    Webhook deliveryDirectVia tunnel

    Notes

    • Fly.io uses x86 architecture (not ARM)
    • The Dockerfile is compatible with both architectures
    • For WhatsApp/Telegram onboarding, use
      text
      fly ssh console
    • Persistent data lives on the volume at
      text
      /data
    • Signal requires Java + signal-cli; use a custom image and keep memory at 2GB+.

    Cost

    With the recommended config (

    text
    shared-cpu-2x
    , 2GB RAM):

    • ~$10-15/month depending on usage
    • Free tier includes some allowance

    See Fly.io pricing for details.

    Next steps

    • Set up messaging channels: Channels
    • Configure the Gateway: Gateway configuration
    • Keep OpenClaw up to date: Updating

    Related

    • Install overview
    • Hetzner
    • Docker
    • VPS hosting

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine