bartolli497/ollama-bearer-auth repository overview

⁠Ollama Behind Caddy Proxy

Caddy server to securely authenticate and proxy requests to a local Ollama instance, utilizing environment-based API key validation for enhanced security.

If you want to support multiple API keys stored in a config file, check out this repo: ollama-bearer-auth-caddy⁠.

⁠Features

• Secure API Access: Uses Caddy to enforce API key authentication, allowing only requests with valid Bearer token/api-key.
• Flexible Interaction: Supports all endpoints to interact with the Ollama API.
• Dockerized Setup: Both Ollama and Caddy are containerized.
• Latest Versions: Utilizes the latest versions of Ollama and Caddy, ensuring the setup benefits from the most recent updates, security patches, and features. Docker image is configured to pull the latest versions automatically.
• GPU Support: Based on NVIDIA CUDA 12.5.0-runtime-ubuntu22.04, optimized for GPU-accelerated host machines.
• Multi-Platform Architecture: Supports building for both linux/amd64 and linux/arm64.

⁠Requirements

• Docker
• Docker Compose or Docker Buildx tool (optional)
• openssl (optional)

⁠Run the container directly with Docker

To run the container directly using the pre-built image from Docker Hub without Docker Compose, use the following command:

docker run -p 8081:8081 -e OLLAMA_API_KEY=your_ollama_key bartolli497/ollama-bearer-auth:cuda-env

Replace your_ollama_key with the actual API key you generated.

• -p 8081:8081: Maps port 8081 on your local machine to port 8081 in the container. Change to your preferences.
• -e OLLAMA_API_KEY=your_ollama_key: Sets the OLLAMA_API_KEY environment variable in the container to your specific API key.
• bartolli497/ollama-bearer-auth:cuda-env: Specifies the Docker image to use, pulling it from Docker Hub.

Mount existing Ollama models from your host machine (optional)

docker run -p 8081:8081 -e OLLAMA_API_KEY=your_ollama_key -v ~/.ollama:/root/.ollama bartolli497/ollama-bearer-auth:cuda-env

• -v ~/.ollama:/root/.ollama: Maps the ~/.ollama directory on your host to the /root/.ollama directory in the container, ensuring necessary files are available.

Note for Windows Users

On Linux and macOS, the manifests use colons (":") in filenames, which are not permitted on Windows filesystems. Therefore, if your host machine is running Windows, you might encounter issues with these filenames.

Read more here: Issue 2032⁠ and here: Issue 2832 Comment⁠

Mount a volume to store and keep all Ollama models outside the container

docker run -p 8081:8081 -e OLLAMA_API_KEY=your_ollama_key -v ollama_docker_volume:/root/.ollama bartolli497/ollama-bearer-auth:cuda-env

⁠Build your own

Clone the repository:

git clone https://github.com/bartolli/ollama-bearer-auth.git
cd ollama-bearer-auth

⁠Configuration

To customize the server behavior and update the API key, you need to modify the Caddyfile and .env.local files according to your requirements.

⁠Generating a secure API Key

To generate a secure API key, you can use a cryptographic random method. This ensures the key is both unique and secure. Make sure you have openssl installed on your machine. You can generate the key with the following one-liner, adjust the sk-ollama- prefix to whatever you want:

echo "sk-ollama-$(openssl rand -hex 16)"

This should generate something like this:

sk-ollama-78834bcb4c76d97d35a0c1acd0d938c6

Copy the generated key and update your .env.local file with the new API key.

⁠Build and run the services using Docker Compose

This command will build multi-architecture image for both linux/amd64 and linux/arm64 architectures

docker buildx build --platform linux/amd64,linux/arm64 -t <your_username>/<image_name>:<tag> .

⁠Testing API Key Authentication

⁠Test with incorrect API Key

Test the server's response with an incorrect API key. This should return a 401 Unauthorized status:

curl -i http://localhost:8081 -H "Authorization: Bearer wrong_api_key"

⁠Test with correct API Key

Now use the API key generated earlier. This should return a 200 OK status:

curl -i http://localhost:8081 -H "Authorization: Bearer correct_api_key"

Replace correct_api_key with the actual API key you generated.

Note: This project is a modified and improved clone of ollama-auth⁠, which originally used a basic auth configuration and a fixed version of Caddy. This enhanced version leverages environment-based API key validation for enhanced security and automatically pulls the latest versions of both Ollama and Caddy.