Naar hoofdinhoud gaan

Documentation Index

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

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

Docker is optioneel. Gebruik het alleen als je een gecontaineriseerde Gateway wilt of de Docker-flow wilt valideren.

Is Docker geschikt voor mij?

  • Ja: je wilt een geïsoleerde, tijdelijke Gateway-omgeving of OpenClaw draaien op een host zonder lokale installaties.
  • Nee: je draait op je eigen machine en wilt alleen de snelste ontwikkelloop. Gebruik in plaats daarvan de normale installatieflow.
  • Opmerking over sandboxing: de standaard sandbox-backend gebruikt Docker wanneer sandboxing is ingeschakeld, maar sandboxing staat standaard uit en vereist niet dat de volledige Gateway in Docker draait. SSH- en OpenShell-sandbox-backends zijn ook beschikbaar. Zie Sandboxing.

Vereisten

  • Docker Desktop (of Docker Engine) + Docker Compose v2
  • Minimaal 2 GB RAM voor het bouwen van images (pnpm install kan op hosts met 1 GB door OOM worden beëindigd met exit 137)
  • Genoeg schijfruimte voor images en logs
  • Als je op een VPS/openbare host draait, bekijk dan Beveiligingsverharding voor netwerkblootstelling, vooral het Docker DOCKER-USER-firewallbeleid.

Gecontaineriseerde Gateway

1

Bouw de image

Voer vanuit de repo-root het installatiescript uit:
./scripts/docker/setup.sh
Dit bouwt de Gateway-image lokaal. Om in plaats daarvan een vooraf gebouwde image te gebruiken:
export OPENCLAW_IMAGE="ghcr.io/openclaw/openclaw:latest"
./scripts/docker/setup.sh
Vooraf gebouwde images worden gepubliceerd in de GitHub Container Registry. Veelgebruikte tags: main, latest, <version> (bijv. 2026.2.26).
2

Voltooi de onboarding

Het installatiescript voert onboarding automatisch uit. Het zal:
  • vragen om API-sleutels voor providers
  • een Gateway-token genereren en dit naar .env schrijven
  • de map voor de geheime sleutel van het auth-profiel maken
  • de Gateway starten via Docker Compose
Tijdens de installatie verlopen onboarding vóór het starten en configuratieschrijfacties rechtstreeks via openclaw-gateway. openclaw-cli is bedoeld voor opdrachten die je uitvoert nadat de Gateway-container al bestaat.
3

Open de Control UI

Open http://127.0.0.1:18789/ in je browser en plak het geconfigureerde gedeelde geheim in Settings. Het installatiescript schrijft standaard een token naar .env; als je de containerconfiguratie omschakelt naar wachtwoordauthenticatie, gebruik dan in plaats daarvan dat wachtwoord.Heb je de URL opnieuw nodig?
docker compose run --rm openclaw-cli dashboard --no-open
4

Configureer kanalen (optioneel)

Gebruik de CLI-container om berichtenkanalen toe te voegen:
# 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>"
Docs: WhatsApp, Telegram, Discord

Handmatige flow

Als je liever elke stap zelf uitvoert in plaats van het installatiescript te gebruiken:
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
Voer docker compose uit vanuit de repo-root. Als je OPENCLAW_EXTRA_MOUNTS of OPENCLAW_HOME_VOLUME hebt ingeschakeld, schrijft het installatiescript docker-compose.extra.yml; neem dit op met -f docker-compose.yml -f docker-compose.extra.yml.
Omdat openclaw-cli de netwerknamespace van openclaw-gateway deelt, is het een tool voor na het starten. Voer vóór docker compose up -d openclaw-gateway onboarding en configuratieschrijfacties tijdens de installatie uit via openclaw-gateway met --no-deps --entrypoint node.

Omgevingsvariabelen

