Skip to content

Commit 0c9051a

Browse files
docs(docker_quick_start.md): add docker compose to quick start
1 parent dea3b53 commit 0c9051a

File tree

2 files changed

+27
-4
lines changed

2 files changed

+27
-4
lines changed

docs/my-website/docs/proxy/deploy.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@ To start using Litellm, run the following commands in a shell:
1212

1313
```bash
1414
# Get the code
15-
git clone https://github.com/BerriAI/litellm
16-
17-
# Go to folder
18-
cd litellm
15+
curl -O https://raw.githubusercontent.com/BerriAI/litellm/main/docker-compose.yml
1916

2017
# Add the master key - you can change this after setup
2118
echo 'LITELLM_MASTER_KEY="sk-1234"' > .env

docs/my-website/docs/proxy/docker_quick_start.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,30 @@ $ pip install 'litellm[proxy]'
3535

3636
</TabItem>
3737

38+
<TabItem value="docker-compose" label="Docker Compose (Proxy + DB)">
39+
40+
Use this docker compose to spin up the proxy with a postgres database running locally.
41+
42+
```bash
43+
# Get the docker compose file
44+
curl -O https://raw.githubusercontent.com/BerriAI/litellm/main/docker-compose.yml
45+
46+
# Add the master key - you can change this after setup
47+
echo 'LITELLM_MASTER_KEY="sk-1234"' > .env
48+
49+
# Add the litellm salt key - you cannot change this after adding a model
50+
# It is used to encrypt / decrypt your LLM API Key credentials
51+
# We recommend - https://1password.com/password-generator/
52+
# password generator to get a random hash for litellm salt key
53+
echo 'LITELLM_SALT_KEY="sk-1234"' >> .env
54+
55+
source .env
56+
57+
# Start
58+
docker-compose up
59+
```
60+
61+
</TabItem>
3862
</Tabs>
3963

4064
## 1. Add a model
@@ -43,6 +67,8 @@ Control LiteLLM Proxy with a config.yaml file.
4367

4468
Setup your config.yaml with your azure model.
4569

70+
Note: When using the proxy with a database, you can also **just add models via UI** (UI is available on `/ui` route).
71+
4672
```yaml
4773
model_list:
4874
- model_name: gpt-4o

0 commit comments

Comments
 (0)