From c1117040ed1a463c422309736886cc3072f7f909 Mon Sep 17 00:00:00 2001
From: PCBZ <devil02047@outlook.com>
Date: Wed, 8 Apr 2026 23:28:44 -0700
Subject: [PATCH] add detailed README for OpenClaw deployment on DigitalOcean

---
 README.md | 117 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 115 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 704baa4..01fca3d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,115 @@
-# OpenClaw
-OpenClaw infrastructure configuration with Terraform.
+# OpenClaw on DigitalOcean
+
+[![Security Checks](https://github.com/PCBZ/OpenClaw_Docker/actions/workflows/security.yml/badge.svg)](https://github.com/PCBZ/OpenClaw_Docker/actions/workflows/security.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Last Commit](https://img.shields.io/github/last-commit/PCBZ/OpenClaw_Docker)](https://github.com/PCBZ/OpenClaw_Docker/commits/main)
+[![Terraform](https://img.shields.io/badge/Terraform-%3E%3D1.5-844fba?logo=terraform&logoColor=white)](https://www.terraform.io)
+[![DigitalOcean](https://img.shields.io/badge/DigitalOcean-Droplet-0080ff?logo=digitalocean&logoColor=white)](https://www.digitalocean.com)
+[![OpenRouter](https://img.shields.io/badge/OpenRouter-Free%20Tier-ff6b35?logoColor=white)](https://openrouter.ai)
+[![OpenClaw](https://img.shields.io/badge/OpenClaw-2026-00e5cc?logoColor=white)](https://openclaw.bot)
+[![Telegram](https://img.shields.io/badge/Telegram-Bot-26a5e4?logo=telegram&logoColor=white)](https://telegram.org)
+
+One-command deployment of an [OpenClaw](https://openclaw.bot) AI agent as a Telegram bot on DigitalOcean. After `terraform apply`, the bot is fully operational with no manual SSH steps required.
+
+## Features
+
+- Telegram bot with DM and group chat support
+- Web search via Brave Search (falls back to DuckDuckGo)
+- 8 switchable free LLM models via `/model <alias>`
+- Secrets managed via `.env` — never committed
+
+## Prerequisites
+
+- Terraform >= 1.5
+- direnv (`brew install direnv`)
+- SSH key pair
+- DigitalOcean account + API token
+- OpenRouter API key
+- Telegram bot token (from [@BotFather](https://t.me/BotFather))
+
+## Setup
+
+### 1. Configure secrets
+
+```bash
+cp .env.example .env
+```
+
+Edit `.env` and fill in your values:
+
+| Variable | Description |
+|---|---|
+| `OPENROUTER_API_KEY` | From [openrouter.ai/keys](https://openrouter.ai/keys) |
+| `TELEGRAM_BOT_TOKEN` | From [@BotFather](https://t.me/BotFather) |
+| `OPENCLAW_GATEWAY_TOKEN` | Any strong random string |
+| `BRAVE_API_KEY` | From [api.search.brave.com](https://api.search.brave.com) — optional, falls back to DuckDuckGo |
+| `TELEGRAM_OWNER_ID` | Your Telegram user ID from [@userinfobot](https://t.me/userinfobot) — grants `/model` and other privileged commands |
+
+### 2. Configure infrastructure
+
+```bash
+cd terraform/digitalOcean
+```
+
+Edit `terraform.tfvars` to set your DigitalOcean token and optionally adjust region, droplet size, and swap:
+
+```hcl
+do_token            = "dop_v1_..."
+ssh_public_key_path = "~/.ssh/id_rsa.pub"
+region              = "tor1"   # tor1, sfo3, nyc3, sgp1, ams3, ...
+droplet_size        = "s-1vcpu-1gb"  # $6/mo — increase if OOM
+swap_size           = "3G"
+```
+
+### 3. Load secrets via direnv
+
+```bash
+# First time only
+echo 'eval "$(direnv hook zsh)"' >> ~/.zshrc && source ~/.zshrc
+direnv allow
+```
+
+### 4. Deploy
+
+```bash
+terraform init   # first time only
+terraform apply
+```
+
+Wait ~5 minutes for bootstrap to complete. The bot will start automatically.
+
+### 5. Verify
+
+```bash
+terraform output ssh_command   # SSH into the server if needed
+```
+
+Send a message to your bot on Telegram to confirm it's working.
+
+## Switching Models
+
+In Telegram, use `/model <alias>`:
+
+| Alias | Model |
+|---|---|
+| `llama` | Llama 3.3 70B (default) |
+| `gemma` | Gemma 4 31B |
+| `hermes` | Hermes 3 Llama 405B |
+| `nemotron` | Nemotron Super 120B |
+| `gpt` | GPT-OSS 120B |
+| `coder` | Qwen3 Coder |
+| `uncensored` | Dolphin Mistral 24B |
+| `auto` | OpenRouter auto-select |
+
+All models are free tier on OpenRouter (rate limits apply).
+
+## Security Notes
+
+- `ssh_allowed_cidrs` and `gateway_allowed_cidrs` default to open (`0.0.0.0/0`). For production, restrict to your IP in `terraform.tfvars`:
+
+```hcl
+ssh_allowed_cidrs     = ["203.0.113.10/32"]
+gateway_allowed_cidrs = ["203.0.113.10/32"]
+```
+
+- CI security checks are defined in [.github/workflows/security.yml](.github/workflows/security.yml) (ShellCheck, .envrc policy, Checkov, Gitleaks).