From 0bf3de0a01f0dde5ce68a751796557c5fadfe32b Mon Sep 17 00:00:00 2001 From: Ayush Somani <25874080+geekyayush@users.noreply.github.com> Date: Wed, 6 Dec 2023 10:37:45 +0530 Subject: [PATCH] (docs) update docker compose docs --- docker-compose.yml => docker-compose.example.yml | 2 +- docs/my-website/docs/proxy/quick_start.md | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) rename docker-compose.yml => docker-compose.example.yml (90%) diff --git a/docker-compose.yml b/docker-compose.example.yml similarity index 90% rename from docker-compose.yml rename to docker-compose.example.yml index 35e283966..6fdaf1506 100644 --- a/docker-compose.yml +++ b/docker-compose.example.yml @@ -1,7 +1,7 @@ version: "3.9" services: litellm: - image: ghcr.io/berriai/litellm:main-v1.10.3 + image: ghcr.io/berriai/litellm:main ports: - "8000:8000" # Map the container port to the host, change the host port if necessary volumes: diff --git a/docs/my-website/docs/proxy/quick_start.md b/docs/my-website/docs/proxy/quick_start.md index ad45afbd7..76a043e33 100644 --- a/docs/my-website/docs/proxy/quick_start.md +++ b/docs/my-website/docs/proxy/quick_start.md @@ -328,14 +328,16 @@ docker run ghcr.io/berriai/litellm:main-v1.10.0 --port 8002 --num_workers 8 **Step 1** -(Recommended) Use the `docker-compose.yml` given in the project root. e.g. https://github.com/BerriAI/litellm/blob/main/docker-compose.yml +- (Recommended) Use the example file `docker-compose.example.yml` given in the project root. e.g. https://github.com/BerriAI/litellm/blob/main/docker-compose.example.yml + +- Rename the file `docker-compose.example.yml` to `docker-compose.yml`. Here's an example `docker-compose.yml` file ```yaml version: "3.9" services: litellm: - image: ghcr.io/berriai/litellm:main-v1.10.3 + image: ghcr.io/berriai/litellm:main ports: - "8000:8000" # Map the container port to the host, change the host port if necessary volumes: