Looking for the complete guide with all deployment options, AI skills, and app screenshots?
Full Setup guide β 5-minute setup
Self-Host OpenClone
Run OpenClone on your own hardware. Two free paths: on your devices, or on your own server.
Requirements
- β Docker & Docker Compose (v2+)
- β 1 GB RAM minimum (2 GB recommended)
- β Any OS: Linux, macOS, Windows (WSL2)
- β API key from OpenAI, Anthropic, or OpenRouter (BYOK)
Choose your setup
On your devices
Free Β· Recommended
Run OpenClone on your own computer and connect your phone to it. Your computer is your server. Local-first, nothing leaves your machine.
On your own server
Free Β· Advanced
Want to reach your memory even when your computer is off? Host OpenClone on a spare machine or a server you rent. Open-source, your data stays yours.
Quick Start
1
Clone the repository git clone https://github.com/PixxzR/openclone
cd openclone 2
Configure environment cp backend/.env.example backend/.env
# Edit backend/.env:
# API_KEY=your-secure-random-key
# AI_API_KEY=your-openai-or-anthropic-key 3
Start the backend cd backend
docker compose up -d 4
Verify it's running curl http://localhost:8000/api/status
# β {"status": "ok", "version": "1.0.0"} Configuration Reference
| Variable | Description | Default |
|---|---|---|
| API_KEY | Your secret key for API access | (required) |
| AI_PROVIDER | openai | anthropic | openrouter | gemini | openai |
| AI_MODEL | Model name (e.g. gpt-4o-mini) | gpt-4o-mini |
| AI_API_KEY | Your BYOK API key | (required) |
| VAULT_PATH | Path to your Obsidian vault | /app/vault |
| GIT_AUTO_PUSH | Auto-push memory to git repo | false |
| DEFAULT_LANGUAGE | Language for AI summaries | en |
Next steps
- β Install plugins β connect your first data sources
- β Download the app β iOS & Android companion
- β API reference β full endpoint documentation