Het installatiescript accepteert deze optionele omgevingsvariabelen:
VariabeleDoel
OPENCLAW_IMAGEGebruik een externe image in plaats van lokaal te bouwen
OPENCLAW_DOCKER_APT_PACKAGESInstalleer extra apt-pakketten tijdens het bouwen (gescheiden door spaties)
OPENCLAW_EXTENSIONSNeem geselecteerde gebundelde plugin-helpers op tijdens het bouwen
OPENCLAW_EXTRA_MOUNTSExtra host-bindmounts (door komma’s gescheiden source:target[:opts])
OPENCLAW_HOME_VOLUMEBewaar /home/node in een benoemd Docker-volume
OPENCLAW_SANDBOXSchakel sandbox-bootstrap in (1, true, yes, on)
OPENCLAW_SKIP_ONBOARDINGSla de interactieve onboardingstap over (1, true, yes, on)
OPENCLAW_DOCKER_SOCKETOverschrijf het Docker-socketpad
OPENCLAW_DISABLE_BONJOURSchakel Bonjour/mDNS-advertising uit (standaard 1 voor Docker)
OPENCLAW_DISABLE_BUNDLED_SOURCE_OVERLAYSSchakel bindmount-overlays van gebundelde plugin-broncode uit
OTEL_EXPORTER_OTLP_ENDPOINTGedeeld OTLP/HTTP-collector-eindpunt voor OpenTelemetry-export
OTEL_EXPORTER_OTLP_*_ENDPOINTSignaalspecifieke OTLP-eindpunten voor traces, metrics of logs
OTEL_EXPORTER_OTLP_PROTOCOLOverschrijving van OTLP-protocol. Alleen http/protobuf wordt vandaag ondersteund
OTEL_SERVICE_NAMEServicenaam die wordt gebruikt voor OpenTelemetry-resources
OTEL_SEMCONV_STABILITY_OPT_INSchakel de nieuwste experimentele GenAI-semantische attributen in
OPENCLAW_OTEL_PRELOADEDSla het starten van een tweede OpenTelemetry SDK over wanneer er al één vooraf geladen is
Maintainers kunnen gebundelde plugin-broncode testen tegen een verpakte image door één plugin-broncodemap over het verpakte broncodepad te mounten, bijvoorbeeld OPENCLAW_EXTRA_MOUNTS=/path/to/fork/extensions/synology-chat:/app/extensions/synology-chat:ro. Die gemounte broncodemap overschrijft de overeenkomende gecompileerde /app/dist/extensions/synology-chat-bundel voor dezelfde plugin-id.

Observeerbaarheid

OpenTelemetry-export is uitgaand vanuit de Gateway-container naar je OTLP- collector. Er is geen gepubliceerde Docker-poort voor nodig. Als je de image lokaal bouwt en de gebundelde OpenTelemetry-exporter beschikbaar wilt hebben in de image, neem dan de runtime-afhankelijkheden op:
export OPENCLAW_EXTENSIONS="diagnostics-otel"
export OTEL_EXPORTER_OTLP_ENDPOINT="http://otel-collector:4318"
export OTEL_SERVICE_NAME="openclaw-gateway"
./scripts/docker/setup.sh
Installeer de officiële @openclaw/diagnostics-otel-plugin vanuit ClawHub in verpakte Docker-installaties voordat je export inschakelt. Aangepaste vanuit broncode gebouwde images kunnen nog steeds de lokale plugin-broncode opnemen met OPENCLAW_EXTENSIONS=diagnostics-otel. Om export in te schakelen, sta de diagnostics-otel-plugin toe en schakel deze in de configuratie in, en stel vervolgens diagnostics.otel.enabled=true in of gebruik het configuratievoorbeeld in OpenTelemetry export. Collector-authheaders worden geconfigureerd via diagnostics.otel.headers, niet via Docker-omgevingsvariabelen. Prometheus-metrics gebruiken de al gepubliceerde Gateway-poort. Installeer clawhub:@openclaw/diagnostics-prometheus, schakel de diagnostics-prometheus-plugin in en scrape vervolgens:
http://<gateway-host>:18789/api/diagnostics/prometheus
De route wordt beschermd door Gateway-authenticatie. Stel geen aparte openbare /metrics-poort of niet-geauthenticeerd reverse-proxy-pad bloot. Zie Prometheus-metrics.

Gezondheidscontroles

Containerprobe-eindpunten (geen authenticatie vereist):
curl -fsS http://127.0.0.1:18789/healthz   # liveness
curl -fsS http://127.0.0.1:18789/readyz     # readiness
De Docker-image bevat een ingebouwde HEALTHCHECK die /healthz pingt. Als controles blijven mislukken, markeert Docker de container als unhealthy en kunnen orchestratiesystemen deze opnieuw starten of vervangen. Geauthenticeerde diepe gezondheidssnapshot:
docker compose exec openclaw-gateway node dist/index.js health --token "$OPENCLAW_GATEWAY_TOKEN"

