Containers

Docker

Docker bersifat opsional. Gunakan hanya jika Anda menginginkan Gateway dalam container atau ingin memvalidasi alur Docker.

Apakah Docker tepat untuk saya?

  • Ya: Anda menginginkan lingkungan Gateway yang terisolasi dan sekali pakai, atau ingin menjalankan OpenClaw pada host tanpa instalasi lokal.
  • Tidak: Anda menjalankan di mesin sendiri dan hanya menginginkan loop pengembangan tercepat. Gunakan alur instalasi normal sebagai gantinya.
  • Catatan sandboxing: backend sandbox default menggunakan Docker saat sandboxing diaktifkan, tetapi sandboxing nonaktif secara default dan tidak mengharuskan seluruh Gateway berjalan di Docker. Backend sandbox SSH dan OpenShell juga tersedia. Lihat Sandboxing.

Prasyarat

  • Docker Desktop (atau Docker Engine) + Docker Compose v2
  • RAM minimal 2 GB untuk build image (pnpm install dapat dihentikan karena OOM pada host 1 GB dengan exit 137)
  • Ruang disk yang cukup untuk image dan log
  • Jika berjalan pada VPS/host publik, tinjau Penguatan keamanan untuk paparan jaringan, terutama kebijakan firewall Docker DOCKER-USER.

