Skip to content

Commit b71edcd

Browse files
committed
README
1 parent 01aef37 commit b71edcd

1 file changed

Lines changed: 52 additions & 50 deletions

File tree

README.md

Lines changed: 52 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -71,56 +71,7 @@ test the response times for all configured providers and models, the results of
7171
pip install llms-py
7272
```
7373

74-
### Using Docker
75-
76-
**a) Simple - Run in a Docker container:**
77-
78-
Run the server on port `8000`:
79-
80-
```bash
81-
docker run -p 8000:8000 -e GROQ_API_KEY=$GROQ_API_KEY ghcr.io/servicestack/llms:latest
82-
```
83-
84-
Get the latest version:
85-
86-
```bash
87-
docker pull ghcr.io/servicestack/llms:latest
88-
```
89-
90-
Use custom `llms.json` and `ui.json` config files outside of the container (auto created if they don't exist):
91-
92-
```bash
93-
docker run -p 8000:8000 -e GROQ_API_KEY=$GROQ_API_KEY \
94-
-v ~/.llms:/home/llms/.llms \
95-
ghcr.io/servicestack/llms:latest
96-
```
97-
98-
**b) Recommended - Use Docker Compose:**
99-
100-
Download and use [docker-compose.yml](https://raw.githubusercontent.com/ServiceStack/llms/refs/heads/main/docker-compose.yml):
101-
102-
```bash
103-
curl -O https://raw.githubusercontent.com/ServiceStack/llms/refs/heads/main/docker-compose.yml
104-
```
105-
106-
Update API Keys in `docker-compose.yml` then start the server:
107-
108-
```bash
109-
docker-compose up -d
110-
```
111-
112-
**c) Build and run local Docker image from source:**
113-
114-
```bash
115-
git clone https://github.com/ServiceStack/llms
116-
117-
docker-compose -f docker-compose.local.yml up -d --build
118-
```
119-
120-
After the container starts, you can access the UI and API at `http://localhost:8000`.
121-
122-
123-
See [DOCKER.md](DOCKER.md) for detailed instructions on customizing configuration files.
74+
[Using Docker](#using-docker).
12475

12576
## Quick Start
12677

@@ -184,6 +135,57 @@ llms --disable openrouter_free codestral google_free groq
184135
llms --enable openrouter anthropic google openai grok z.ai qwen mistral
185136
```
186137

138+
## Using Docker
139+
140+
#### a) Simple - Run in a Docker container:
141+
142+
Run the server on port `8000`:
143+
144+
```bash
145+
docker run -p 8000:8000 -e GROQ_API_KEY=$GROQ_API_KEY ghcr.io/servicestack/llms:latest
146+
```
147+
148+
Get the latest version:
149+
150+
```bash
151+
docker pull ghcr.io/servicestack/llms:latest
152+
```
153+
154+
Use custom `llms.json` and `ui.json` config files outside of the container (auto created if they don't exist):
155+
156+
```bash
157+
docker run -p 8000:8000 -e GROQ_API_KEY=$GROQ_API_KEY \
158+
-v ~/.llms:/home/llms/.llms \
159+
ghcr.io/servicestack/llms:latest
160+
```
161+
162+
#### b) Recommended - Use Docker Compose:
163+
164+
Download and use [docker-compose.yml](https://raw.githubusercontent.com/ServiceStack/llms/refs/heads/main/docker-compose.yml):
165+
166+
```bash
167+
curl -O https://raw.githubusercontent.com/ServiceStack/llms/refs/heads/main/docker-compose.yml
168+
```
169+
170+
Update API Keys in `docker-compose.yml` then start the server:
171+
172+
```bash
173+
docker-compose up -d
174+
```
175+
176+
#### c) Build and run local Docker image from source:
177+
178+
```bash
179+
git clone https://github.com/ServiceStack/llms
180+
181+
docker-compose -f docker-compose.local.yml up -d --build
182+
```
183+
184+
After the container starts, you can access the UI and API at `http://localhost:8000`.
185+
186+
187+
See [DOCKER.md](DOCKER.md) for detailed instructions on customizing configuration files.
188+
187189
## Configuration
188190

189191
The configuration file [llms.json](llms/llms.json) is saved to `~/.llms/llms.json` and defines available providers, models, and default settings. Key sections:

0 commit comments

Comments
 (0)