Containers

Docker

Docker est facultatif. Utilisez-le uniquement si vous voulez un Gateway conteneurisé ou valider le flux Docker.

Docker est-il adapté à mon cas ?

  • Oui : vous voulez un environnement Gateway isolé et jetable, ou exécuter OpenClaw sur un hôte sans installations locales.
  • Non : vous exécutez OpenClaw sur votre propre machine et vous voulez simplement la boucle de développement la plus rapide. Utilisez plutôt le flux d’installation normal.
  • Note sur la mise en bac à sable : le backend de bac à sable par défaut utilise Docker lorsque la mise en bac à sable est activée, mais elle est désactivée par défaut et ne nécessite pas que le Gateway complet s’exécute dans Docker. Les backends de bac à sable SSH et OpenShell sont également disponibles. Consultez Mise en bac à sable.

Prérequis

  • Docker Desktop (ou Docker Engine) + Docker Compose v2
  • Au moins 2 Go de RAM pour la construction de l’image (pnpm install peut être arrêté par manque de mémoire sur des hôtes de 1 Go avec le code de sortie 137)
  • Assez d’espace disque pour les images et les journaux
  • Si vous exécutez OpenClaw sur un VPS/hôte public, consultez Durcissement de la sécurité pour l’exposition réseau, en particulier la politique de pare-feu Docker DOCKER-USER.

