@quantumclaw/quantumclaw 2026.3.22

package/docs/install/docker.md

@@ -0,0 +1,375 @@
+---
+summary: "Optional Docker-based setup and onboarding for QuantumClaw"
+read_when:
+  - You want a containerized gateway instead of local installs
+  - You are validating the Docker flow
+title: "Docker"
+---
+
+# Docker (optional)
+
+Docker is **optional**. Use it only if you want a containerized gateway or to validate the Docker flow.
+
+## Is Docker right for me?
+
+- **Yes**: you want an isolated, throwaway gateway environment or to run QuantumClaw on a host without local installs.
+- **No**: you are running on your own machine and just want the fastest dev loop. Use the normal install flow instead.
+- **Sandboxing note**: agent sandboxing uses Docker too, but it does **not** require the full gateway to run in Docker. See [Sandboxing](/gateway/sandboxing).
+
+## Prerequisites
+
+- Docker Desktop (or Docker Engine) + Docker Compose v2
+- At least 2 GB RAM for image build (`pnpm install` may be OOM-killed on 1 GB hosts with exit 137)
+- Enough disk for images and logs
+- If running on a VPS/public host, review
+  [Security hardening for network exposure](/gateway/security#0-4-network-exposure-bind-port-firewall),
+  especially Docker `DOCKER-USER` firewall policy.
+
+## Containerized Gateway
+
+<Steps>
+  <Step title="Build the image">
+    From the repo root, run the setup script:
+
+    ```bash
+    ./scripts/docker/setup.sh
+    ```
+
+    This builds the gateway image locally. To use a pre-built image instead:
+
+    ```bash
+    export QUANTUMCLAW_IMAGE="ghcr.io/quantumclaw/quantumclaw:latest"
+    ./scripts/docker/setup.sh
+    ```
+
+    Pre-built images are published at the
+    [GitHub Container Registry](https://github.com/quantumclaw/quantumclaw/pkgs/container/quantumclaw).
+    Common tags: `main`, `latest`, `<version>` (e.g. `2026.2.26`).
+
+  </Step>
+
+  <Step title="Complete onboarding">
+    The setup script runs onboarding automatically. It will:
+
+    - prompt for provider API keys
+    - generate a gateway token and write it to `.env`
+    - start the gateway via Docker Compose
+
+  </Step>
+
+  <Step title="Open the Control UI">
+    Open `http://127.0.0.1:18789/` in your browser and paste the token into
+    Settings.
+
+    Need the URL again?
+
+    ```bash
+    docker compose run --rm quantumclaw-cli dashboard --no-open
+    ```
+
+  </Step>
+
+  <Step title="Configure channels (optional)">
+    Use the CLI container to add messaging channels:
+
+    ```bash
+    # WhatsApp (QR)
+    docker compose run --rm quantumclaw-cli channels login
+
+    # Telegram
+    docker compose run --rm quantumclaw-cli channels add --channel telegram --token "<token>"
+
+    # Discord
+    docker compose run --rm quantumclaw-cli channels add --channel discord --token "<token>"
+    ```
+
+    Docs: [WhatsApp](/channels/whatsapp), [Telegram](/channels/telegram), [Discord](/channels/discord)
+
+  </Step>
+</Steps>
+
+### Manual flow
+
+If you prefer to run each step yourself instead of using the setup script:
+
+```bash
+docker build -t quantumclaw:local -f Dockerfile .
+docker compose run --rm quantumclaw-cli onboard
+docker compose up -d quantumclaw-gateway
+```
+
+<Note>
+Run `docker compose` from the repo root. If you enabled `QUANTUMCLAW_EXTRA_MOUNTS`
+or `QUANTUMCLAW_HOME_VOLUME`, the setup script writes `docker-compose.extra.yml`;
+include it with `-f docker-compose.yml -f docker-compose.extra.yml`.
+</Note>
+
+### Environment variables
+
+The setup script accepts these optional environment variables:
+
+| Variable                       | Purpose                                                          |
+| ------------------------------ | ---------------------------------------------------------------- |
+| `QUANTUMCLAW_IMAGE`               | Use a remote image instead of building locally                   |
+| `QUANTUMCLAW_DOCKER_APT_PACKAGES` | Install extra apt packages during build (space-separated)        |
+| `QUANTUMCLAW_EXTENSIONS`          | Pre-install extension deps at build time (space-separated names) |
+| `QUANTUMCLAW_EXTRA_MOUNTS`        | Extra host bind mounts (comma-separated `source:target[:opts]`)  |
+| `QUANTUMCLAW_HOME_VOLUME`         | Persist `/home/node` in a named Docker volume                    |
+| `QUANTUMCLAW_SANDBOX`             | Opt in to sandbox bootstrap (`1`, `true`, `yes`, `on`)           |
+| `QUANTUMCLAW_DOCKER_SOCKET`       | Override Docker socket path                                      |
+
+### Health checks
+
+Container probe endpoints (no auth required):
+
+```bash
+curl -fsS http://127.0.0.1:18789/healthz   # liveness
+curl -fsS http://127.0.0.1:18789/readyz     # readiness
+```
+
+The Docker image includes a built-in `HEALTHCHECK` that pings `/healthz`.
+If checks keep failing, Docker marks the container as `unhealthy` and
+orchestration systems can restart or replace it.
+
+Authenticated deep health snapshot:
+
+```bash
+docker compose exec quantumclaw-gateway node dist/index.js health --token "$QUANTUMCLAW_GATEWAY_TOKEN"
+```
+
+### LAN vs loopback
+
+`scripts/docker/setup.sh` defaults `QUANTUMCLAW_GATEWAY_BIND=lan` so host access to
+`http://127.0.0.1:18789` works with Docker port publishing.
+
+- `lan` (default): host browser and host CLI can reach the published gateway port.
+- `loopback`: only processes inside the container network namespace can reach
+  the gateway directly.
+
+<Note>
+Use bind mode values in `gateway.bind` (`lan` / `loopback` / `custom` /
+`tailnet` / `auto`), not host aliases like `0.0.0.0` or `127.0.0.1`.
+</Note>
+
+### Storage and persistence
+
+Docker Compose bind-mounts `QUANTUMCLAW_CONFIG_DIR` to `/home/node/.quantumclaw` and
+`QUANTUMCLAW_WORKSPACE_DIR` to `/home/node/.quantumclaw/workspace`, so those paths
+survive container replacement.
+
+For full persistence details on VM deployments, see
+[Docker VM Runtime - What persists where](/install/docker-vm-runtime#what-persists-where).
+
+**Disk growth hotspots:** watch `media/`, session JSONL files, `cron/runs/*.jsonl`,
+and rolling file logs under `/tmp/quantumclaw/`.
+
+### Shell helpers (optional)
+
+For easier day-to-day Docker management, install `ClawDock`:
+
+```bash
+mkdir -p ~/.clawdock && curl -sL https://raw.githubusercontent.com/quantumclaw/quantumclaw/main/scripts/shell-helpers/clawdock-helpers.sh -o ~/.clawdock/clawdock-helpers.sh
+echo 'source ~/.clawdock/clawdock-helpers.sh' >> ~/.zshrc && source ~/.zshrc
+```
+
+Then use `clawdock-start`, `clawdock-stop`, `clawdock-dashboard`, etc. Run
+`clawdock-help` for all commands.
+See the [`ClawDock` Helper README](https://github.com/quantumclaw/quantumclaw/blob/main/scripts/shell-helpers/README.md).
+
+<AccordionGroup>
+  <Accordion title="Enable agent sandbox for Docker gateway">
+    ```bash
+    export QUANTUMCLAW_SANDBOX=1
+    ./scripts/docker/setup.sh
+    ```
+
+    Custom socket path (e.g. rootless Docker):
+
+    ```bash
+    export QUANTUMCLAW_SANDBOX=1
+    export QUANTUMCLAW_DOCKER_SOCKET=/run/user/1000/docker.sock
+    ./scripts/docker/setup.sh
+    ```
+
+    The script mounts `docker.sock` only after sandbox prerequisites pass. If
+    sandbox setup cannot complete, the script resets `agents.defaults.sandbox.mode`
+    to `off`.
+
+  </Accordion>
+
+  <Accordion title="Automation / CI (non-interactive)">
+    Disable Compose pseudo-TTY allocation with `-T`:
+
+    ```bash
+    docker compose run -T --rm quantumclaw-cli gateway probe
+    docker compose run -T --rm quantumclaw-cli devices list --json
+    ```
+
+  </Accordion>
+
+  <Accordion title="Shared-network security note">
+    `quantumclaw-cli` uses `network_mode: "service:quantumclaw-gateway"` so CLI
+    commands can reach the gateway over `127.0.0.1`. Treat this as a shared
+    trust boundary. The compose config drops `NET_RAW`/`NET_ADMIN` and enables
+    `no-new-privileges` on `quantumclaw-cli`.
+  </Accordion>
+
+  <Accordion title="Permissions and EACCES">
+    The image runs as `node` (uid 1000). If you see permission errors on
+    `/home/node/.quantumclaw`, make sure your host bind mounts are owned by uid 1000:
+
+    ```bash
+    sudo chown -R 1000:1000 /path/to/quantumclaw-config /path/to/quantumclaw-workspace
+    ```
+
+  </Accordion>
+
+  <Accordion title="Faster rebuilds">
+    Order your Dockerfile so dependency layers are cached. This avoids re-running
+    `pnpm install` unless lockfiles change:
+
+    ```dockerfile
+    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"]
+    ```
+
+  </Accordion>
+
+  <Accordion title="Power-user container options">
+    The default image is security-first and runs as non-root `node`. For a more
+    full-featured container:
+
+    1. **Persist `/home/node`**: `export QUANTUMCLAW_HOME_VOLUME="quantumclaw_home"`
+    2. **Bake system deps**: `export QUANTUMCLAW_DOCKER_APT_PACKAGES="git curl jq"`
+    3. **Install Playwright browsers**:
+       ```bash
+       docker compose run --rm quantumclaw-cli \
+         node /app/node_modules/playwright-core/cli.js install chromium
+       ```
+    4. **Persist browser downloads**: set
+       `PLAYWRIGHT_BROWSERS_PATH=/home/node/.cache/ms-playwright` and use
+       `QUANTUMCLAW_HOME_VOLUME` or `QUANTUMCLAW_EXTRA_MOUNTS`.
+
+  </Accordion>
+
+  <Accordion title="OpenAI Codex OAuth (headless Docker)">
+    If you pick OpenAI Codex OAuth in the wizard, it opens a browser URL. In
+    Docker or headless setups, copy the full redirect URL you land on and paste
+    it back into the wizard to finish auth.
+  </Accordion>
+
+  <Accordion title="Base image metadata">
+    The main Docker image uses `node:24-bookworm` and publishes OCI base-image
+    annotations including `org.opencontainers.image.base.name`,
+    `org.opencontainers.image.source`, and others. See
+    [OCI image annotations](https://github.com/opencontainers/image-spec/blob/main/annotations.md).
+  </Accordion>
+</AccordionGroup>
+
+### Running on a VPS?
+
+See [Hetzner (Docker VPS)](/install/hetzner) and
+[Docker VM Runtime](/install/docker-vm-runtime) for shared VM deployment steps
+including binary baking, persistence, and updates.
+
+## Agent Sandbox
+
+When `agents.defaults.sandbox` is enabled, the gateway runs agent tool execution
+(shell, file read/write, etc.) inside isolated Docker containers while the
+gateway itself stays on the host. This gives you a hard wall around untrusted or
+multi-tenant agent sessions without containerizing the entire gateway.
+
+Sandbox scope can be per-agent (default), per-session, or shared. Each scope
+gets its own workspace mounted at `/workspace`. You can also configure
+allow/deny tool policies, network isolation, resource limits, and browser
+containers.
+
+For full configuration, images, security notes, and multi-agent profiles, see:
+
+- [Sandboxing](/gateway/sandboxing) -- complete sandbox reference
+- [OpenShell](/gateway/openshell) -- interactive shell access to sandbox containers
+- [Multi-Agent Sandbox and Tools](/tools/multi-agent-sandbox-tools) -- per-agent overrides
+
+### Quick enable
+
+```json5
+{
+  agents: {
+    defaults: {
+      sandbox: {
+        mode: "non-main", // off | non-main | all
+        scope: "agent", // session | agent | shared
+      },
+    },
+  },
+}
+```
+
+Build the default sandbox image:
+
+```bash
+scripts/sandbox-setup.sh
+```
+
+## Troubleshooting
+
+<AccordionGroup>
+  <Accordion title="Image missing or sandbox container not starting">
+    Build the sandbox image with
+    [`scripts/sandbox-setup.sh`](https://github.com/quantumclaw/quantumclaw/blob/main/scripts/sandbox-setup.sh)
+    or set `agents.defaults.sandbox.docker.image` to your custom image.
+    Containers are auto-created per session on demand.
+  </Accordion>
+
+  <Accordion title="Permission errors in sandbox">
+    Set `docker.user` to a UID:GID that matches your mounted workspace ownership,
+    or chown the workspace folder.
+  </Accordion>
+
+  <Accordion title="Custom tools not found in sandbox">
+    QuantumClaw runs commands with `sh -lc` (login shell), which sources
+    `/etc/profile` and may reset PATH. Set `docker.env.PATH` to prepend your
+    custom tool paths, or add a script under `/etc/profile.d/` in your Dockerfile.
+  </Accordion>
+
+  <Accordion title="OOM-killed during image build (exit 137)">
+    The VM needs at least 2 GB RAM. Use a larger machine class and retry.
+  </Accordion>
+
+  <Accordion title="Unauthorized or pairing required in Control UI">
+    Fetch a fresh dashboard link and approve the browser device:
+
+    ```bash
+    docker compose run --rm quantumclaw-cli dashboard --no-open
+    docker compose run --rm quantumclaw-cli devices list
+    docker compose run --rm quantumclaw-cli devices approve <requestId>
+    ```
+
+    More detail: [Dashboard](/web/dashboard), [Devices](/cli/devices).
+
+  </Accordion>
+
+  <Accordion title="Gateway target shows ws://172.x.x.x or pairing errors from Docker CLI">
+    Reset gateway mode and bind:
+
+    ```bash
+    docker compose run --rm quantumclaw-cli config set gateway.mode local
+    docker compose run --rm quantumclaw-cli config set gateway.bind lan
+    docker compose run --rm quantumclaw-cli devices list --url ws://127.0.0.1:18789
+    ```
+
+  </Accordion>
+</AccordionGroup>

package/docs/install/exe-dev.md

@@ -0,0 +1,126 @@
+---
+summary: "Run QuantumClaw Gateway on exe.dev (VM + HTTPS proxy) for remote access"
+read_when:
+  - You want a cheap always-on Linux host for the Gateway
+  - You want remote Control UI access without running your own VPS
+title: "exe.dev"
+---
+
+# exe.dev
+
+Goal: QuantumClaw Gateway running on an exe.dev VM, reachable from your laptop via: `https://<vm-name>.exe.xyz`
+
+This page assumes exe.dev's default **exeuntu** image. If you picked a different distro, map packages accordingly.
+
+## Beginner quick path
+
+1. [https://exe.new/quantumclaw](https://exe.new/quantumclaw)
+2. Fill in your auth key/token as needed
+3. Click on "Agent" next to your VM and wait for Shelley to finish provisioning
+4. Open `https://<vm-name>.exe.xyz/` and paste your gateway token to authenticate
+5. Approve any pending device pairing requests with `quantumclaw devices approve <requestId>`
+
+## What you need
+
+- exe.dev account
+- `ssh exe.dev` access to [exe.dev](https://exe.dev) virtual machines (optional)
+
+## Automated Install with Shelley
+
+Shelley, [exe.dev](https://exe.dev)'s agent, can install QuantumClaw instantly with our
+prompt. The prompt used is as below:
+
+```
+Set up QuantumClaw (https://docs.quantumclaw.ai/install) on this VM. Use the non-interactive and accept-risk flags for quantumclaw onboarding. Add the supplied auth or token as needed. Configure nginx to forward from the default port 18789 to the root location on the default enabled site config, making sure to enable Websocket support. Pairing is done by "quantumclaw devices list" and "quantumclaw devices approve <request id>". Make sure the dashboard shows that QuantumClaw's health is OK. exe.dev handles forwarding from port 8000 to port 80/443 and HTTPS for us, so the final "reachable" should be <vm-name>.exe.xyz, without port specification.
+```
+
+## Manual installation
+
+## 1) Create the VM
+
+From your device:
+
+```bash
+ssh exe.dev new
+```
+
+Then connect:
+
+```bash
+ssh <vm-name>.exe.xyz
+```
+
+Tip: keep this VM **stateful**. QuantumClaw stores state under `~/.quantumclaw/` and `~/.quantumclaw/workspace/`.
+
+## 2) Install prerequisites (on the VM)
+
+```bash
+sudo apt-get update
+sudo apt-get install -y git curl jq ca-certificates openssl
+```
+
+## 3) Install QuantumClaw
+
+Run the QuantumClaw install script:
+
+```bash
+curl -fsSL https://quantumclaw.ai/install.sh | bash
+```
+
+## 4) Setup nginx to proxy QuantumClaw to port 8000
+
+Edit `/etc/nginx/sites-enabled/default` with
+
+```
+server {
+    listen 80 default_server;
+    listen [::]:80 default_server;
+    listen 8000;
+    listen [::]:8000;
+
+    server_name _;
+
+    location / {
+        proxy_pass http://127.0.0.1:18789;
+        proxy_http_version 1.1;
+
+        # WebSocket support
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection "upgrade";
+
+        # Standard proxy headers
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+
+        # Timeout settings for long-lived connections
+        proxy_read_timeout 86400s;
+        proxy_send_timeout 86400s;
+    }
+}
+```
+
+## 5) Access QuantumClaw and grant privileges
+
+Access `https://<vm-name>.exe.xyz/` (see the Control UI output from onboarding). If it prompts for auth, paste the
+token from `gateway.auth.token` on the VM (retrieve with `quantumclaw config get gateway.auth.token`, or generate one
+with `quantumclaw doctor --generate-gateway-token`). Approve devices with `quantumclaw devices list` and
+`quantumclaw devices approve <requestId>`. When in doubt, use Shelley from your browser!
+
+## Remote Access
+
+Remote access is handled by [exe.dev](https://exe.dev)'s authentication. By
+default, HTTP traffic from port 8000 is forwarded to `https://<vm-name>.exe.xyz`
+with email auth.
+
+## Updating
+
+```bash
+npm i -g quantumclaw@latest
+quantumclaw doctor
+quantumclaw gateway restart
+quantumclaw health
+```
+
+Guide: [Updating](/install/updating)