File size: 2,275 Bytes
4a755c4 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 | # Docker Guide
Docker Compose is the recommended way to run FreeLLMAPI for personal use. The container serves the Express API and the built React dashboard from one process on port 3001, with SQLite persisted in a named volume.
## Prerequisites
- Docker
- Docker Compose
- OpenSSL for generating `ENCRYPTION_KEY`
## Quick Start
Create a `.env` file with a 32-byte encryption key:
```bash
ENCRYPTION_KEY="$(openssl rand -hex 32)"
printf "ENCRYPTION_KEY=%s\nPORT=3001\n" "$ENCRYPTION_KEY" > .env
```
Start the app:
```bash
docker compose up -d
```
Open http://localhost:3001, add provider keys on the **Keys** page, then use the generated `freellmapi-...` key with any OpenAI-compatible client.
## Example API Call
```bash
curl http://localhost:3001/v1/chat/completions \
-H "Authorization: Bearer freellmapi-your-unified-key" \
-H "Content-Type: application/json" \
-d '{
"model": "auto",
"messages": [{"role": "user", "content": "Say hello from FreeLLMAPI."}]
}'
```
## Operations
Check status:
```bash
docker compose ps
```
Tail logs:
```bash
docker compose logs -f freellmapi
```
Stop the app:
```bash
docker compose down
```
Update to the latest GHCR image after a release:
```bash
docker compose pull
docker compose up -d
```
Rebuild locally from source:
```bash
docker compose up -d --build
```
## Configuration
| Variable | Required | Default | Description |
| --- | --- | --- | --- |
| `ENCRYPTION_KEY` | Yes | None | 64-character hex key used to encrypt provider API keys at rest. Generate it once and keep it stable. |
| `PORT` | No | `3001` | Host port exposed by Docker Compose. The container listens on port 3001. |
The `freellmapi-data` volume stores SQLite data at `/app/server/data`. Keep the same volume and `ENCRYPTION_KEY` when upgrading, otherwise existing encrypted provider keys cannot be decrypted.
## Published Image
Images are published to GitHub Container Registry:
```bash
docker pull ghcr.io/tashfeenahmed/freellmapi:latest
```
The Docker workflow builds pull requests without pushing. After this repository receives the workflow on `main`, pushes to `main` and version tags publish images to GHCR automatically.
|