Docker Development Guide

This guide provides instructions for building and running the LiteLLM application using Docker and Docker Compose.

Prerequisites

Docker
Docker Compose

Building and Running the Application

To build and run the application, you will use the docker-compose.yml file located in the root of the project. This file is configured to use the Dockerfile.non_root for a secure, non-root container environment.

1. Set the Master Key

The application requires a MASTER_KEY for signing and validating tokens. You must set this key as an environment variable before running the application.

Create a .env file in the root of the project and add the following line:

MASTER_KEY=your-secret-key

Replace your-secret-key with a strong, randomly generated secret.

2. Build and Run the Containers

Once you have set the MASTER_KEY, you can build and run the containers using the following command:

docker-compose up -d --build

This command will:

Build the Docker image using Dockerfile.non_root.
Start the litellm, litellm_db, and prometheus services in detached mode (-d).
The --build flag ensures that the image is rebuilt if there are any changes to the Dockerfile or the application code.

3. Verifying the Application is Running

You can check the status of the running containers with the following command:

docker-compose ps

To view the logs of the litellm container, run:

docker-compose logs -f litellm

4. Stopping the Application

To stop the running containers, use the following command:

docker-compose down

Troubleshooting

build_admin_ui.sh: not found: This error can occur if the Docker build context is not set correctly. Ensure that you are running the docker-compose command from the root of the project.
Master key is not initialized: This error means the MASTER_key environment variable is not set. Make sure you have created a .env file in the project root with the MASTER_KEY defined.

2.0 KiB Raw Blame History