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:
Patryk Ciechanski
2025-06-12 10:05:25 +02:00
parent 3a76a42b84
commit 44a67c5895
3 changed files with 167 additions and 3 deletions

View File

@@ -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:**