Gateway dalam container

  • Build image

    Dari root repo, jalankan skrip penyiapan:

    ./scripts/docker/setup.sh
    

    Ini membangun image Gateway secara lokal. Untuk menggunakan image yang sudah dibangun sebagai gantinya:

    export OPENCLAW_IMAGE="ghcr.io/openclaw/openclaw:latest"
    ./scripts/docker/setup.sh
    

    Image yang sudah dibangun diterbitkan di GitHub Container Registry. Tag umum: main, latest, <version> (misalnya 2026.2.26).

  • Selesaikan onboarding

    Skrip penyiapan menjalankan onboarding secara otomatis. Skrip ini akan:

    • meminta kunci API penyedia
    • membuat token Gateway dan menulisnya ke .env
    • memulai Gateway melalui Docker Compose

    Selama penyiapan, onboarding pra-start dan penulisan konfigurasi dijalankan langsung melalui openclaw-gateway. openclaw-cli digunakan untuk perintah yang Anda jalankan setelah container Gateway sudah ada.

  • Buka Control UI

    Buka http://127.0.0.1:18789/ di browser Anda dan tempel secret bersama yang dikonfigurasi ke Settings. Skrip penyiapan menulis token ke .env secara default; jika Anda mengganti konfigurasi container ke autentikasi kata sandi, gunakan kata sandi tersebut sebagai gantinya.

    Butuh URL lagi?

    docker compose run --rm openclaw-cli dashboard --no-open
    
  • Konfigurasikan channel (opsional)

    Gunakan container CLI untuk menambahkan channel pesan:

    # WhatsApp (QR)
    docker compose run --rm openclaw-cli channels login
    
    # Telegram
    docker compose run --rm openclaw-cli channels add --channel telegram --token "<token>"
    
    # Discord
    docker compose run --rm openclaw-cli channels add --channel discord --token "<token>"
    

    Dokumen: WhatsApp, Telegram, Discord

  • Alur manual

    Jika Anda lebih suka menjalankan setiap langkah sendiri alih-alih menggunakan skrip penyiapan:

    docker build -t openclaw:local -f Dockerfile .
    docker compose run --rm --no-deps --entrypoint node openclaw-gateway \
      dist/index.js onboard --mode local --no-install-daemon
    docker compose run --rm --no-deps --entrypoint node openclaw-gateway \
      dist/index.js config set --batch-json '[{"path":"gateway.mode","value":"local"},{"path":"gateway.bind","value":"lan"},{"path":"gateway.controlUi.allowedOrigins","value":["http://localhost:18789","http://127.0.0.1:18789"]}]'
    docker compose up -d openclaw-gateway
    

    Variabel lingkungan

    Skrip penyiapan menerima variabel lingkungan opsional berikut:

    Variabel Tujuan
    OPENCLAW_IMAGE Gunakan image jarak jauh alih-alih membangun secara lokal
    OPENCLAW_DOCKER_APT_PACKAGES Instal paket apt tambahan selama build (dipisahkan spasi)
    OPENCLAW_EXTENSIONS Sertakan helper Plugin bawaan tertentu saat build
    OPENCLAW_EXTRA_MOUNTS Bind mount host tambahan (source:target[:opts] dipisahkan koma)
    OPENCLAW_HOME_VOLUME Pertahankan /home/node dalam volume Docker bernama
    OPENCLAW_SANDBOX Ikut serta dalam bootstrap sandbox (1, true, yes, on)
    OPENCLAW_SKIP_ONBOARDING Lewati langkah onboarding interaktif (1, true, yes, on)
    OPENCLAW_DOCKER_SOCKET Timpa path socket Docker
    OPENCLAW_DISABLE_BONJOUR Nonaktifkan iklan Bonjour/mDNS (default ke 1 untuk Docker)
    OPENCLAW_DISABLE_BUNDLED_SOURCE_OVERLAYS Nonaktifkan overlay bind-mount sumber Plugin bawaan
    OTEL_EXPORTER_OTLP_ENDPOINT Endpoint kolektor OTLP/HTTP bersama untuk ekspor OpenTelemetry
    OTEL_EXPORTER_OTLP_*_ENDPOINT Endpoint OTLP khusus sinyal untuk trace, metrik, atau log
    OTEL_EXPORTER_OTLP_PROTOCOL Override protokol OTLP. Hanya http/protobuf yang didukung saat ini
    OTEL_SERVICE_NAME Nama layanan yang digunakan untuk resource OpenTelemetry
    OTEL_SEMCONV_STABILITY_OPT_IN Ikut serta dalam atribut semantik GenAI eksperimental terbaru
    OPENCLAW_OTEL_PRELOADED Lewati memulai SDK OpenTelemetry kedua saat sudah dipreload

    Maintainer dapat menguji sumber Plugin bawaan terhadap image terpaket dengan memasang satu direktori sumber Plugin di atas path sumber terpaketnya, misalnya OPENCLAW_EXTRA_MOUNTS=/path/to/fork/extensions/synology-chat:/app/extensions/synology-chat:ro. Direktori sumber yang dipasang tersebut menimpa bundle /app/dist/extensions/synology-chat yang dikompilasi dan cocok untuk id Plugin yang sama.

    Observabilitas

    Ekspor OpenTelemetry bersifat keluar dari container Gateway ke kolektor OTLP Anda. Ini tidak memerlukan port Docker yang dipublikasikan. Jika Anda membangun image secara lokal dan ingin eksportir OpenTelemetry bawaan tersedia di dalam image, sertakan dependensi runtime-nya:

    export OPENCLAW_EXTENSIONS="diagnostics-otel"
    export OTEL_EXPORTER_OTLP_ENDPOINT="http://otel-collector:4318"
    export OTEL_SERVICE_NAME="openclaw-gateway"
    ./scripts/docker/setup.sh
    

    Instal Plugin resmi @openclaw/diagnostics-otel dari ClawHub dalam instalasi Docker terpaket sebelum mengaktifkan ekspor. Image custom yang dibangun dari sumber tetap dapat menyertakan sumber Plugin lokal dengan OPENCLAW_EXTENSIONS=diagnostics-otel. Untuk mengaktifkan ekspor, izinkan dan aktifkan Plugin diagnostics-otel dalam konfigurasi, lalu setel diagnostics.otel.enabled=true atau gunakan contoh konfigurasi di Ekspor OpenTelemetry . Header autentikasi kolektor dikonfigurasi melalui diagnostics.otel.headers, bukan melalui variabel lingkungan Docker.

    Metrik Prometheus menggunakan port Gateway yang sudah dipublikasikan. Instal clawhub:@openclaw/diagnostics-prometheus, aktifkan Plugin diagnostics-prometheus, lalu scrape:

    http://<gateway-host>:18789/api/diagnostics/prometheus
    

    Rute ini dilindungi oleh autentikasi Gateway. Jangan mengekspos port publik /metrics terpisah atau path reverse-proxy tanpa autentikasi. Lihat Metrik Prometheus.

    Health check

    Endpoint probe container (tidak memerlukan autentikasi):

    curl -fsS http://127.0.0.1:18789/healthz   # liveness
    curl -fsS http://127.0.0.1:18789/readyz     # readiness
    

    Image Docker menyertakan HEALTHCHECK bawaan yang melakukan ping ke /healthz. Jika pemeriksaan terus gagal, Docker menandai container sebagai unhealthy dan sistem orkestrasi dapat memulai ulang atau menggantinya.

    Snapshot kesehatan mendalam yang terautentikasi:

    docker compose exec openclaw-gateway node dist/index.js health --token "$OPENCLAW_GATEWAY_TOKEN"
    

    LAN vs loopback

    scripts/docker/setup.sh menetapkan default OPENCLAW_GATEWAY_BIND=lan sehingga akses host ke http://127.0.0.1:18789 berfungsi dengan publikasi port Docker.

    • lan (default): browser host dan CLI host dapat menjangkau port Gateway yang dipublikasikan.
    • loopback: hanya proses di dalam namespace jaringan container yang dapat menjangkau Gateway secara langsung.

    Penyedia Lokal Host

    Saat OpenClaw berjalan di Docker, 127.0.0.1 di dalam container adalah container itu sendiri, bukan mesin host Anda. Gunakan host.docker.internal untuk penyedia AI yang berjalan di host:

    Penyedia URL default host URL penyiapan Docker
    LM Studio http://127.0.0.1:1234 http://host.docker.internal:1234
    Ollama http://127.0.0.1:11434 http://host.docker.internal:11434

    Penyiapan Docker bawaan menggunakan URL host tersebut sebagai default onboarding LM Studio dan Ollama, dan docker-compose.yml memetakan host.docker.internal ke Gateway host Docker untuk Docker Engine Linux. Docker Desktop sudah menyediakan hostname yang sama di macOS dan Windows.

    Layanan host juga harus mendengarkan pada alamat yang dapat dijangkau dari Docker:

    lms server start --port 1234 --bind 0.0.0.0
    OLLAMA_HOST=0.0.0.0:11434 ollama serve
    

    Jika Anda menggunakan file Compose sendiri atau perintah docker run, tambahkan pemetaan host yang sama sendiri, misalnya --add-host=host.docker.internal:host-gateway.

    Bonjour / mDNS

    Jaringan bridge Docker biasanya tidak meneruskan multicast Bonjour/mDNS (224.0.0.251:5353) secara andal. Karena itu, penyiapan Compose bawaan menetapkan default OPENCLAW_DISABLE_BONJOUR=1 agar Gateway tidak crash-loop atau berulang kali memulai ulang iklan saat bridge menjatuhkan lalu lintas multicast.

    Gunakan URL Gateway yang dipublikasikan, Tailscale, atau DNS-SD area luas untuk host Docker. Setel OPENCLAW_DISABLE_BONJOUR=0 hanya saat berjalan dengan jaringan host, macvlan, atau jaringan lain tempat multicast mDNS diketahui berfungsi.

    Untuk hal-hal yang perlu diperhatikan dan pemecahan masalah, lihat Penemuan Bonjour.

    Penyimpanan dan persistensi

    Docker Compose melakukan bind-mount OPENCLAW_CONFIG_DIR ke /home/node/.openclaw dan OPENCLAW_WORKSPACE_DIR ke /home/node/.openclaw/workspace, sehingga path tersebut tetap bertahan setelah container diganti. Saat salah satu variabel tidak disetel, docker-compose.yml bawaan fallback ke ${HOME}/.openclaw (dan ${HOME}/.openclaw/workspace untuk mount workspace), atau /tmp/.openclaw saat HOME sendiri juga tidak ada. Ini mencegah docker compose up menghasilkan spesifikasi volume dengan sumber kosong pada lingkungan minimal.

    Direktori konfigurasi yang dipasang tersebut adalah tempat OpenClaw menyimpan:

    • openclaw.json untuk konfigurasi perilaku
    • agents/<agentId>/agent/auth-profiles.json untuk autentikasi OAuth/kunci API penyedia yang disimpan
    • .env untuk secret runtime berbasis env seperti OPENCLAW_GATEWAY_TOKEN

    Plugin unduhan yang diinstal menyimpan status paketnya di bawah home OpenClaw yang dipasang, sehingga catatan instalasi Plugin dan root paket tetap bertahan setelah container diganti. Startup Gateway tidak membuat pohon dependensi Plugin bawaan.

    Untuk detail persistensi penuh pada deployment VM, lihat Docker VM Runtime - Apa yang bertahan di mana.

    Hotspot pertumbuhan disk: pantau media/, file JSONL sesi, cron/runs/*.jsonl, root paket Plugin yang terpasang, dan log file bergulir di bawah /tmp/openclaw/.

    Pembantu shell (opsional)

    Untuk mempermudah pengelolaan Docker harian, instal ClawDock:

    mkdir -p ~/.clawdock && curl -sL https://raw.githubusercontent.com/openclaw/openclaw/main/scripts/clawdock/clawdock-helpers.sh -o ~/.clawdock/clawdock-helpers.sh
    echo 'source ~/.clawdock/clawdock-helpers.sh' >> ~/.zshrc && source ~/.zshrc
    

    Jika Anda memasang ClawDock dari path raw lama scripts/shell-helpers/clawdock-helpers.sh, jalankan ulang perintah instalasi di atas agar file pembantu lokal Anda mengikuti lokasi baru.

    Lalu gunakan clawdock-start, clawdock-stop, clawdock-dashboard, dll. Jalankan clawdock-help untuk melihat semua perintah. Lihat ClawDock untuk panduan pembantu lengkap.

    Aktifkan sandbox agen untuk Gateway Docker
    export OPENCLAW_SANDBOX=1
    ./scripts/docker/setup.sh
    

    Path soket kustom (mis. Docker tanpa root):

    export OPENCLAW_SANDBOX=1
    export OPENCLAW_DOCKER_SOCKET=/run/user/1000/docker.sock
    ./scripts/docker/setup.sh
    

    Skrip memasang docker.sock hanya setelah prasyarat sandbox lolos. Jika penyiapan sandbox tidak dapat selesai, skrip mereset agents.defaults.sandbox.mode ke off.

    Otomatisasi / CI (non-interaktif)

    Nonaktifkan alokasi pseudo-TTY Compose dengan -T:

    docker compose run -T --rm openclaw-cli gateway probe
    docker compose run -T --rm openclaw-cli devices list --json
    
    Catatan keamanan jaringan bersama

    openclaw-cli menggunakan network_mode: "service:openclaw-gateway" agar perintah CLI dapat menjangkau Gateway melalui 127.0.0.1. Perlakukan ini sebagai batas kepercayaan bersama. Konfigurasi compose menghapus NET_RAW/NET_ADMIN dan mengaktifkan no-new-privileges pada openclaw-gateway dan openclaw-cli.

    Izin dan EACCES

    Image berjalan sebagai node (uid 1000). Jika Anda melihat kesalahan izin pada /home/node/.openclaw, pastikan bind mount host Anda dimiliki oleh uid 1000:

    sudo chown -R 1000:1000 /path/to/openclaw-config /path/to/openclaw-workspace
    

    Ketidakcocokan yang sama dapat muncul sebagai peringatan Plugin seperti blocked plugin candidate: suspicious ownership (... uid=1000, expected uid=0 or root) diikuti oleh plugin present but blocked. Itu berarti uid proses dan pemilik direktori Plugin yang dipasang tidak cocok. Sebaiknya jalankan kontainer sebagai uid default 1000 dan perbaiki kepemilikan bind mount. Hanya lakukan chown /path/to/openclaw-config/npm ke root:root jika Anda sengaja menjalankan OpenClaw sebagai root untuk jangka panjang.

    Rebuild lebih cepat

    Urutkan Dockerfile Anda agar layer dependensi di-cache. Ini menghindari menjalankan ulang pnpm install kecuali lockfile berubah:

    FROM node:24-bookworm
    RUN curl -fsSL https://bun.sh/install | bash
    ENV PATH="/root/.bun/bin:${PATH}"
    RUN corepack enable
    WORKDIR /app
    COPY package.json pnpm-lock.yaml pnpm-workspace.yaml .npmrc ./
    COPY ui/package.json ./ui/package.json
    COPY scripts ./scripts
    RUN pnpm install --frozen-lockfile
    COPY . .
    RUN pnpm build
    RUN pnpm ui:install
    RUN pnpm ui:build
    ENV NODE_ENV=production
    CMD ["node","dist/index.js"]
    
    Opsi kontainer untuk pengguna mahir

    Image default mengutamakan keamanan dan berjalan sebagai node non-root. Untuk kontainer yang lebih lengkap fiturnya:

    1. Persistenkan /home/node: export OPENCLAW_HOME_VOLUME="openclaw_home"
    2. Masukkan dependensi sistem ke image: export OPENCLAW_DOCKER_APT_PACKAGES="git curl jq"
    3. Instal browser Playwright:
      docker compose run --rm openclaw-cli \
        node /app/node_modules/playwright-core/cli.js install chromium
      
    4. Persistenkan unduhan browser: atur PLAYWRIGHT_BROWSERS_PATH=/home/node/.cache/ms-playwright dan gunakan OPENCLAW_HOME_VOLUME atau OPENCLAW_EXTRA_MOUNTS.
    OpenAI Codex OAuth (Docker headless)

    Jika Anda memilih OpenAI Codex OAuth di wizard, ini akan membuka URL browser. Dalam Docker atau penyiapan headless, salin URL redirect lengkap tempat Anda mendarat dan tempelkan kembali ke wizard untuk menyelesaikan autentikasi.

    Metadata image dasar

    Image runtime Docker utama menggunakan node:24-bookworm-slim dan menerbitkan anotasi image dasar OCI termasuk org.opencontainers.image.base.name, org.opencontainers.image.source, dan lainnya. Digest dasar Node diperbarui melalui PR image dasar Docker Dependabot; build rilis tidak menjalankan layer peningkatan distro. Lihat anotasi image OCI.

    Menjalankan di VPS?

    Lihat Hetzner (Docker VPS) dan Runtime VM Docker untuk langkah deployment VM bersama termasuk memasukkan biner ke image, persistensi, dan pembaruan.

    Sandbox agen

    Ketika agents.defaults.sandbox diaktifkan dengan backend Docker, Gateway menjalankan eksekusi alat agen (shell, baca/tulis file, dll.) di dalam kontainer Docker terisolasi sementara Gateway itu sendiri tetap berada di host. Ini memberi Anda dinding keras di sekitar sesi agen yang tidak tepercaya atau multi-tenant tanpa mengontainerkan seluruh Gateway.

    Cakupan sandbox dapat per agen (default), per sesi, atau bersama. Setiap cakupan mendapat workspace sendiri yang dipasang di /workspace. Anda juga dapat mengonfigurasi kebijakan alat izinkan/tolak, isolasi jaringan, batas sumber daya, dan kontainer browser.

    Untuk konfigurasi lengkap, image, catatan keamanan, dan profil multi-agen, lihat:

    Aktifkan cepat

    {
      agents: {
        defaults: {
          sandbox: {
            mode: "non-main", // off | non-main | all
            scope: "agent", // session | agent | shared
          },
        },
      },
    }
    

    Build image sandbox default (dari checkout sumber):

    scripts/sandbox-setup.sh
    

    Untuk instalasi npm tanpa checkout sumber, lihat Sandboxing § Image dan penyiapan untuk perintah inline docker build.

    Pemecahan masalah

    Image hilang atau kontainer sandbox tidak mulai

    Build image sandbox dengan scripts/sandbox-setup.sh (checkout sumber) atau perintah inline docker build dari Sandboxing § Image dan penyiapan (instalasi npm), atau atur agents.defaults.sandbox.docker.image ke image kustom Anda. Kontainer dibuat otomatis per sesi sesuai kebutuhan.

    Kesalahan izin di sandbox

    Atur docker.user ke UID:GID yang cocok dengan kepemilikan workspace yang dipasang, atau chown folder workspace.

    Alat kustom tidak ditemukan di sandbox

    OpenClaw menjalankan perintah dengan sh -lc (shell login), yang mengambil sumber /etc/profile dan dapat mereset PATH. Atur docker.env.PATH untuk menambahkan path alat kustom Anda di depan, atau tambahkan skrip di bawah /etc/profile.d/ dalam Dockerfile Anda.

    Dimatikan oleh OOM selama build image (exit 137)

    VM membutuhkan setidaknya 2 GB RAM. Gunakan kelas mesin yang lebih besar dan coba lagi.

    Tidak terotorisasi atau perlu pairing di Control UI

    Ambil tautan dashboard baru dan setujui perangkat browser:

    docker compose run --rm openclaw-cli dashboard --no-open
    docker compose run --rm openclaw-cli devices list
    docker compose run --rm openclaw-cli devices approve <requestId>
    

    Detail selengkapnya: Dashboard, Perangkat.

    Target Gateway menampilkan ws://172.x.x.x atau kesalahan pairing dari Docker CLI

    Reset mode dan bind Gateway:

    docker compose run --rm openclaw-cli config set --batch-json '[{"path":"gateway.mode","value":"local"},{"path":"gateway.bind","value":"lan"}]'
    docker compose run --rm openclaw-cli devices list --url ws://127.0.0.1:18789
    

    Terkait