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:03:07

    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.

    Podman

    Run the OpenClaw Gateway in a rootless Podman container, managed by your current non-root user.

    The intended model is:

    • Podman runs the gateway container.
    • Your host
      text
      openclaw
      CLI is the control plane.
    • Persistent state lives on the host under
      text
      ~/.openclaw
      by default.
    • Day-to-day management uses
      text
      openclaw --container <name> ...
      instead of
      text
      sudo -u openclaw
      ,
      text
      podman exec
      , or a separate service user.

    Prerequisites

    • Podman in rootless mode
    • OpenClaw CLI installed on the host
    • Optional:
      text
      systemd --user
      if you want Quadlet-managed auto-start
    • Optional:
      text
      sudo
      only if you want
      text
      loginctl enable-linger "$(whoami)"
      for boot persistence on a headless host

    Quick start

    One-time setup

    From the repo root, run `./scripts/podman/setup.sh`.

    Start the Gateway container

    Start the container with `./scripts/run-openclaw-podman.sh launch`.

    Run onboarding inside the container

    Run `./scripts/run-openclaw-podman.sh launch setup`, then open `http://127.0.0.1:18789/`.

    Manage the running container from the host CLI

    Set `OPENCLAW_CONTAINER=openclaw`, then use normal `openclaw` commands from the host.

    Setup details:

    • text
      ./scripts/podman/setup.sh
      builds
      text
      openclaw:local
      in your rootless Podman store by default, or uses
      text
      OPENCLAW_IMAGE
      /
      text
      OPENCLAW_PODMAN_IMAGE
      if you set one.
    • It creates
      text
      ~/.openclaw/openclaw.json
      with
      text
      gateway.mode: "local"
      if missing.
    • It creates
      text
      ~/.openclaw/.env
      with
      text
      OPENCLAW_GATEWAY_TOKEN
      if missing.
    • For manual launches, the helper reads only a small allowlist of Podman-related keys from
      text
      ~/.openclaw/.env
      and passes explicit runtime env vars to the container; it does not hand the full env file to Podman.

    Quadlet-managed setup:

    bash
    ./scripts/podman/setup.sh --quadlet

    Quadlet is a Linux-only option because it depends on systemd user services.

    You can also set

    text
    OPENCLAW_PODMAN_QUADLET=1
    .

    Optional build/setup env vars:

    • text
      OPENCLAW_IMAGE
      or
      text
      OPENCLAW_PODMAN_IMAGE
      -- use an existing/pulled image instead of building
      text
      openclaw:local
    • text
      OPENCLAW_DOCKER_APT_PACKAGES
      -- install extra apt packages during image build
    • text
      OPENCLAW_EXTENSIONS
      -- pre-install plugin dependencies at build time
    • text
      OPENCLAW_INSTALL_BROWSER
      -- pre-install Chromium and Xvfb for browser automation (set to
      text
      1
      to enable)

    Container start:

    bash
    ./scripts/run-openclaw-podman.sh launch

    The script starts the container as your current uid/gid with

    text
    --userns=keep-id
    and bind-mounts your OpenClaw state into the container.

    Onboarding:

    bash
    ./scripts/run-openclaw-podman.sh launch setup

    Then open

    text
    http://127.0.0.1:18789/
    and use the token from
    text
    ~/.openclaw/.env
    .

    Host CLI default:

    bash
    export OPENCLAW_CONTAINER=openclaw

    Then commands such as these will run inside that container automatically:

    bash
    openclaw dashboard --no-open openclaw gateway status --deep # includes extra service scan openclaw doctor openclaw channels login

    On macOS, Podman machine may make the browser appear non-local to the gateway. If the Control UI reports device-auth errors after launch, use the Tailscale guidance in Podman + Tailscale.

    Podman + Tailscale

    For HTTPS or remote browser access, follow the main Tailscale docs.

    Podman-specific note:

    • Keep the Podman publish host at
      text
      127.0.0.1
      .
    • Prefer host-managed
      text
      tailscale serve
      over
      text
      openclaw gateway --tailscale serve
      .
    • On macOS, if local browser device-auth context is unreliable, use Tailscale access instead of ad hoc local tunnel workarounds.

    See:

    • Tailscale
    • Control UI

    Systemd (Quadlet, optional)

    If you ran

    text
    ./scripts/podman/setup.sh --quadlet
    , setup installs a Quadlet file at:

    bash
    ~/.config/containers/systemd/openclaw.container

    Useful commands:

    • Start:
      text
      systemctl --user start openclaw.service
    • Stop:
      text
      systemctl --user stop openclaw.service
    • Status:
      text
      systemctl --user status openclaw.service
    • Logs:
      text
      journalctl --user -u openclaw.service -f

    After editing the Quadlet file:

    bash
    systemctl --user daemon-reload systemctl --user restart openclaw.service

    For boot persistence on SSH/headless hosts, enable lingering for your current user:

    bash
    sudo loginctl enable-linger "$(whoami)"

    Config, env, and storage

    • Config dir:
      text
      ~/.openclaw
    • Workspace dir:
      text
      ~/.openclaw/workspace
    • Token file:
      text
      ~/.openclaw/.env
    • Launch helper:
      text
      ./scripts/run-openclaw-podman.sh

    The launch script and Quadlet bind-mount host state into the container:

    • text
      OPENCLAW_CONFIG_DIR
      ->
      text
      /home/node/.openclaw
    • text
      OPENCLAW_WORKSPACE_DIR
      ->
      text
      /home/node/.openclaw/workspace

    By default those are host directories, not anonymous container state, so

    text
    openclaw.json
    , per-agent
    text
    auth-profiles.json
    , channel/provider state, sessions, and workspace survive container replacement. The Podman setup also seeds
    text
    gateway.controlUi.allowedOrigins
    for
    text
    127.0.0.1
    and
    text
    localhost
    on the published gateway port so the local dashboard works with the container's non-loopback bind.

    Useful env vars for the manual launcher:

    • text
      OPENCLAW_PODMAN_CONTAINER
      -- container name (
      text
      openclaw
      by default)
    • text
      OPENCLAW_PODMAN_IMAGE
      /
      text
      OPENCLAW_IMAGE
      -- image to run
    • text
      OPENCLAW_PODMAN_GATEWAY_HOST_PORT
      -- host port mapped to container
      text
      18789
    • text
      OPENCLAW_PODMAN_BRIDGE_HOST_PORT
      -- host port mapped to container
      text
      18790
    • text
      OPENCLAW_PODMAN_PUBLISH_HOST
      -- host interface for published ports; default is
      text
      127.0.0.1
    • text
      OPENCLAW_GATEWAY_BIND
      -- gateway bind mode inside the container; default is
      text
      lan
    • text
      OPENCLAW_PODMAN_USERNS
      --
      text
      keep-id
      (default),
      text
      auto
      , or
      text
      host

    The manual launcher reads

    text
    ~/.openclaw/.env
    before finalizing container/image defaults, so you can persist these there.

    If you use a non-default

    text
    OPENCLAW_CONFIG_DIR
    or
    text
    OPENCLAW_WORKSPACE_DIR
    , set the same variables for both
    text
    ./scripts/podman/setup.sh
    and later
    text
    ./scripts/run-openclaw-podman.sh launch
    commands. The repo-local launcher does not persist custom path overrides across shells.

    Quadlet note:

    • The generated Quadlet service intentionally keeps a fixed, hardened default shape:
      text
      127.0.0.1
      published ports,
      text
      --bind lan
      inside the container, and
      text
      keep-id
      user namespace.
    • It pins
      text
      OPENCLAW_NO_RESPAWN=1
      ,
      text
      Restart=on-failure
      , and
      text
      TimeoutStartSec=300
      .
    • It publishes both
      text
      127.0.0.1:18789:18789
      (gateway) and
      text
      127.0.0.1:18790:18790
      (bridge).
    • It reads
      text
      ~/.openclaw/.env
      as a runtime
      text
      EnvironmentFile
      for values such as
      text
      OPENCLAW_GATEWAY_TOKEN
      , but it does not consume the manual launcher's Podman-specific override allowlist.
    • If you need custom publish ports, publish host, or other container-run flags, use the manual launcher or edit
      text
      ~/.config/containers/systemd/openclaw.container
      directly, then reload and restart the service.

    Useful commands

    • Container logs:
      text
      podman logs -f openclaw
    • Stop container:
      text
      podman stop openclaw
    • Remove container:
      text
      podman rm -f openclaw
    • Open dashboard URL from host CLI:
      text
      openclaw dashboard --no-open
    • Health/status via host CLI:
      text
      openclaw gateway status --deep
      (RPC probe + extra service scan)

    Troubleshooting

    • Permission denied (EACCES) on config or workspace: The container runs with
      text
      --userns=keep-id
      and
      text
      --user <your uid>:<your gid>
      by default. Ensure the host config/workspace paths are owned by your current user.
    • Gateway start blocked (missing
      text
      gateway.mode=local
      ):
      Ensure
      text
      ~/.openclaw/openclaw.json
      exists and sets
      text
      gateway.mode="local"
      .
      text
      scripts/podman/setup.sh
      creates this if missing.
    • Container CLI commands hit the wrong target: Use
      text
      openclaw --container <name> ...
      explicitly, or export
      text
      OPENCLAW_CONTAINER=<name>
      in your shell.
    • text
      openclaw update
      fails with
      text
      --container
      :
      Expected. Rebuild/pull the image, then restart the container or the Quadlet service.
    • Quadlet service does not start: Run
      text
      systemctl --user daemon-reload
      , then
      text
      systemctl --user start openclaw.service
      . On headless systems you may also need
      text
      sudo loginctl enable-linger "$(whoami)"
      .
    • SELinux blocks bind mounts: Leave the default mount behavior alone; the launcher auto-adds
      text
      :Z
      on Linux when SELinux is enforcing or permissive.

    Related

    • Docker
    • Gateway background process
    • Gateway troubleshooting

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine