update docker compose and readme

Author: gitmotion

README.md

@@ -1,2 +1,188 @@
-# ollama-api-server
-Expose a local ollama api behind defined api keys - easy setup with docker!
+# 🦙 Ollama API Server
+
+Secure your local Ollama instance with API keys and enhanced features - simple setup with Docker!
+
+<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)
+- [🚀 Quick Start](#🚀-quick-start)
+- [📖 Detailed Setup](#📖-detailed-setup)
+  - [🐳 Docker Setup (Recommended)](#🐳-docker-setup-recommended)
+  - [📂 Docker Image](#📂-docker-image)
+  - [📄 Docker Compose Configuration](#📄-docker-compose-configuration)
+  - [💻 Local Setup](#💻-local-setup)
+- [⚙️ Configuration](#⚙️-configuration)
+- [🔌 API Endpoints](#🔌-api-endpoints)
+- [🔐 Authentication](#🔐-authentication)
+
+## ⭐ Features
+- 🔑 API Key Authentication
+- 🔄 CORS Support
+- 🚀 Connection Pooling
+- 🌊 Streaming Support
+- 🐳 Easy Docker Setup
+- 🔌 All Ollama API Endpoints Supported
+
+## 🚀 Quick Start
+
+```bash
+# 1. Create a .env file with your API keys
+echo "API_KEYS=your-secret-key-1,your-secret-key-2" > .env
+
+# 2. Start the server with Docker
+docker compose up -d
+```
+
+That's it! Your secure Ollama API server is running on port 7777.
+
+## 📖 Detailed Setup
+
+### 🐳 Docker Setup (Recommended)
+
+### 📂 Docker Image
+
+The official Docker image is available on Docker Hub and GitHub Container Registry:
+
+```bash
+# Docker Hub
+docker pull gitmotion/ollama-api-server:latest
+
+# GitHub Container Registry
+docker pull ghcr.io/gitmotion/ollama-api-server:latest
+```
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/gitmotion/ollama-api-server.git
+   cd ollama-api-server
+   ```
+
+2. Create a .env file:
+   ```bash
+   cp .env.example .env
+   ```
+
+3. Edit the .env file with your preferred settings:
+   ```env
+   PORT_EXTERNAL=7777
+   OLLAMA_BASE_URL=http://localhost:11434
+   CORS_ORIGIN=*
+   API_KEYS=your-secret-key-1,your-secret-key-2
+   ```
+
+4. Start the server:
+   ```bash
+   docker compose up -d
+   ```
+
+### 📄 Docker Compose Configuration
+
+The server uses the following `docker-compose.yml` configuration:
+
+```yaml
+services:
+  api:
+    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:-default-key-1,default-key-2}
+```
+
+This configuration:
+- Uses the official Docker image
+- Maps the container's port 7777 to your host's port (configurable via PORT_EXTERNAL)
+- Sets up the required environment variables
+- Provides default API keys if none are specified
+
+You can customize the configuration by:
+1. Changing the external port (PORT_EXTERNAL in .env)
+2. Setting your API keys (API_KEYS in .env)
+3. Modifying the Ollama base URL if needed
+4. Adjusting CORS settings for your environment
+
+### 💻 Local Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/gitmotion/ollama-api-server.git
+   cd ollama-api-server
+   ```
+
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+
+3. Create and configure .env file:
+   ```bash
+   cp .env.example .env
+   # Edit .env with your settings
+   ```
+
+4. Build and start the server:
+   ```bash
+   npm run build
+   npm start
+   ```
+
+## ⚙️ Configuration
+
+The server can be configured using environment variables:
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| PORT | Server port | 7777 |
+| OLLAMA_BASE_URL | URL of your Ollama instance | http://localhost:11434 |
+| CORS_ORIGIN | CORS origin setting | * |
+| API_KEYS | Comma-separated list of valid API keys | default-key-1,default-key-2 |
+
+## 🔌 API Endpoints
+
+All Ollama API endpoints are supported with authentication:
+
+- `POST /api/chat` - Chat completion
+- `POST /api/generate` - Text generation
+- `POST /api/embeddings` - Generate embeddings
+- `GET /api/tags` - List available models
+- `POST /api/show` - Show model details
+- `POST /api/pull` - Pull a model
+- `DELETE /api/delete` - Delete a model
+- `POST /api/copy` - Copy a model
+- `GET /api/version` - Get Ollama version
+- `GET /health` - Health check endpoint
+
+## 🔐 Authentication
+
+Include your API key in requests using one of these methods:
+
+1. X-API-Key header:
+   ```bash
+   curl -H "x-api-key: your-api-key" http://localhost:7777/api/tags
+   ```
+
+2. Authorization header:
+   ```bash
+   curl -H "Authorization: Bearer your-api-key" http://localhost:7777/api/tags
+   ```
+
+3. Request body:
+   ```bash
+   curl -X POST -H "Content-Type: application/json" \
+        -d '{"apiKey": "your-api-key"}' \
+        http://localhost:7777/api/tags
+   ```
+
+For the latest version and updates, check out our GitHub repository.
+
+___
+
+Made with ❤️ by [gitmotion](https://github.com/gitmotion)

docker-compose.yml

@@ -2,11 +2,12 @@ services:
   api:
     # image: gitmotion/ollama-api-server:latest
     build: .
-    container_name: ollama-api
+    container_name: ollama-api-server
+    restart: unless-stopped
     ports:
       - "${PORT_EXTERNAL:-7777}:7777"
     environment:
       - PORT=7777
-      - OLLAMA_BASE_URL=http://127.0.0.1:11434
+      - 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:-default-key-1,default-key-2}