> ## Documentation Index
> Fetch the complete documentation index at: https://agdiai-597e782f.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GCP

# Agdi on GCP Compute Engine (Docker, Production VPS Guide)

## Goal

Run a persistent Agdi Gateway on a GCP Compute Engine VM using Docker, with durable state, baked-in binaries, and safe restart behavior.

If you want "Agdi 24/7 for \~\$5-12/mo", this is a reliable setup on Google Cloud.
Pricing varies by machine type and region; pick the smallest VM that fits your workload and scale up if you hit OOMs.

## What are we doing (simple terms)?

* Create a GCP project and enable billing
* Create a Compute Engine VM
* Install Docker (isolated app runtime)
* Start the Agdi Gateway in Docker
* Persist `~/.agdi` + `~/.agdi/workspace` on the host (survives restarts/rebuilds)
* Access the Control UI from your laptop via an SSH tunnel

The Gateway can be accessed via:

* SSH port forwarding from your laptop
* Direct port exposure if you manage firewalling and tokens yourself

This guide uses Debian on GCP Compute Engine.
Ubuntu also works; map packages accordingly.
For the generic Docker flow, see [Docker](https://agdiai-597e782f.mintlify.site/install/docker.md).

***

## Quick path (experienced operators)

1. Create GCP project + enable Compute Engine API
2. Create Compute Engine VM (e2-small, Debian 12, 20GB)
3. SSH into the VM
4. Install Docker
5. Clone Agdi repository
6. Create persistent host directories
7. Configure `.env` and `docker-compose.yml`
8. Bake required binaries, build, and launch

***

## What you need

* GCP account (free tier eligible for e2-micro)
* gcloud CLI installed (or use Cloud Console)
* SSH access from your laptop
* Basic comfort with SSH + copy/paste
* \~20-30 minutes
* Docker and Docker Compose
* Model auth credentials
* Optional provider credentials
  * WhatsApp QR
  * Telegram bot token
  * Gmail OAuth

***

**1. Install gcloud CLI (or use Console)**

**Option A: gcloud CLI** (recommended for automation)

Install from [https://cloud.google.com/sdk/docs/install](https://cloud.google.com/sdk/docs/install)

Initialize and authenticate:

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
gcloud init
gcloud auth login
```

**Option B: Cloud Console**

All steps can be done via the web UI at [https://console.cloud.google.com](https://console.cloud.google.com)

**2. Create a GCP project**

**CLI:**

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
gcloud projects create my-agdi-project --name="Agdi Gateway"
gcloud config set project my-agdi-project
```

Enable billing at [https://console.cloud.google.com/billing](https://console.cloud.google.com/billing) (required for Compute Engine).

Enable the Compute Engine API:

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
gcloud services enable compute.googleapis.com
```

**Console:**

1. Go to IAM & Admin > Create Project
2. Name it and create
3. Enable billing for the project
4. Navigate to APIs & Services > Enable APIs > search "Compute Engine API" > Enable

**3. Create the VM**

**Machine types:**

| Type | Specs | Cost | Notes |
| - | - | - | - |
| e2-medium | 2 vCPU, 4GB RAM | \~\$25/mo | Most reliable for local Docker builds |
| e2-small | 2 vCPU, 2GB RAM | \~\$12/mo | Minimum recommended for Docker build |
| e2-micro | 2 vCPU (shared), 1GB RAM | Free tier eligible | Often fails with Docker build OOM (exit 137) |

**CLI:**

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
gcloud compute instances create agdi-gateway \
  --zone=us-central1-a \
  --machine-type=e2-small \
  --boot-disk-size=20GB \
  --image-family=debian-12 \
  --image-project=debian-cloud
```

**Console:**

1. Go to Compute Engine > VM instances > Create instance
2. Name: `agdi-gateway`
3. Region: `us-central1`, Zone: `us-central1-a`
4. Machine type: `e2-small`
5. Boot disk: Debian 12, 20GB
6. Create

**4. SSH into the VM**

**CLI:**

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
gcloud compute ssh agdi-gateway --zone=us-central1-a
```

**Console:**

Click the "SSH" button next to your VM in the Compute Engine dashboard.

Note: SSH key propagation can take 1-2 minutes after VM creation. If connection is refused, wait and retry.

**5. Install Docker (on the VM)**

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
sudo apt-get update
sudo apt-get install -y git curl ca-certificates
curl -fsSL https://get.docker.com | sudo sh
sudo usermod -aG docker $USER
```

Log out and back in for the group change to take effect:

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
exit
```

Then SSH back in:

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
gcloud compute ssh agdi-gateway --zone=us-central1-a
```

Verify:

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
docker --version
docker compose version
```

**6. Clone the Agdi repository**

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
git clone https://github.com/agdi/agdi.git
cd agdi
```

This guide assumes you will build a custom image to guarantee binary persistence.

**7. Create persistent host directories**

Docker containers are ephemeral.
All long-lived state must live on the host.

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
mkdir -p ~/.agdi
mkdir -p ~/.agdi/workspace
```

**8. Configure environment variables**

Create `.env` in the repository root.

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
OPENCLAW_IMAGE=agdi:latest
OPENCLAW_GATEWAY_TOKEN=change-me-now
OPENCLAW_GATEWAY_BIND=lan
OPENCLAW_GATEWAY_PORT=18789

OPENCLAW_CONFIG_DIR=/home/$USER/.agdi
OPENCLAW_WORKSPACE_DIR=/home/$USER/.agdi/workspace

GOG_KEYRING_PASSWORD=change-me-now
XDG_CONFIG_HOME=/home/node/.agdi
```

Generate strong secrets:

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openssl rand -hex 32
```

**Do not commit this file.**

**9. Docker Compose configuration**

Create or update `docker-compose.yml`.

```yaml theme={"theme":{"light":"min-light","dark":"min-dark"}}
services:
  agdi-gateway:
    image: ${OPENCLAW_IMAGE}
    build: .
    restart: unless-stopped
    env_file:
      - .env
    environment:
      - HOME=/home/node
      - NODE_ENV=production
      - TERM=xterm-256color
      - OPENCLAW_GATEWAY_BIND=${OPENCLAW_GATEWAY_BIND}
      - OPENCLAW_GATEWAY_PORT=${OPENCLAW_GATEWAY_PORT}
      - OPENCLAW_GATEWAY_TOKEN=${OPENCLAW_GATEWAY_TOKEN}
      - GOG_KEYRING_PASSWORD=${GOG_KEYRING_PASSWORD}
      - XDG_CONFIG_HOME=${XDG_CONFIG_HOME}
      - PATH=/home/linuxbrew/.linuxbrew/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
    volumes:
      - ${OPENCLAW_CONFIG_DIR}:/home/node/.agdi
      - ${OPENCLAW_WORKSPACE_DIR}:/home/node/.agdi/workspace
    ports:
      # Recommended: keep the Gateway loopback-only on the VM; access via SSH tunnel.
      # To expose it publicly, remove the `127.0.0.1:` prefix and firewall accordingly.
      - "127.0.0.1:${OPENCLAW_GATEWAY_PORT}:18789"
    command:
      [
        "node",
        "dist/index.js",
        "gateway",
        "--bind",
        "${OPENCLAW_GATEWAY_BIND}",
        "--port",
        "${OPENCLAW_GATEWAY_PORT}",
        "--allow-unconfigured",
      ]
```

`--allow-unconfigured` is only for bootstrap convenience, it is not a replacement for a proper gateway configuration. Still set auth (`gateway.auth.token` or password) and use safe bind settings for your deployment.

**10. Shared Docker VM runtime steps**

Use the shared runtime guide for the common Docker host flow:

* [Bake required binaries into the image](https://agdiai-597e782f.mintlify.site/install/docker-vm-runtime.md#bake-required-binaries-into-the-image)
* [Build and launch](https://agdiai-597e782f.mintlify.site/install/docker-vm-runtime.md#build-and-launch)
* [What persists where](https://agdiai-597e782f.mintlify.site/install/docker-vm-runtime.md#what-persists-where)
* [Updates](https://agdiai-597e782f.mintlify.site/install/docker-vm-runtime.md#updates)

**11. GCP-specific launch notes**

On GCP, if build fails with `Killed` or `exit code 137` during `pnpm install --frozen-lockfile`, the VM is out of memory. Use `e2-small` minimum, or `e2-medium` for more reliable first builds.

When binding to LAN (`OPENCLAW_GATEWAY_BIND=lan`), configure a trusted browser origin before continuing:

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
docker compose run --rm agdi-cli config set gateway.controlUi.allowedOrigins '["http://127.0.0.1:18789"]' --strict-json
```

If you changed the gateway port, replace `18789` with your configured port.

**12. Access from your laptop**

Create an SSH tunnel to forward the Gateway port:

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
gcloud compute ssh agdi-gateway --zone=us-central1-a -- -L 18789:127.0.0.1:18789
```

Open in your browser:

`http://127.0.0.1:18789/`

Fetch a fresh tokenized dashboard link:

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
docker compose run --rm agdi-cli dashboard --no-open
```

Paste the token from that URL.

If Control UI shows `unauthorized` or `disconnected (1008): pairing required`, approve the browser device:

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
docker compose run --rm agdi-cli devices list
docker compose run --rm agdi-cli devices approve <requestId>
```

Need the shared persistence and update reference again?
See [Docker VM Runtime](https://agdiai-597e782f.mintlify.site/install/docker-vm-runtime.md#what-persists-where) and [Docker VM Runtime updates](https://agdiai-597e782f.mintlify.site/install/docker-vm-runtime.md#updates).

***

## Troubleshooting

**SSH connection refused**

SSH key propagation can take 1-2 minutes after VM creation. Wait and retry.

**OS Login issues**

Check your OS Login profile:

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
gcloud compute os-login describe-profile
```

Ensure your account has the required IAM permissions (Compute OS Login or Compute OS Admin Login).

**Out of memory (OOM)**

If Docker build fails with `Killed` and `exit code 137`, the VM was OOM-killed. Upgrade to e2-small (minimum) or e2-medium (recommended for reliable local builds):

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
# Stop the VM first
gcloud compute instances stop agdi-gateway --zone=us-central1-a

# Change machine type
gcloud compute instances set-machine-type agdi-gateway \
  --zone=us-central1-a \
  --machine-type=e2-small

# Start the VM
gcloud compute instances start agdi-gateway --zone=us-central1-a
```

***

## Service accounts (security best practice)

For personal use, your default user account works fine.

For automation or CI/CD pipelines, create a dedicated service account with minimal permissions:

1. Create a service account:

   ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
   gcloud iam service-accounts create agdi-deploy \
     --display-name="Agdi Deployment"
   ```

2. Grant Compute Instance Admin role (or narrower custom role):

   ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
   gcloud projects add-iam-policy-binding my-agdi-project \
     --member="serviceAccount:agdi-deploy@my-agdi-project.iam.gserviceaccount.com" \
     --role="roles/compute.instanceAdmin.v1"
   ```

Avoid using the Owner role for automation. Use the principle of least privilege.

See [https://cloud.google.com/iam/docs/understanding-roles](https://cloud.google.com/iam/docs/understanding-roles) for IAM role details.

***

## Next steps

* Set up messaging channels: [Channels](https://agdiai-597e782f.mintlify.site/channels.md)
* Pair local devices as nodes: [Nodes](https://agdiai-597e782f.mintlify.site/nodes.md)
* Configure the Gateway: [Gateway configuration](https://agdiai-597e782f.mintlify.site/gateway/configuration.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.