Skip to content

Commit 61215ae

Browse files
committed
Update README with compose-only usage
1 parent 6b078f7 commit 61215ae

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,35 @@ Multi-provider AI proxy with a built-in admin UI, routing, and usage tracking.
88
- Provider routing, retries, and quotas
99
- SQLite-backed storage
1010

11-
## Quick Start (Docker)
11+
## Docker Compose (recommended)
12+
The service stores its data under `/data` in the container. The compose file
13+
already mounts a named volume so the SQLite DB is persisted.
14+
15+
```
16+
docker compose up -d
17+
```
18+
19+
Full example:
1220
```
13-
docker pull ghcr.io/bowl42/maxx:latest
14-
docker run --rm -p 9880:9880 ghcr.io/bowl42/maxx:latest
21+
services:
22+
maxx:
23+
image: ghcr.io/bowl42/maxx:latest
24+
container_name: maxx-next
25+
restart: unless-stopped
26+
ports:
27+
- "9880:9880"
28+
volumes:
29+
- maxx-data:/data
30+
healthcheck:
31+
test: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:9880/health"]
32+
interval: 30s
33+
timeout: 10s
34+
retries: 3
35+
start_period: 40s
36+
37+
volumes:
38+
maxx-data:
39+
driver: local
1540
```
1641

1742
## Local Development
@@ -37,5 +62,5 @@ npm run dev
3762
- Gemini: http://localhost:9880/v1beta/models/{model}:generateContent
3863

3964
## Data
40-
Default database path: `~/.config/maxx/maxx.db`
41-
65+
Default database path (non-Docker): `~/.config/maxx/maxx.db`
66+
Docker data directory: `/data` (mounted via `docker-compose.yml`)

0 commit comments

Comments
 (0)