mirror of
https://github.com/BerriAI/litellm.git
synced 2026-09-14 23:21:35 +00:00
docs: remove misleading Step 1 from Docker Compose quickstart
The Getting Started tutorial told users to pull ghcr.io/berriai/litellm-database:main-latest as Step 1, but the docker-compose.yml downloaded in Step 2 uses docker.litellm.ai/berriai/litellm:main-stable and postgres:16. The litellm-database image pull was a no-op that confused users. Remove the redundant step and renumber the remaining steps: - Old Step 2 (config files) -> Step 1 - Old Step 3 (docker compose up) -> Step 2 Fixes #26235
This commit is contained in:
parent
b8f7d61400
commit
2fcecbc055
1 changed files with 8 additions and 17 deletions
|
|
@ -104,23 +104,11 @@ $ uv tool install 'litellm[proxy]'
|
|||
|
||||
Docker Compose bundles LiteLLM with a Postgres database. Follow the steps below — the proxy will be fully running by the end.
|
||||
|
||||
### Step 1 — Pull the LiteLLM database image
|
||||
|
||||
LiteLLM provides a dedicated `litellm-database` image for proxy deployments that connect to Postgres.
|
||||
|
||||
```bash
|
||||
docker pull ghcr.io/berriai/litellm-database:main-latest
|
||||
```
|
||||
|
||||
See all available tags on the [GitHub Container Registry](https://github.com/BerriAI/litellm/pkgs/container/litellm-database).
|
||||
|
||||
---
|
||||
|
||||
### Step 2 — Set up a database
|
||||
### Step 1 — Set up a database
|
||||
|
||||
Complete all three config files **before** running `docker compose up`. The proxy server will not start correctly if any of these are missing.
|
||||
|
||||
#### 2.1 — Get `docker-compose.yml` and create `.env`
|
||||
#### 1.1 — Get `docker-compose.yml` and create `.env`
|
||||
|
||||
```bash
|
||||
# Get the docker compose file
|
||||
|
|
@ -139,7 +127,7 @@ echo 'AZURE_API_BASE="https://openai-***********/"' >> .env
|
|||
echo 'AZURE_API_KEY="your-azure-api-key"' >> .env
|
||||
```
|
||||
|
||||
#### 2.2 — Create `config.yaml`
|
||||
#### 1.2 — Create `config.yaml`
|
||||
|
||||
The default `docker-compose.yml` starts a Postgres container at `db:5432`. Your `config.yaml` must include `database_url` pointing to it:
|
||||
|
||||
|
|
@ -161,7 +149,7 @@ general_settings:
|
|||
`database_url` enables virtual keys, spend tracking, and the UI. Replace it with your [Supabase](https://supabase.com/) or [Neon](https://neon.tech/) connection string if you prefer a managed database.
|
||||
:::
|
||||
|
||||
#### 2.3 — Create `prometheus.yml`
|
||||
#### 1.3 — Create `prometheus.yml`
|
||||
|
||||
This file **must exist as a file** before `docker compose up`. If it is missing, Docker auto-creates it as an empty directory and the Prometheus container fails to start.
|
||||
|
||||
|
|
@ -193,7 +181,7 @@ All three files (`.env`, `config.yaml`, `prometheus.yml`) must be present before
|
|||
|
||||
---
|
||||
|
||||
### Step 3 — Start the proxy server and test it
|
||||
### Step 2 — Start the proxy server and test it
|
||||
|
||||
After `config.yaml`, `prometheus.yml`, and `.env` are complete, start the proxy:
|
||||
|
||||
|
|
@ -266,6 +254,9 @@ Virtual keys let you track spend, set rate limits, and control model access per
|
|||
|
||||
</TabItem>
|
||||
|
||||
|
||||
|
||||
|
||||
</Tabs>
|
||||
|
||||
:::note Docker Compose users
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue