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>
This commit is contained in:
39
README.md
39
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
|
||||
|
||||
Reference in New Issue
Block a user