docs: Add comprehensive Docker image usage instructions

- Add Option B (Published Docker Image) to main README.md - Update installation guide with published image as fastest option - Add comprehensive configuration examples for GHCR images - Document image tagging strategy (latest, versioned, PR builds) - Include version pinning examples for stability - Highlight benefits: instant setup, no build, cross-platform Users can now choose between: 1. Published image (fastest, no setup) - ghcr.io/patrykiti/gemini-mcp-server:latest 2. Local build (development, customization) - traditional setup 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-12 10:05:25 +02:00
parent 3a76a42b84
commit 44a67c5895
3 changed files with 167 additions and 3 deletions
--- a/README.md
+++ b/README.md
@@ -157,9 +157,9 @@ claude mcp list
 claude mcp remove gemini
 ```

-#### Docker Configuration (Copy from setup script output)
+#### Option A: Local Development Setup (using local Docker build)

-The setup script shows you the exact configuration. It looks like this:
+The setup script shows you the exact configuration for local development:

 ```json
 {
@@ -178,6 +178,41 @@ The setup script shows you the exact configuration. It looks like this:
 }
 ```

+#### Option B: Published Docker Image (no local setup required)
+
+**Quick setup using the published Docker image from GitHub Container Registry:**
+
+```bash
+# Pull the latest published image
+docker pull ghcr.io/patrykiti/gemini-mcp-server:latest
+```
+
+**Claude Desktop Configuration:**
+```json
+{
+  "mcpServers": {
+    "gemini": {
+      "command": "docker",
+      "args": [
+        "run", "--rm", "-i",
+        "-e", "GEMINI_API_KEY",
+        "ghcr.io/patrykiti/gemini-mcp-server:latest"
+      ],
+      "env": {
+        "GEMINI_API_KEY": "your-gemini-api-key-here"
+      }
+    }
+  }
+}
+```
+
+**Benefits of using published image:**
+- ✅ **No local build required** - Download and run immediately
+- ✅ **Always latest stable version** - Automatically updated with releases
+- ✅ **Smaller local footprint** - No source code or build dependencies needed
+- ✅ **Easy updates** - Simply pull new image versions
+- ✅ **Cross-platform** - Works on any Docker-supported platform
+
 **How it works:**
 - **Docker Compose services** run continuously in the background
 - **Redis** automatically handles conversation memory between requests  
--- a/docs/user-guides/configuration.md
+++ b/docs/user-guides/configuration.md
@@ -28,6 +28,64 @@ Add to your Claude Desktop config file:

 **Location:**
 - **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
+
+### Configuration Options
+
+#### Option 1: Published Docker Image (Recommended)
+
+**Simplest setup using pre-built images from GitHub Container Registry:**
+
+```json
+{
+  "mcpServers": {
+    "gemini": {
+      "command": "docker",
+      "args": [
+        "run", "--rm", "-i",
+        "-e", "GEMINI_API_KEY",
+        "ghcr.io/patrykiti/gemini-mcp-server:latest"
+      ],
+      "env": {
+        "GEMINI_API_KEY": "your-gemini-api-key-here"
+      }
+    }
+  }
+}
+```
+
+**Available Image Tags:**
+- `latest` - Most recent stable release (recommended)
+- `v1.2.0`, `v1.1.0` - Specific version tags
+- `pr-{number}` - Development builds from pull requests
+- `main-{commit-sha}` - Development builds from main branch
+
+**Benefits:**
+- ✅ No local build required - instant setup
+- ✅ Automatically updated with releases  
+- ✅ Smaller local footprint
+- ✅ Version pinning for stability
+- ✅ Cross-platform compatibility
+
+**Version Pinning Example:**
+```json
+{
+  "mcpServers": {
+    "gemini": {
+      "command": "docker",
+      "args": [
+        "run", "--rm", "-i",
+        "-e", "GEMINI_API_KEY",
+        "ghcr.io/patrykiti/gemini-mcp-server:v1.2.0"
+      ],
+      "env": {
+        "GEMINI_API_KEY": "your-gemini-api-key-here"
+      }
+    }
+  }
+}
+```
+
+#### Option 2: Local Development Build
 - **Windows (WSL)**: `/mnt/c/Users/USERNAME/AppData/Roaming/Claude/claude_desktop_config.json`

 **Configuration:**
--- a/docs/user-guides/installation.md
+++ b/docs/user-guides/installation.md
@@ -23,7 +23,78 @@ After following this guide, you'll have:
 - ✅ **Linux** 
 - ✅ **Windows** (requires WSL2 for Claude Desktop)

-## 🚀 Setup Option 1: Clone & Run (Recommended)
+## 🚀 Setup Option 1: Published Docker Image (Fastest)
+
+**Quick setup using pre-built image from GitHub Container Registry - no build required!**
+
+### Step 1: Pull Published Image
+
+```bash
+# Download the latest stable version
+docker pull ghcr.io/patrykiti/gemini-mcp-server:latest
+
+# Optional: Pull a specific version
+docker pull ghcr.io/patrykiti/gemini-mcp-server:v1.2.0
+```
+
+### Step 2: Configure Claude Desktop
+
+**Find your Claude Desktop config file:**
+- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
+- **Windows (WSL required)**: `/mnt/c/Users/USERNAME/AppData/Roaming/Claude/claude_desktop_config.json`
+
+**Add this configuration:**
+```json
+{
+  "mcpServers": {
+    "gemini": {
+      "command": "docker",
+      "args": [
+        "run", "--rm", "-i",
+        "-e", "GEMINI_API_KEY",
+        "ghcr.io/patrykiti/gemini-mcp-server:latest"
+      ],
+      "env": {
+        "GEMINI_API_KEY": "your-gemini-api-key-here"
+      }
+    }
+  }
+}
+```
+
+### Step 3: Update Available Tags
+
+Available image tags:
+- `latest` - Most recent stable release
+- `v1.2.0`, `v1.1.0`, etc. - Specific version releases
+- `pr-{number}` - Development builds from pull requests
+- `main-{sha}` - Development builds from main branch
+
+```bash
+# See all available tags
+docker search ghcr.io/patrykiti/gemini-mcp-server
+
+# Or check GitHub Container Registry
+open https://github.com/PatrykIti/gemini-mcp-server/pkgs/container/gemini-mcp-server
+```
+
+### Step 4: Test Installation
+
+Restart Claude Desktop and try:
+```
+"Use gemini to say hello and confirm the connection works"
+```
+
+**Benefits of Published Image:**
+- ✅ **Instant setup** - No build time, no source code needed
+- ✅ **Always updated** - Automatically built with every release
+- ✅ **Smaller footprint** - No development dependencies
+- ✅ **Version control** - Pin to specific versions for stability
+- ✅ **Cross-platform** - Works on any Docker-supported OS
+
+---
+
+## 🛠️ Setup Option 2: Local Build (For Development)

 ### Step 1: Clone Repository