Gateway conteneurisé

  • Build the image

    Depuis la racine du dépôt, exécutez le script de configuration :

    ./scripts/docker/setup.sh
    

    Cela construit l’image Gateway localement. Pour utiliser plutôt une image préconstruite :

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

    Les images préconstruites sont publiées dans le GitHub Container Registry. Balises courantes : main, latest, <version> (par exemple 2026.2.26).

  • Complete onboarding

    Le script de configuration exécute automatiquement la configuration initiale. Il va :

    • demander les clés API du fournisseur
    • générer un jeton Gateway et l’écrire dans .env
    • démarrer le Gateway via Docker Compose

    Pendant la configuration, la configuration initiale avant démarrage et les écritures de configuration passent directement par openclaw-gateway. openclaw-cli est destiné aux commandes que vous exécutez après la création du conteneur Gateway.

  • Open the Control UI

    Ouvrez http://127.0.0.1:18789/ dans votre navigateur et collez le secret partagé configuré dans les paramètres. Le script de configuration écrit par défaut un jeton dans .env ; si vous basculez la configuration du conteneur vers une authentification par mot de passe, utilisez plutôt ce mot de passe.

    Besoin de récupérer l’URL ?

    docker compose run --rm openclaw-cli dashboard --no-open
    
  • Configure channels (optional)

    Utilisez le conteneur CLI pour ajouter des canaux de messagerie :

    # 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

  • Flux manuel

    Si vous préférez exécuter chaque étape vous-même au lieu d’utiliser le script de configuration :

    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
    

    Variables d’environnement

    Le script de configuration accepte ces variables d’environnement facultatives :

    Variable Objectif
    OPENCLAW_IMAGE Utiliser une image distante au lieu de construire localement
    OPENCLAW_DOCKER_APT_PACKAGES Installer des paquets apt supplémentaires pendant la construction (séparés par des espaces)
    OPENCLAW_EXTENSIONS Inclure les assistants de Plugin groupés sélectionnés au moment de la construction
    OPENCLAW_EXTRA_MOUNTS Montages bind hôte supplémentaires (source:target[:opts] séparés par des virgules)
    OPENCLAW_HOME_VOLUME Persister /home/node dans un volume Docker nommé
    OPENCLAW_SANDBOX Activer l’amorçage du bac à sable (1, true, yes, on)
    OPENCLAW_SKIP_ONBOARDING Ignorer l’étape de configuration initiale interactive (1, true, yes, on)
    OPENCLAW_DOCKER_SOCKET Remplacer le chemin du socket Docker
    OPENCLAW_DISABLE_BONJOUR Désactiver l’annonce Bonjour/mDNS (par défaut 1 pour Docker)
    OPENCLAW_DISABLE_BUNDLED_SOURCE_OVERLAYS Désactiver les superpositions de montages bind de source des Plugins groupés
    OTEL_EXPORTER_OTLP_ENDPOINT Point de terminaison de collecteur OTLP/HTTP partagé pour l’export OpenTelemetry
    OTEL_EXPORTER_OTLP_*_ENDPOINT Points de terminaison OTLP propres au signal pour les traces, métriques ou journaux
    OTEL_EXPORTER_OTLP_PROTOCOL Remplacement du protocole OTLP. Seul http/protobuf est pris en charge aujourd’hui
    OTEL_SERVICE_NAME Nom du service utilisé pour les ressources OpenTelemetry
    OTEL_SEMCONV_STABILITY_OPT_IN Activer les derniers attributs sémantiques GenAI expérimentaux
    OPENCLAW_OTEL_PRELOADED Ne pas démarrer un second SDK OpenTelemetry lorsqu’un est préchargé

    Les mainteneurs peuvent tester la source d’un Plugin groupé avec une image empaquetée en montant un répertoire source de Plugin sur son chemin source empaqueté, par exemple OPENCLAW_EXTRA_MOUNTS=/path/to/fork/extensions/synology-chat:/app/extensions/synology-chat:ro. Ce répertoire source monté remplace le bundle compilé correspondant /app/dist/extensions/synology-chat pour le même ID de Plugin.

    Observabilité

    L’export OpenTelemetry sortant part du conteneur Gateway vers votre collecteur OTLP. Il ne nécessite pas de port Docker publié. Si vous construisez l’image localement et voulez que l’exportateur OpenTelemetry groupé soit disponible dans l’image, incluez ses dépendances d’exécution :

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

    Installez le Plugin officiel @openclaw/diagnostics-otel depuis ClawHub dans les installations Docker empaquetées avant d’activer l’export. Les images personnalisées construites depuis la source peuvent toujours inclure la source locale du Plugin avec OPENCLAW_EXTENSIONS=diagnostics-otel. Pour activer l’export, autorisez et activez le Plugin diagnostics-otel dans la configuration, puis définissez diagnostics.otel.enabled=true ou utilisez l’exemple de configuration dans Export OpenTelemetry. Les en-têtes d’authentification du collecteur sont configurés via diagnostics.otel.headers, et non via des variables d’environnement Docker.

    Les métriques Prometheus utilisent le port Gateway déjà publié. Installez clawhub:@openclaw/diagnostics-prometheus, activez le Plugin diagnostics-prometheus, puis scrapez :

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

    La route est protégée par l’authentification Gateway. N’exposez pas de port public /metrics séparé ni de chemin de proxy inverse non authentifié. Consultez Métriques Prometheus.

    Contrôles de santé

    Points de terminaison de sonde du conteneur (aucune authentification requise) :

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

    L’image Docker inclut un HEALTHCHECK intégré qui interroge /healthz. Si les contrôles continuent d’échouer, Docker marque le conteneur comme unhealthy et les systèmes d’orchestration peuvent le redémarrer ou le remplacer.

    Instantané de santé approfondi authentifié :

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

    LAN ou loopback

    scripts/docker/setup.sh définit par défaut OPENCLAW_GATEWAY_BIND=lan afin que l’accès hôte à http://127.0.0.1:18789 fonctionne avec la publication de port Docker.

    • lan (par défaut) : le navigateur hôte et la CLI hôte peuvent atteindre le port Gateway publié.
    • loopback : seuls les processus dans l’espace de noms réseau du conteneur peuvent atteindre directement le Gateway.

    Fournisseurs locaux de l’hôte

    Lorsque OpenClaw s’exécute dans Docker, 127.0.0.1 à l’intérieur du conteneur est le conteneur lui-même, pas votre machine hôte. Utilisez host.docker.internal pour les fournisseurs d’IA qui s’exécutent sur l’hôte :

    Fournisseur URL hôte par défaut URL de configuration 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

    La configuration Docker groupée utilise ces URL hôte comme valeurs par défaut de configuration initiale pour LM Studio et Ollama, et docker-compose.yml mappe host.docker.internal au Gateway hôte Docker pour Docker Engine sous Linux. Docker Desktop fournit déjà le même nom d’hôte sur macOS et Windows.

    Les services hôte doivent également écouter sur une adresse accessible depuis Docker :

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

    Si vous utilisez votre propre fichier Compose ou commande docker run, ajoutez vous-même le même mappage d’hôte, par exemple --add-host=host.docker.internal:host-gateway.

    Bonjour / mDNS

    Le réseau bridge Docker ne transmet généralement pas de façon fiable le multicast Bonjour/mDNS (224.0.0.251:5353). La configuration Compose groupée définit donc par défaut OPENCLAW_DISABLE_BONJOUR=1 afin que le Gateway ne boucle pas en plantant ou ne redémarre pas l’annonce à répétition lorsque le bridge abandonne le trafic multicast.

    Utilisez l’URL Gateway publiée, Tailscale ou DNS-SD étendu pour les hôtes Docker. Définissez OPENCLAW_DISABLE_BONJOUR=0 uniquement lors de l’exécution avec un réseau hôte, macvlan ou un autre réseau où le multicast mDNS est connu pour fonctionner.

    Pour les pièges et le dépannage, consultez Découverte Bonjour.

    Stockage et persistance

    Docker Compose monte en bind OPENCLAW_CONFIG_DIR sur /home/node/.openclaw et OPENCLAW_WORKSPACE_DIR sur /home/node/.openclaw/workspace, de sorte que ces chemins survivent au remplacement du conteneur. Lorsque l’une ou l’autre variable n’est pas définie, le docker-compose.yml groupé se rabat sur ${HOME}/.openclaw (et ${HOME}/.openclaw/workspace pour le montage de l’espace de travail), ou /tmp/.openclaw lorsque HOME lui-même est également absent. Cela évite que docker compose up émette une spécification de volume avec source vide dans les environnements nus.

    Ce répertoire de configuration monté est l’endroit où OpenClaw conserve :

    • openclaw.json pour la configuration du comportement
    • agents/<agentId>/agent/auth-profiles.json pour l’authentification OAuth/clé API du fournisseur stockée
    • .env pour les secrets d’exécution basés sur l’environnement, tels que OPENCLAW_GATEWAY_TOKEN

    Les Plugins téléchargeables installés stockent leur état de paquet sous le répertoire personnel OpenClaw monté, de sorte que les enregistrements d’installation de Plugin et les racines de paquet survivent au remplacement du conteneur. Le démarrage du Gateway ne génère pas d’arbres de dépendances de Plugins groupés.

    Pour tous les détails de persistance sur les déploiements VM, consultez Docker VM Runtime - Ce qui persiste où.

    Points chauds de croissance du disque : surveillez media/, les fichiers JSONL de session, cron/runs/*.jsonl, les racines des packages de Plugin installés et les journaux de fichiers rotatifs sous /tmp/openclaw/.

    Assistants shell (facultatif)

    Pour une gestion Docker quotidienne plus simple, installez 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
    

    Si vous avez installé ClawDock depuis l’ancien chemin brut scripts/shell-helpers/clawdock-helpers.sh, relancez la commande d’installation ci-dessus afin que votre fichier d’assistance local suive le nouvel emplacement.

    Utilisez ensuite clawdock-start, clawdock-stop, clawdock-dashboard, etc. Exécutez clawdock-help pour voir toutes les commandes. Consultez ClawDock pour le guide complet des assistants.

    Activer le bac à sable de l’agent pour le Gateway Docker
    export OPENCLAW_SANDBOX=1
    ./scripts/docker/setup.sh
    

    Chemin de socket personnalisé (p. ex. Docker sans root) :

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

    Le script monte docker.sock uniquement une fois les prérequis du bac à sable validés. Si la configuration du bac à sable ne peut pas se terminer, le script réinitialise agents.defaults.sandbox.mode à off.

    Automatisation / CI (non interactif)

    Désactivez l’allocation de pseudo-TTY par Compose avec -T :

    docker compose run -T --rm openclaw-cli gateway probe
    docker compose run -T --rm openclaw-cli devices list --json
    
    Note de sécurité pour réseau partagé

    openclaw-cli utilise network_mode: "service:openclaw-gateway" afin que les commandes CLI puissent atteindre le Gateway via 127.0.0.1. Considérez cela comme une frontière de confiance partagée. La configuration Compose supprime NET_RAW/NET_ADMIN et active no-new-privileges sur openclaw-gateway et openclaw-cli.

    Permissions et EACCES

    L’image s’exécute en tant que node (uid 1000). Si vous voyez des erreurs de permission sur /home/node/.openclaw, assurez-vous que vos montages bind hôtes appartiennent à l’uid 1000 :

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

    Le même décalage peut apparaître sous forme d’avertissement de Plugin comme blocked plugin candidate: suspicious ownership (... uid=1000, expected uid=0 or root) suivi de plugin present but blocked. Cela signifie que l’uid du processus et le propriétaire du répertoire Plugin monté ne correspondent pas. Préférez exécuter le conteneur avec l’uid par défaut 1000 et corriger la propriété du montage bind. Ne changez la propriété de /path/to/openclaw-config/npm en root:root que si vous exécutez intentionnellement OpenClaw en root à long terme.

    Reconstructions plus rapides

    Ordonnez votre Dockerfile afin que les couches de dépendances soient mises en cache. Cela évite de relancer pnpm install sauf si les lockfiles changent :

    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"]
    
    Options de conteneur pour utilisateurs avancés

    L’image par défaut privilégie la sécurité et s’exécute en tant que node non root. Pour un conteneur plus complet :

    1. Persister /home/node : export OPENCLAW_HOME_VOLUME="openclaw_home"
    2. Intégrer les dépendances système : export OPENCLAW_DOCKER_APT_PACKAGES="git curl jq"
    3. Installer les navigateurs Playwright :
      docker compose run --rm openclaw-cli \
        node /app/node_modules/playwright-core/cli.js install chromium
      
    4. Persister les téléchargements de navigateurs : définissez PLAYWRIGHT_BROWSERS_PATH=/home/node/.cache/ms-playwright et utilisez OPENCLAW_HOME_VOLUME ou OPENCLAW_EXTRA_MOUNTS.
    OpenAI Codex OAuth (Docker sans interface graphique)

    Si vous choisissez OpenAI Codex OAuth dans l’assistant, une URL de navigateur s’ouvre. Dans Docker ou les configurations sans interface graphique, copiez l’URL de redirection complète sur laquelle vous arrivez et collez-la dans l’assistant pour terminer l’authentification.

    Métadonnées de l’image de base

    L’image d’exécution Docker principale utilise node:24-bookworm-slim et publie des annotations OCI d’image de base, notamment org.opencontainers.image.base.name, org.opencontainers.image.source et d’autres. Le digest de base Node est actualisé via les PR Dependabot d’image de base Docker ; les builds de version ne lancent pas de couche de mise à niveau de la distribution. Consultez annotations d’image OCI.

    Exécution sur un VPS ?

    Consultez Hetzner (VPS Docker) et Environnement d’exécution VM Docker pour les étapes de déploiement sur VM partagée, y compris l’intégration du binaire, la persistance et les mises à jour.

    Bac à sable d’agent

    Lorsque agents.defaults.sandbox est activé avec le backend Docker, le Gateway exécute les outils d’agent (shell, lecture/écriture de fichiers, etc.) dans des conteneurs Docker isolés tandis que le Gateway lui-même reste sur l’hôte. Cela vous donne une séparation stricte autour des sessions d’agent non fiables ou multi-locataires sans conteneuriser tout le Gateway.

    La portée du bac à sable peut être par agent (par défaut), par session ou partagée. Chaque portée dispose de son propre espace de travail monté dans /workspace. Vous pouvez aussi configurer des politiques d’autorisation/refus d’outils, l’isolation réseau, les limites de ressources et des conteneurs de navigateur.

    Pour la configuration complète, les images, les notes de sécurité et les profils multi-agents, consultez :

    Activation rapide

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

    Construisez l’image de bac à sable par défaut (depuis un checkout source) :

    scripts/sandbox-setup.sh
    

    Pour les installations npm sans checkout source, consultez Mise en bac à sable § Images et configuration pour les commandes docker build en ligne.

    Dépannage

    Image manquante ou conteneur de bac à sable qui ne démarre pas

    Construisez l’image de bac à sable avec scripts/sandbox-setup.sh (checkout source) ou la commande docker build en ligne depuis Mise en bac à sable § Images et configuration (installation npm), ou définissez agents.defaults.sandbox.docker.image sur votre image personnalisée. Les conteneurs sont créés automatiquement par session à la demande.

    Erreurs de permission dans le bac à sable

    Définissez docker.user sur un UID:GID qui correspond à la propriété de votre espace de travail monté, ou changez la propriété du dossier de l’espace de travail.

    Outils personnalisés introuvables dans le bac à sable

    OpenClaw exécute les commandes avec sh -lc (shell de connexion), ce qui source /etc/profile et peut réinitialiser PATH. Définissez docker.env.PATH pour préfixer vos chemins d’outils personnalisés, ou ajoutez un script sous /etc/profile.d/ dans votre Dockerfile.

    Processus tué par OOM pendant la construction de l’image (code de sortie 137)

    La VM nécessite au moins 2 Go de RAM. Utilisez une classe de machine plus grande et réessayez.

    Non autorisé ou appairage requis dans l’interface Control

    Récupérez un nouveau lien de tableau de bord et approuvez l’appareil du navigateur :

    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>
    

    Plus de détails : Tableau de bord, Appareils.

    La cible du Gateway affiche ws://172.x.x.x ou des erreurs d’appairage depuis la CLI Docker

    Réinitialisez le mode et la liaison du 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
    

    Articles connexes