LAN vs loopback

scripts/docker/setup.sh gebruikt standaard OPENCLAW_GATEWAY_BIND=lan, zodat hosttoegang tot http://127.0.0.1:18789 werkt met Docker-poortpublicatie.
  • lan (standaard): hostbrowser en host-CLI kunnen de gepubliceerde Gateway-poort bereiken.
  • loopback: alleen processen binnen de containernetwerknamespace kunnen de Gateway rechtstreeks bereiken.
Gebruik bindmoduswaarden in gateway.bind (lan / loopback / custom / tailnet / auto), geen hostaliassen zoals 0.0.0.0 of 127.0.0.1.

Lokale hostproviders

Wanneer OpenClaw in Docker draait, is 127.0.0.1 binnen de container de container zelf, niet je hostmachine. Gebruik host.docker.internal voor AI-providers die op de host draaien:
ProviderStandaard-URL hostDocker-installatie-URL
LM Studiohttp://127.0.0.1:1234http://host.docker.internal:1234
Ollamahttp://127.0.0.1:11434http://host.docker.internal:11434
De gebundelde Docker-installatie gebruikt die host-URL’s als de standaardwaarden voor LM Studio- en Ollama-onboarding, en docker-compose.yml wijst host.docker.internal toe aan Docker’s host-gateway voor Linux Docker Engine. Docker Desktop biedt dezelfde hostnaam al op macOS en Windows. Hostservices moeten ook luisteren op een adres dat bereikbaar is vanuit Docker:
lms server start --port 1234 --bind 0.0.0.0
OLLAMA_HOST=0.0.0.0:11434 ollama serve
Als je je eigen Compose-bestand of docker run-opdracht gebruikt, voeg dan zelf dezelfde hostmapping toe, bijvoorbeeld --add-host=host.docker.internal:host-gateway.

Bonjour / mDNS

Docker-bridgenetwerken sturen Bonjour/mDNS-multicast (224.0.0.251:5353) meestal niet betrouwbaar door. De gebundelde Compose-installatie gebruikt daarom standaard OPENCLAW_DISABLE_BONJOUR=1, zodat de Gateway niet in een crash-loop terechtkomt of herhaaldelijk advertising opnieuw start wanneer de bridge multicastverkeer laat vallen. Gebruik de gepubliceerde Gateway-URL, Tailscale of wide-area DNS-SD voor Docker-hosts. Stel OPENCLAW_DISABLE_BONJOUR=0 alleen in wanneer je draait met hostnetwerken, macvlan of een ander netwerk waarvan bekend is dat mDNS-multicast werkt. Zie Bonjour discovery voor valkuilen en probleemoplossing.

Opslag en persistentie

Docker Compose bind-mount OPENCLAW_CONFIG_DIR naar /home/node/.openclaw, OPENCLAW_WORKSPACE_DIR naar /home/node/.openclaw/workspace en OPENCLAW_AUTH_PROFILE_SECRET_DIR naar /home/node/.config/openclaw, zodat die paden containervervanging overleven. Wanneer een variabele niet is ingesteld, valt de gebundelde docker-compose.yml terug onder ${HOME}, of naar /tmp wanneer HOME zelf ook ontbreekt. Dat voorkomt dat docker compose up een volume-specificatie met lege bron uitgeeft in kale omgevingen. Die gemounte configuratiemap is waar OpenClaw het volgende bewaart:
  • openclaw.json voor gedragsconfiguratie
  • agents/<agentId>/agent/auth-profiles.json voor opgeslagen OAuth/API-key-authenticatie van providers
  • .env voor env-backed runtimegeheimen zoals OPENCLAW_GATEWAY_TOKEN
