Setup

Opmerking: Ben je voor het eerst aan het opzetten? Begin met Aan de slag. Voor wizarddetails, zie Onboarding Wizard.

Laatst bijgewerkt: 2026-01-01

TL;DR

  • Maatwerk leeft buiten de repo: ~/.openclaw/workspace (workspace) + ~/.openclaw/openclaw.json (config).
  • Stabiele workflow: installeer de macOS-app; laat die de gebundelde Gateway draaien.
  • Bleeding edge workflow: draai de Gateway zelf via pnpm gateway:watch, laat dan de macOS-app in Local-modus aansluiten.

Vereisten (vanuit source)

  • Node >=22
  • pnpm
  • Docker (optioneel; alleen voor gecontaineriseerde setup/e2e — zie Docker)

Maatwerkstrategie (zodat updates niet pijn doen)

Als je “100% op mij afgestemd” en makkelijk updaten wilt, houd je maatwerk dan in:

  • Config: ~/.openclaw/openclaw.json (JSON/JSON5-achtig)
  • Workspace: ~/.openclaw/workspace (skills, prompts, herinneringen; maak er een privé git-repo van)

Eenmalig bootstrappen:

openclaw setup

Vanuit deze repo gebruik je de lokale CLI-entry:

openclaw setup

Als je nog geen globale installatie hebt, draai het dan via pnpm openclaw setup.

De Gateway draaien vanuit deze repo

Na pnpm build kun je de gepackte CLI direct draaien:

node openclaw.mjs gateway --port 18789 --verbose

Stabiele workflow (macOS-app eerst)

  1. Installeer + start OpenClaw.app (menubalk).
  2. Voltooi de onboarding/machtigingen-checklist (TCC-prompts).
  3. Zorg dat de Gateway op Local staat en draait (de app beheert dit).
  4. Koppel interfaces (voorbeeld: WhatsApp):
openclaw channels login
  1. Snelle controle:
openclaw health

Als onboarding niet beschikbaar is in jouw build:

  • Draai openclaw setup, dan openclaw channels login, start daarna handmatig de Gateway (openclaw gateway).

Bleeding edge workflow (Gateway in een terminal)

Doel: werken aan de TypeScript Gateway, hot reload, macOS-app UI gekoppeld houden.

0) (Optioneel) macOS-app ook vanuit source draaien

Als je de macOS-app ook op de bleeding edge wilt:

./scripts/restart-mac.sh

1) Start de dev Gateway

pnpm install
pnpm gateway:watch

gateway:watch draait de gateway in watch-modus en herlaadt bij TypeScript-wijzigingen.

2) Wijs de macOS-app naar je draaiende Gateway

In OpenClaw.app:

  • Connection Mode: Local De app koppelt aan de draaiende gateway op de geconfigureerde poort.

3) Verifieer

  • In-app Gateway-status moet “Using existing gateway …” tonen.
  • Of via CLI:
openclaw health

Veelvoorkomende valkuilen

  • Verkeerde poort: Gateway WS staat standaard op ws://127.0.0.1:18789; houd app + CLI op dezelfde poort.
  • Waar state leeft:
    • Credentials: ~/.openclaw/credentials/
    • Sessions: ~/.openclaw/agents/<agentId>/sessions/
    • Logs: /tmp/openclaw/

Credential-opslagoverzicht

Gebruik dit bij het debuggen van auth of het bepalen van back-ups:

  • WhatsApp: ~/.openclaw/credentials/whatsapp/<accountId>/creds.json
  • Telegram bot token: config/env of channels.telegram.tokenFile (alleen gewone bestanden; symlinks worden geweigerd)
  • Discord bot token: config/env of SecretRef (env/file/exec providers)
  • Slack tokens: config/env (channels.slack.*)
  • Pairing-allowlists:
    • ~/.openclaw/credentials/<channel>-allowFrom.json (standaardaccount)
    • ~/.openclaw/credentials/<channel>-<accountId>-allowFrom.json (niet-standaardaccounts)
  • Model auth-profielen: ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
  • Bestandsgebaseerde secrets-payload (optioneel): ~/.openclaw/secrets.json
  • Legacy OAuth-import: ~/.openclaw/credentials/oauth.json Meer detail: Beveiliging.

Updaten (zonder je setup kapot te maken)

  • Houd ~/.openclaw/workspace en ~/.openclaw/ als “jouw spullen”; stop geen persoonlijke prompts/config in de openclaw-repo.
  • Source updaten: git pull + pnpm install (wanneer lockfile is gewijzigd) + blijf pnpm gateway:watch gebruiken.

Linux (systemd user service)

Linux-installaties gebruiken een systemd user service. Standaard stopt systemd user services bij uitloggen/inactiviteit, wat de Gateway killt. Onboarding probeert lingering voor je in te schakelen (kan om sudo vragen). Als het nog steeds uitstaat:

sudo loginctl enable-linger $USER

Voor always-on of multi-user servers, overweeg een system service in plaats van een user service (geen lingering nodig). Zie het Gateway-runbook voor de systemd-notities.

Gerelateerde docs