02dc46e782
Add structured documentation covering quickstart, architecture, core concepts, API reference, adapter guides, CLI commands, deployment options, and operator/developer guides. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
72 lines
1.5 KiB
Markdown
72 lines
1.5 KiB
Markdown
---
|
|
title: Docker
|
|
summary: Docker Compose quickstart
|
|
---
|
|
|
|
# Docker
|
|
|
|
Run Paperclip in Docker without installing Node or pnpm locally.
|
|
|
|
## Compose Quickstart (Recommended)
|
|
|
|
```sh
|
|
docker compose -f docker-compose.quickstart.yml up --build
|
|
```
|
|
|
|
Open [http://localhost:3100](http://localhost:3100).
|
|
|
|
Defaults:
|
|
|
|
- Host port: `3100`
|
|
- Data directory: `./data/docker-paperclip`
|
|
|
|
Override with environment variables:
|
|
|
|
```sh
|
|
PAPERCLIP_PORT=3200 PAPERCLIP_DATA_DIR=./data/pc \
|
|
docker compose -f docker-compose.quickstart.yml up --build
|
|
```
|
|
|
|
## Manual Docker Build
|
|
|
|
```sh
|
|
docker build -t paperclip-local .
|
|
docker run --name paperclip \
|
|
-p 3100:3100 \
|
|
-e HOST=0.0.0.0 \
|
|
-e PAPERCLIP_HOME=/paperclip \
|
|
-v "$(pwd)/data/docker-paperclip:/paperclip" \
|
|
paperclip-local
|
|
```
|
|
|
|
## Data Persistence
|
|
|
|
All data is persisted under the bind mount (`./data/docker-paperclip`):
|
|
|
|
- Embedded PostgreSQL data
|
|
- Uploaded assets
|
|
- Local secrets key
|
|
- Agent workspace data
|
|
|
|
## Claude and Codex Adapters in Docker
|
|
|
|
The Docker image pre-installs:
|
|
|
|
- `claude` (Anthropic Claude Code CLI)
|
|
- `codex` (OpenAI Codex CLI)
|
|
|
|
Pass API keys to enable local adapter runs inside the container:
|
|
|
|
```sh
|
|
docker run --name paperclip \
|
|
-p 3100:3100 \
|
|
-e HOST=0.0.0.0 \
|
|
-e PAPERCLIP_HOME=/paperclip \
|
|
-e OPENAI_API_KEY=sk-... \
|
|
-e ANTHROPIC_API_KEY=sk-... \
|
|
-v "$(pwd)/data/docker-paperclip:/paperclip" \
|
|
paperclip-local
|
|
```
|
|
|
|
Without API keys, the app runs normally — adapter environment checks will surface missing prerequisites.
|