De map voor de geheime sleutel van het auth-profiel bewaart de lokale versleutelingssleutel die wordt gebruikt voor OAuth-backed auth-profiel-tokenmateriaal. Bewaar deze bij je Docker-hoststatus, maar gescheiden van OPENCLAW_CONFIG_DIR. Geïnstalleerde downloadbare plugins slaan hun pakketstatus op onder de aangekoppelde OpenClaw-home, zodat plugin-installatierecords en pakketroots containervervanging overleven. Bij het opstarten van de Gateway worden geen dependency trees voor gebundelde plugins gegenereerd. Zie voor volledige persistentiedetails over VM-deployments Docker VM Runtime - Wat blijft waar behouden. Hotspots voor schijfgroei: houd media/, sessie-JSONL-bestanden, cron/runs/*.jsonl, geïnstalleerde plugin-pakketroots en rollende bestandslogs onder /tmp/openclaw/ in de gaten.

Shell-helpers (optioneel)

Installeer ClawDock voor eenvoudiger dagelijks Docker-beheer:
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
Als je ClawDock hebt geïnstalleerd vanaf het oudere raw-pad scripts/shell-helpers/clawdock-helpers.sh, voer de bovenstaande installatieopdracht opnieuw uit zodat je lokale helperbestand de nieuwe locatie volgt. Gebruik daarna clawdock-start, clawdock-stop, clawdock-dashboard, enz. Voer clawdock-help uit voor alle opdrachten. Zie ClawDock voor de volledige helperhandleiding.
export OPENCLAW_SANDBOX=1
./scripts/docker/setup.sh
Aangepast socketpad (bijv. rootless Docker):
export OPENCLAW_SANDBOX=1
export OPENCLAW_DOCKER_SOCKET=/run/user/1000/docker.sock
./scripts/docker/setup.sh
Het script koppelt docker.sock pas aan nadat aan de sandbox-vereisten is voldaan. Als de sandboxconfiguratie niet kan worden voltooid, zet het script agents.defaults.sandbox.mode terug naar off. Codex-code-modusbeurten blijven beperkt tot Codex workspace-write terwijl de OpenClaw-sandbox actief is; koppel de Docker-socket van de host niet aan agent-sandboxcontainers.
Schakel Compose-pseudo-TTY-toewijzing uit met -T:
docker compose run -T --rm openclaw-cli gateway probe
docker compose run -T --rm openclaw-cli devices list --json
openclaw-cli gebruikt network_mode: "service:openclaw-gateway" zodat CLI- opdrachten de Gateway via 127.0.0.1 kunnen bereiken. Behandel dit als een gedeelde vertrouwensgrens. De Compose-configuratie verwijdert NET_RAW/NET_ADMIN en schakelt no-new-privileges in op zowel openclaw-gateway als openclaw-cli.
Sommige Docker Desktop-configuraties laten DNS-lookups mislukken vanuit de gedeelde-netwerk- sidecar openclaw-cli nadat NET_RAW is verwijderd, wat zichtbaar wordt als EAI_AGAIN tijdens npm-ondersteunde opdrachten zoals openclaw plugins install. Houd het standaard geharde Compose-bestand aan voor normale Gateway-werking. De lokale override hieronder versoepelt de beveiligingshouding van de CLI-container door de standaardcapabilities van Docker te herstellen, dus gebruik die alleen voor de eenmalige CLI- opdracht die toegang tot het pakketregister nodig heeft, niet als je standaard Compose- aanroep:
printf '%s\n' \
  'services:' \
  '  openclaw-cli:' \
  '    cap_drop: !reset []' \
  > docker-compose.cli-no-dropped-caps.local.yml

docker compose -f docker-compose.yml -f docker-compose.cli-no-dropped-caps.local.yml run --rm openclaw-cli plugins install <package>
Als je al een langlopende openclaw-cli-container hebt gemaakt, maak die dan opnieuw aan met dezelfde override. docker compose exec en docker exec kunnen Linux-capabilities op een al aangemaakte container niet wijzigen.
De image draait als node (uid 1000). Als je machtigingsfouten ziet op /home/node/.openclaw, zorg er dan voor dat je host-bindmounts eigendom zijn van uid 1000:
sudo chown -R 1000:1000 /path/to/openclaw-config /path/to/openclaw-workspace
Dezelfde mismatch kan zichtbaar worden als een plugin-waarschuwing zoals blocked plugin candidate: suspicious ownership (... uid=1000, expected uid=0 or root) gevolgd door plugin present but blocked. Dat betekent dat de proces-uid en de eigenaar van de aangekoppelde plugin-directory niet overeenkomen. Draai de container bij voorkeur als de standaard-uid 1000 en herstel het eigenaarschap van de bindmount. Voer alleen chown uit op /path/to/openclaw-config/npm naar root:root als je OpenClaw bewust langdurig als root draait.
Orden je Dockerfile zodat dependency-lagen worden gecachet. Dit voorkomt dat pnpm install opnieuw wordt uitgevoerd, tenzij lockfiles wijzigen:
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"]
De standaardimage is eerst gericht op beveiliging en draait als niet-root node. Voor een meer volledig uitgeruste container:
  1. /home/node behouden: export OPENCLAW_HOME_VOLUME="openclaw_home"
  2. Systeemdependencies inbakken: export OPENCLAW_DOCKER_APT_PACKAGES="git curl jq"
  3. Playwright Chromium inbakken: export OPENCLAW_INSTALL_BROWSER=1
  4. Of Playwright-browsers installeren in een behouden volume:
    docker compose run --rm openclaw-cli \
      node /app/node_modules/playwright-core/cli.js install chromium
    
  5. Browserdownloads behouden: gebruik OPENCLAW_HOME_VOLUME of OPENCLAW_EXTRA_MOUNTS. OpenClaw detecteert automatisch de door Playwright beheerde Chromium van de Docker-image op Linux.
Als je OpenAI Codex OAuth kiest in de wizard, wordt er een browser-URL geopend. Kopieer in Docker- of headless-configuraties de volledige redirect-URL waarop je terechtkomt en plak die terug in de wizard om auth te voltooien.
De hoofdimage voor de Docker-runtime gebruikt node:24-bookworm-slim en bevat tini als het initproces van het entrypoint (PID 1) om ervoor te zorgen dat zombieprocessen worden opgeruimd en signalen correct worden verwerkt in langlopende containers. De image publiceert OCI-basisimage-annotaties, waaronder org.opencontainers.image.base.name, org.opencontainers.image.source en andere. De digest van de Node-basis wordt vernieuwd via Dependabot-PR’s voor Docker-basisimages; release-builds voeren geen distro-upgradelaag uit. Zie OCI-imageannotaties.

Draai je op een VPS?

Zie Hetzner (Docker VPS) en Docker VM Runtime voor gedeelde VM-deploymentstappen inclusief binary baking, persistentie en updates.

Agent-sandbox

Wanneer agents.defaults.sandbox is ingeschakeld met de Docker-backend, voert de Gateway agent-tooluitvoering (shell, bestanden lezen/schrijven, enz.) uit binnen geïsoleerde Docker- containers, terwijl de Gateway zelf op de host blijft. Dit geeft je een harde scheiding rond niet-vertrouwde agent-sessies of agent-sessies met meerdere tenants zonder de volledige Gateway te containeriseren. De sandbox-scope kan per agent (standaard), per sessie of gedeeld zijn. Elke scope krijgt een eigen workspace aangekoppeld op /workspace. Je kunt ook toolbeleid voor toestaan/weigeren, netwerkisolatie, resourcelimieten en browser- containers configureren. Zie voor de volledige configuratie, images, beveiligingsopmerkingen en multi-agent-profielen:

Snel inschakelen

{
  agents: {
    defaults: {
      sandbox: {
        mode: "non-main", // off | non-main | all
        scope: "agent", // session | agent | shared
      },
    },
  },
}
Bouw de standaard-sandboximage (vanuit een source-checkout):
scripts/sandbox-setup.sh
Zie voor npm-installaties zonder source-checkout Sandboxing § Images en setup voor inline docker build-opdrachten.

Probleemoplossing

Bouw de sandboximage met scripts/sandbox-setup.sh (source-checkout) of de inline docker build-opdracht uit Sandboxing § Images en setup (npm-installatie), of stel agents.defaults.sandbox.docker.image in op je aangepaste image. Containers worden op aanvraag automatisch per sessie aangemaakt.
Stel docker.user in op een UID:GID die overeenkomt met het eigenaarschap van je aangekoppelde workspace, of voer chown uit op de workspace-map.
OpenClaw voert opdrachten uit met sh -lc (login-shell), die /etc/profile sourcet en PATH kan resetten. Stel docker.env.PATH in om je aangepaste toolpaden vooraan toe te voegen, of voeg een script toe onder /etc/profile.d/ in je Dockerfile.
De VM heeft ten minste 2 GB RAM nodig. Gebruik een grotere machineklasse en probeer het opnieuw.
Haal een nieuwe dashboardlink op en keur het browserapparaat goed:
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>
Meer details: Dashboard, Apparaten.
Reset Gateway-modus en bind:
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

Gerelateerd