Document OpenClaw setup requirements and API configuration
Added detailed documentation explaining: - OpenClaw is open-source but requires AI provider API keys - Three setup options: interactive wizard, manual config, or web UI - Links to get API keys from major providers - Clarified that OpenClaw itself is free, only API usage costs - Added first-time setup note in Quick Start section Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
parent
a735166c08
commit
2e497d1ecf
39
README.md
39
README.md
|
|
@ -14,6 +14,8 @@ Access from any device on your LAN:
|
||||||
- **Desktop (VNC)**: `http://YOUR_IP:6901` (no password)
|
- **Desktop (VNC)**: `http://YOUR_IP:6901` (no password)
|
||||||
- **OpenClaw Gateway**: `http://YOUR_IP:18789`
|
- **OpenClaw Gateway**: `http://YOUR_IP:18789`
|
||||||
|
|
||||||
|
**First-time setup:** OpenClaw requires API keys from AI providers (Anthropic, OpenAI, Google, etc.). See [OpenClaw Setup](#openclaw-setup) below.
|
||||||
|
|
||||||
## Run (Docker Compose)
|
## Run (Docker Compose)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -40,13 +42,48 @@ docker build -t clawtainer:local .
|
||||||
3. Add port **18789** to the workspace's port configuration
|
3. Add port **18789** to the workspace's port configuration
|
||||||
4. Save and launch a session
|
4. Save and launch a session
|
||||||
|
|
||||||
|
## OpenClaw Setup
|
||||||
|
|
||||||
|
OpenClaw is an **open-source AI agent orchestration platform** that connects to AI provider APIs (Anthropic, OpenAI, Google, etc.). The Gateway auto-starts on port 18789, but you need to configure it with your own API keys.
|
||||||
|
|
||||||
|
**Setup Options:**
|
||||||
|
|
||||||
|
1. **Interactive Wizard** (easiest):
|
||||||
|
```bash
|
||||||
|
openclaw onboard
|
||||||
|
```
|
||||||
|
Walks you through model selection and API key entry.
|
||||||
|
|
||||||
|
2. **Manual Configuration**:
|
||||||
|
Edit `~/.openclaw/openclaw.json` or use environment variables:
|
||||||
|
```bash
|
||||||
|
export ANTHROPIC_API_KEY="sk-ant-..."
|
||||||
|
export OPENAI_API_KEY="sk-..."
|
||||||
|
export GOOGLE_API_KEY="AIza..."
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Via Gateway UI**:
|
||||||
|
- Open `http://localhost:18789` in browser
|
||||||
|
- Navigate to Settings
|
||||||
|
- Add your API keys for desired providers
|
||||||
|
|
||||||
|
**Get API Keys:**
|
||||||
|
- **Anthropic (Claude)**: https://console.anthropic.com/
|
||||||
|
- **OpenAI (GPT)**: https://platform.openai.com/api-keys
|
||||||
|
- **Google (Gemini)**: https://makersuite.google.com/app/apikey
|
||||||
|
- **OpenRouter**: https://openrouter.ai/keys
|
||||||
|
|
||||||
|
**Note:** OpenClaw itself is free and open-source. You only pay for API usage from your chosen AI providers.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
After startup, open the desktop at port 6901. Desktop shortcuts are available:
|
After startup, open the desktop at port 6901. Desktop shortcuts are available:
|
||||||
- **OpenClaw Control** - Opens the gateway UI at `http://localhost:18789`
|
- **OpenClaw Control** - Opens the gateway UI at `http://localhost:18789`
|
||||||
- **VS Code** - Launches Visual Studio Code
|
- **VS Code** - Launches Visual Studio Code
|
||||||
|
- **Cursor** - AI-powered code editor
|
||||||
|
- **Antigravity** - Google's AI IDE
|
||||||
|
|
||||||
You can also access the Control UI in the in-session browser. Run `openclaw onboard --non-interactive` from the terminal if needed, or paste your token in Settings.
|
Access the Control UI to configure API keys, set up messaging channels (Telegram, WhatsApp, etc.), and manage AI agents.
|
||||||
|
|
||||||
## What's Included
|
## What's Included
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue