update README.md

Author: gitmotion

README.md

@@ -1,13 +1,13 @@
 # 🦙 Ollama API Server
-
-Secure your local Ollama instance with API keys and enhanced features - simple setup with Docker!
+A simple, easy-to-use api server that sits in front of your local ollama instance to add additional security when making requests to ollama.
 
 <a href="https://www.buymeacoffee.com/gitmotion" target="_blank" rel="noopener noreferrer">
   <img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy me a coffee" width="150px" />
 </a>
 
 ## 📑 Table of Contents
 - [⭐ Features](#⭐-features)
+- [🎛️ Example Flow](#🎛️-example-flow)
 - [🚀 Quick Start](#🚀-quick-start)
 - [📖 Detailed Setup](#📖-detailed-setup)
   - [🐳 Docker Setup (Recommended)](#🐳-docker-setup-recommended)
@@ -26,6 +26,48 @@ Secure your local Ollama instance with API keys and enhanced features - simple s
 - 🐳 Easy Docker Setup
 - 🔌 All Ollama API Endpoints Supported
 
+## 🎛️ Example Flow
+- Example of connecting a local ollama instance to an open-webui docker container on the same docker network
+
+<div align="center">
+  <img src="https://github.com/user-attachments/assets/2840746e-9ea0-4f92-bcee-39115c5990ab" width=50% />
+</div>
+
+```mermaid
+flowchart TD
+    user([External User]) --> webui[Open WebUI]
+    
+    webui -->|Request with API Key| api[Ollama API Server]
+    
+    api --> auth{API Key Valid?}
+    auth -->|No| reject[Reject Connection]
+    auth -->|Yes| ollama[Ollama LLM Service]
+    
+    ollama -->|Response| api
+    api -->|Response| webui
+    webui -->|Response| user
+    
+    subgraph "Docker: ollama-network"
+        webui
+        api
+        auth
+        ollama
+    end
+    
+    classDef green fill:#d1e7dd,stroke:#0f5132,stroke-width:1px,color:#0f5132;
+    classDef blue fill:#cfe2ff,stroke:#084298,stroke-width:1px,color:#084298;
+    classDef red fill:#f8d7da,stroke:#842029,stroke-width:1px,color:#842029;
+    classDef yellow fill:#fff3cd,stroke:#664d03,stroke-width:1px,color:#664d03;
+    classDef gray fill:#f8f9fa,stroke:#343a40,stroke-width:1px,color:#343a40;
+    
+    class user gray
+    class webui blue
+    class api blue
+    class auth yellow
+    class ollama green
+    class reject red
+```
+
 ## 🚀 Quick Start
 
 ```bash
@@ -97,6 +139,47 @@ services:
       - API_KEYS=${API_KEYS:-default-key-1,default-key-2}
 ```
 
+#### Example of ollama-api-server with your open-webui stack:
+```yaml
+services:
+  ollama-api-server:
+    image: gitmotion/ollama-api-server:latest
+    container_name: ollama-api-server
+    restart: unless-stopped
+    ports:
+      - "${PORT_EXTERNAL:-7777}:7777"
+    environment:
+      - PORT=7777
+      - OLLAMA_BASE_URL=http://internal-ip-where-ollama-installed:11434 # must serve your ollama server with 0.0.0.0
+      - CORS_ORIGIN=*
+      - API_KEYS=${API_KEYS:-secure-api-key-1,secure-api-key-2} # UPDATE THESE KEYS - comma separated
+    networks:
+      - ollama-network
+
+  open-webui:
+    image: openwebui/open-webui:latest
+    container_name: open-webui
+    restart: unless-stopped
+    depends_on:
+      - ollama-api-server
+    ports:
+      - "3000:3000"
+    environment:
+      - OLLAMA_BASE_URL=http://ollama-api-server:7777 # Configure the api key via UI
+      - WEBUI_SECRET_KEY=${WEBUI_SECRET_KEY}
+    volumes:
+      - ./open-webui-data:/app/backend/data
+    networks:
+      - ollama-network
+      - your-external-reverse-proxy
+
+networks:
+  ollama-network:
+    driver: bridge
+  your-external-reverse-proxy:
+    external: true
+```
+
 This configuration:
 - Uses the official Docker image
 - Maps the container's port 7777 to your host's port (configurable via PORT_EXTERNAL)