ros/n8n-mcp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: make optimized Dockerfile the default - remove full variant

Browse Source 
- Rename Dockerfile.optimized to Dockerfile (now the default)
- Keep old Dockerfile as Dockerfile.old for reference
- Update GitHub Actions to use default Dockerfile
- Remove build-full job - only one image variant now
- Remove docker-compose.optimized.yml and other variants
- Update all documentation to reflect single image approach

The optimized 283MB image is now the only n8n-MCP Docker image.
This simplifies the user experience and provides the best solution
for all use cases.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
czlonkowski
2025-06-14 14:00:36 +02:00
parent e90971b2d8
commit 88dd66bb7a
12 changed files with 167 additions and 408 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
.github/workflows/docker-build.yml vendored
View File

@@ -17,8 +17,8 @@ env:
IMAGE_NAME: ${{ github.repository }} IMAGE_NAME: ${{ github.repository }}
jobs: jobs:
build-optimized: build:
name: Build Optimized Docker Image name: Build Docker Image
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions: permissions:
contents: read contents: read
@@ -56,11 +56,10 @@ jobs:
type=sha,prefix={{branch}}-,format=short type=sha,prefix={{branch}}-,format=short
type=raw,value=latest,enable={{is_default_branch}} type=raw,value=latest,enable={{is_default_branch}}
- name: Build and push optimized Docker image - name: Build and push Docker image
uses: docker/build-push-action@v5 uses: docker/build-push-action@v5
with: with:
context: . context: .
file: ./Dockerfile.optimized
platforms: linux/amd64,linux/arm64 platforms: linux/amd64,linux/arm64
push: ${{ github.event_name != 'pull_request' }} push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }} tags: ${{ steps.meta.outputs.tags }}
@@ -71,59 +70,6 @@ jobs:
BUILDKIT_INLINE_CACHE=1 BUILDKIT_INLINE_CACHE=1
provenance: false provenance: false
# Keep standard build as 'full' variant
build-full:
name: Build Full Docker Image (with n8n packages)
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Log in to GitHub Container Registry
if: github.event_name != 'pull_request'
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract metadata for full variant
id: meta-full
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
tags: |
type=ref,event=branch,suffix=-full
type=ref,event=pr,suffix=-full
type=semver,pattern={{version}}-full
type=semver,pattern={{major}}.{{minor}}-full
type=raw,value=full,enable={{is_default_branch}}
- name: Build and push full Docker image
uses: docker/build-push-action@v5
with:
context: .
file: ./Dockerfile
platforms: linux/amd64,linux/arm64
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta-full.outputs.tags }}
labels: ${{ steps.meta-full.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max
build-args: |
BUILDKIT_INLINE_CACHE=1
provenance: false
# Nginx build commented out until Phase 2 # Nginx build commented out until Phase 2
# build-nginx: # build-nginx:
# name: Build nginx-enhanced Docker Image # name: Build nginx-enhanced Docker Image

30
CLAUDE.md
View File

@@ -94,29 +94,11 @@ docker compose down # Stop containers
docker compose down -v # Stop and remove volumes docker compose down -v # Stop and remove volumes
./scripts/test-docker.sh # Test Docker deployment ./scripts/test-docker.sh # Test Docker deployment
# Optimized Docker Commands:
docker compose -f docker-compose.optimized.yml up -d # Start optimized version
docker build -f Dockerfile.optimized -t n8n-mcp:optimized . # Build optimized image
./scripts/test-optimized-docker.sh # Test optimized Docker build
``` ```
## Docker Deployment ## Docker Deployment
The project includes comprehensive Docker support with two options: The project includes optimized Docker support for easy deployment:
### Standard Docker Image (~2.6GB)
- Full n8n packages included
- Database built at runtime
- Supports dynamic node scanning
- Use for development or when you need runtime flexibility
### Optimized Docker Image (~200MB)
- Pre-built database at build time
- Minimal runtime dependencies
- 90% smaller image size
- Use for production deployments
The project includes comprehensive Docker support for easy deployment:
### Quick Start with Docker ### Quick Start with Docker
```bash ```bash
@@ -131,18 +113,18 @@ curl http://localhost:3000/health
``` ```
### Docker Features ### Docker Features
- **Multi-stage builds** for optimized image size (~150MB) - **Optimized image size** (~283MB with pre-built database)
- **Multi-stage builds** for minimal runtime dependencies
- **Dual mode support** (stdio and HTTP) in single image - **Dual mode support** (stdio and HTTP) in single image
- **Automatic database initialization** on first run - **Pre-built database** with all 525+ nodes included
- **Non-root user** execution for security - **Non-root user** execution for security
- **Health checks** built into the image - **Health checks** built into the image
- **Volume persistence** for SQLite database
- **Resource limits** configured in compose file - **Resource limits** configured in compose file
### Docker Images ### Docker Images
- `ghcr.io/czlonkowski/n8n-mcp:latest` - Simple production image - `ghcr.io/czlonkowski/n8n-mcp:latest` - Optimized production image
- `ghcr.io/czlonkowski/n8n-mcp:nginx` - Enhanced with nginx (Phase 2)
- Multi-architecture support (amd64, arm64) - Multi-architecture support (amd64, arm64)
- ~283MB compressed size
### Docker Development ### Docker Development
```bash ```bash

86
Dockerfile
View File

@@ -1,25 +1,18 @@
# Stage 1: Dependencies # Optimized Dockerfile - builds database at build time, minimal runtime image
# Stage 1: Dependencies (includes n8n for building)
FROM node:20-alpine AS deps FROM node:20-alpine AS deps
WORKDIR /app WORKDIR /app
COPY package*.json ./ COPY package*.json ./
# Configure npm for better reliability in CI # Configure npm for reliability
RUN npm config set fetch-retries 5 && \ RUN npm config set fetch-retries 5 && \
npm config set fetch-retry-mintimeout 20000 && \ npm config set fetch-retry-mintimeout 20000 && \
npm config set fetch-retry-maxtimeout 120000 && \ npm config set fetch-retry-maxtimeout 120000 && \
npm config set fetch-timeout 300000 npm config set fetch-timeout 300000
# Install all dependencies including dev for building # Install all dependencies including n8n packages
RUN npm ci RUN npm ci
# Stage 2: Production Dependencies # Stage 2: Builder (compiles TypeScript)
FROM node:20-alpine AS prod-deps
WORKDIR /app
COPY package*.json ./
# Copy all dependencies from deps stage
COPY --from=deps /app/node_modules ./node_modules
# Prune to production only (much faster than fresh install)
RUN npm prune --omit=dev
# Stage 3: Builder
FROM node:20-alpine AS builder FROM node:20-alpine AS builder
WORKDIR /app WORKDIR /app
COPY package*.json ./ COPY package*.json ./
@@ -28,43 +21,62 @@ COPY . .
# Build TypeScript # Build TypeScript
RUN npm run build RUN npm run build
# Stage 4: Runtime # Stage 3: Database Builder (extracts all node info and builds database)
FROM builder AS db-builder
WORKDIR /app
# Clone n8n-docs for documentation (if available)
RUN apk add --no-cache git && \
git clone https://github.com/n8n-io/n8n-docs.git /tmp/n8n-docs || true
ENV N8N_DOCS_PATH=/tmp/n8n-docs
# Build the complete database with source code
RUN mkdir -p data && \
node dist/scripts/rebuild-optimized.js
# Stage 4: Minimal Runtime (no n8n packages)
FROM node:20-alpine AS runtime FROM node:20-alpine AS runtime
WORKDIR /app WORKDIR /app
# Install only essential tools (flock is in util-linux) # Install only essential runtime tools
RUN apk add --no-cache curl su-exec util-linux && \ RUN apk add --no-cache curl && \
rm -rf /var/cache/apk/* rm -rf /var/cache/apk/*
# Copy production dependencies from prod-deps stage # Create package.json with only runtime dependencies
COPY --from=prod-deps /app/node_modules ./node_modules RUN echo '{ \
COPY package*.json ./ "name": "n8n-mcp-runtime", \
"version": "1.0.0", \
"private": true, \
"dependencies": { \
"@modelcontextprotocol/sdk": "^1.12.1", \
"better-sqlite3": "^11.10.0", \
"sql.js": "^1.13.0", \
"express": "^5.1.0", \
"dotenv": "^16.5.0" \
} \
}' > package.json
# Install only runtime dependencies
RUN npm config set fetch-retries 5 && \
npm config set fetch-retry-mintimeout 20000 && \
npm install --production --no-audit --no-fund
# Copy built application # Copy built application
COPY --from=builder /app/dist ./dist COPY --from=builder /app/dist ./dist
# Create data directory # Copy pre-built database with all source code
RUN mkdir -p /app/data COPY --from=db-builder /app/data/nodes.db ./data/
# Copy necessary source files for database initialization # Copy minimal required files
COPY src/database/schema.sql ./src/database/ COPY src/database/schema-optimized.sql ./src/database/
COPY scripts ./scripts COPY .env.example ./
# Copy necessary files
COPY .env.example .env.example
COPY LICENSE LICENSE
COPY README.md README.md
# Add container labels # Add container labels
LABEL org.opencontainers.image.source="https://github.com/czlonkowski/n8n-mcp" LABEL org.opencontainers.image.source="https://github.com/czlonkowski/n8n-mcp"
LABEL org.opencontainers.image.description="n8n MCP Server - Simple Version" LABEL org.opencontainers.image.description="n8n MCP Server - Optimized Version"
LABEL org.opencontainers.image.licenses="Sustainable-Use-1.0" LABEL org.opencontainers.image.licenses="Sustainable-Use-1.0"
LABEL org.opencontainers.image.vendor="n8n-mcp" LABEL org.opencontainers.image.title="n8n-mcp-optimized"
LABEL org.opencontainers.image.title="n8n-mcp"
# Create data directory and fix permissions # Create non-root user
RUN mkdir -p /app/data && \ RUN addgroup -g 1001 -S nodejs && \
addgroup -g 1001 -S nodejs && \
adduser -S nodejs -u 1001 && \ adduser -S nodejs -u 1001 && \
chown -R nodejs:nodejs /app chown -R nodejs:nodejs /app
@@ -79,9 +91,9 @@ USER nodejs
EXPOSE 3000 EXPOSE 3000
# Health check # Health check
HEALTHCHECK --interval=30s --timeout=10s --start-period=10s --retries=3 \ HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
CMD curl -f http://127.0.0.1:3000/health || exit 1 CMD curl -f http://127.0.0.1:3000/health || exit 1
# Entrypoint # Optimized entrypoint
ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"] ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]
CMD ["node", "dist/mcp/index.js"] CMD ["node", "dist/mcp/index.js"]

87
Dockerfile.old Normal file
View File

@@ -0,0 +1,87 @@
# Stage 1: Dependencies
FROM node:20-alpine AS deps
WORKDIR /app
COPY package*.json ./
# Configure npm for better reliability in CI
RUN npm config set fetch-retries 5 && \
npm config set fetch-retry-mintimeout 20000 && \
npm config set fetch-retry-maxtimeout 120000 && \
npm config set fetch-timeout 300000
# Install all dependencies including dev for building
RUN npm ci
# Stage 2: Production Dependencies
FROM node:20-alpine AS prod-deps
WORKDIR /app
COPY package*.json ./
# Copy all dependencies from deps stage
COPY --from=deps /app/node_modules ./node_modules
# Prune to production only (much faster than fresh install)
RUN npm prune --omit=dev
# Stage 3: Builder
FROM node:20-alpine AS builder
WORKDIR /app
COPY package*.json ./
COPY --from=deps /app/node_modules ./node_modules
COPY . .
# Build TypeScript
RUN npm run build
# Stage 4: Runtime
FROM node:20-alpine AS runtime
WORKDIR /app
# Install only essential tools (flock is in util-linux)
RUN apk add --no-cache curl su-exec util-linux && \
rm -rf /var/cache/apk/*
# Copy production dependencies from prod-deps stage
COPY --from=prod-deps /app/node_modules ./node_modules
COPY package*.json ./
# Copy built application
COPY --from=builder /app/dist ./dist
# Create data directory
RUN mkdir -p /app/data
# Copy necessary source files for database initialization
COPY src/database/schema.sql ./src/database/
COPY scripts ./scripts
# Copy necessary files
COPY .env.example .env.example
COPY LICENSE LICENSE
COPY README.md README.md
# Add container labels
LABEL org.opencontainers.image.source="https://github.com/czlonkowski/n8n-mcp"
LABEL org.opencontainers.image.description="n8n MCP Server - Simple Version"
LABEL org.opencontainers.image.licenses="Sustainable-Use-1.0"
LABEL org.opencontainers.image.vendor="n8n-mcp"
LABEL org.opencontainers.image.title="n8n-mcp"
# Create data directory and fix permissions
RUN mkdir -p /app/data && \
addgroup -g 1001 -S nodejs && \
adduser -S nodejs -u 1001 && \
chown -R nodejs:nodejs /app
# Copy entrypoint script
COPY docker/docker-entrypoint.sh /usr/local/bin/
RUN chmod +x /usr/local/bin/docker-entrypoint.sh
# Switch to non-root user
USER nodejs
# Expose HTTP port
EXPOSE 3000
# Health check
HEALTHCHECK --interval=30s --timeout=10s --start-period=10s --retries=3 \
CMD curl -f http://127.0.0.1:3000/health || exit 1
# Entrypoint
ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]
CMD ["node", "dist/mcp/index.js"]

131
Dockerfile.optimized
View File

@@ -1,131 +0,0 @@
# Optimized Dockerfile - builds database at build time, minimal runtime image
# Stage 1: Dependencies (includes n8n for building)
FROM node:20-alpine AS deps
WORKDIR /app
COPY package*.json ./
# Configure npm for reliability
RUN npm config set fetch-retries 5 && \
npm config set fetch-retry-mintimeout 20000 && \
npm config set fetch-retry-maxtimeout 120000 && \
npm config set fetch-timeout 300000
# Install all dependencies including n8n packages
RUN npm ci
# Stage 2: Builder (compiles TypeScript)
FROM node:20-alpine AS builder
WORKDIR /app
COPY package*.json ./
COPY --from=deps /app/node_modules ./node_modules
COPY . .
# Build TypeScript
RUN npm run build
# Stage 3: Database Builder (extracts all node info and builds database)
FROM builder AS db-builder
WORKDIR /app
# Clone n8n-docs for documentation (if available)
RUN apk add --no-cache git && \
git clone https://github.com/n8n-io/n8n-docs.git /tmp/n8n-docs || true
ENV N8N_DOCS_PATH=/tmp/n8n-docs
# Build the complete database with source code
RUN mkdir -p data && \
node dist/scripts/rebuild-optimized.js
# Stage 4: Minimal Runtime (no n8n packages)
FROM node:20-alpine AS runtime
WORKDIR /app
# Install only essential runtime tools
RUN apk add --no-cache curl && \
rm -rf /var/cache/apk/*
# Create package.json with only runtime dependencies
RUN echo '{ \
"name": "n8n-mcp-runtime", \
"version": "1.0.0", \
"private": true, \
"dependencies": { \
"@modelcontextprotocol/sdk": "^1.12.1", \
"better-sqlite3": "^11.10.0", \
"sql.js": "^1.13.0", \
"express": "^5.1.0", \
"dotenv": "^16.5.0" \
} \
}' > package.json
# Install only runtime dependencies
RUN npm config set fetch-retries 5 && \
npm config set fetch-retry-mintimeout 20000 && \
npm install --production --no-audit --no-fund
# Copy built application
COPY --from=builder /app/dist ./dist
# Copy pre-built database with all source code
COPY --from=db-builder /app/data/nodes.db ./data/
# Copy minimal required files
COPY src/database/schema-optimized.sql ./src/database/
COPY .env.example ./
# Add container labels
LABEL org.opencontainers.image.source="https://github.com/czlonkowski/n8n-mcp"
LABEL org.opencontainers.image.description="n8n MCP Server - Optimized Version"
LABEL org.opencontainers.image.licenses="Sustainable-Use-1.0"
LABEL org.opencontainers.image.title="n8n-mcp-optimized"
# Create non-root user
RUN addgroup -g 1001 -S nodejs && \
adduser -S nodejs -u 1001 && \
chown -R nodejs:nodejs /app
# Create optimized entrypoint
RUN echo '#!/bin/sh\n\
set -e\n\
\n\
# Validate AUTH_TOKEN in HTTP mode\n\
if [ "$MCP_MODE" = "http" ] && [ -z "$AUTH_TOKEN" ]; then\n\
echo "ERROR: AUTH_TOKEN is required when running in HTTP mode"\n\
exit 1\n\
fi\n\
\n\
# Check if database exists\n\
if [ ! -f "/app/data/nodes.db" ]; then\n\
echo "ERROR: Pre-built database not found at /app/data/nodes.db"\n\
echo "This optimized image requires the database to be built at Docker build time"\n\
exit 1\n\
fi\n\
\n\
# Validate database\n\
node -e "\n\
const Database = require(\"better-sqlite3\");\n\
try {\n\
const db = new Database(\"/app/data/nodes.db\", { readonly: true });\n\
const count = db.prepare(\"SELECT COUNT(*) as count FROM nodes\").get();\n\
console.log(\"Database validated: \" + count.count + \" nodes found\");\n\
db.close();\n\
} catch (error) {\n\
console.error(\"Database validation failed:\", error);\n\
process.exit(1);\n\
}\n\
"\n\
\n\
# Start the application\n\
exec "$@"\n\
' > /usr/local/bin/docker-entrypoint.sh && \
chmod +x /usr/local/bin/docker-entrypoint.sh
# Switch to non-root user
USER nodejs
# Expose HTTP port
EXPOSE 3000
# Health check
HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
CMD curl -f http://127.0.0.1:3000/health || exit 1
# Optimized entrypoint
ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]
CMD ["node", "dist/mcp/index.js"]

49
Dockerfile.optimized-simple
View File

@@ -1,49 +0,0 @@
# Simplified optimized Dockerfile for testing
# Stage 1: Build and create database
FROM node:20-alpine AS builder
WORKDIR /app
# Copy everything
COPY . .
# Install dependencies and build
RUN npm ci && npm run build
# Build optimized database (this embeds source code)
RUN mkdir -p data && npm run rebuild:optimized || npm run rebuild
# Stage 2: Minimal runtime
FROM node:20-alpine AS runtime
WORKDIR /app
# Install only runtime dependencies
RUN apk add --no-cache curl
# Create minimal package.json
COPY package*.json ./
RUN npm ci --omit=dev && \
# Remove n8n packages after install
npm uninstall n8n n8n-core n8n-workflow @n8n/n8n-nodes-langchain || true && \
# Clean up
npm cache clean --force
# Copy built app and database
COPY --from=builder /app/dist ./dist
COPY --from=builder /app/data ./data
COPY src/database/schema*.sql ./src/database/
# Simple entrypoint
RUN echo '#!/bin/sh\n\
if [ "$MCP_MODE" = "http" ] && [ -z "$AUTH_TOKEN" ]; then\n\
echo "ERROR: AUTH_TOKEN required for HTTP mode"\n\
exit 1\n\
fi\n\
exec "$@"' > /entrypoint.sh && chmod +x /entrypoint.sh
USER node
EXPOSE 3000
HEALTHCHECK CMD curl -f http://localhost:3000/health || exit 1
ENTRYPOINT ["/entrypoint.sh"]
CMD ["node", "dist/mcp/index.js"]

4
README.md
View File

@@ -65,9 +65,7 @@ npm run test-nodes
## Docker Quick Start 🐳 ## Docker Quick Start 🐳
The easiest way to get started is using Docker. We provide two image variants: The easiest way to get started is using Docker:
- **Optimized** (`latest`): ~200MB, pre-built database, recommended for production
- **Full** (`full`): 2.6GB, includes n8n packages, for development/dynamic scanning
### Option 1: Simple HTTP Server (Recommended) ### Option 1: Simple HTTP Server (Recommended)

41
docker-compose.optimized.yml
View File

@@ -1,41 +0,0 @@
# Docker Compose for optimized n8n-MCP image
# This version has pre-built database and minimal runtime dependencies
services:
n8n-mcp-optimized:
build:
context: .
dockerfile: Dockerfile.optimized
image: n8n-mcp:optimized
container_name: n8n-mcp-optimized
restart: unless-stopped
environment:
MCP_MODE: ${MCP_MODE:-http}
AUTH_TOKEN: ${AUTH_TOKEN:?AUTH_TOKEN is required for HTTP mode}
NODE_ENV: production
LOG_LEVEL: ${LOG_LEVEL:-info}
ports:
- "${PORT:-3000}:3000"
volumes:
# Note: Database is pre-built in the image, no volume needed
# Only mount if you need to preserve logs or other runtime data
- n8n-mcp-logs:/app/logs
deploy:
resources:
limits:
memory: 256M # Much lower than original!
reservations:
memory: 128M
healthcheck:
test: ["CMD", "curl", "-f", "http://127.0.0.1:3000/health"]
interval: 30s
timeout: 10s
retries: 3
start_period: 5s
labels:
com.n8n-mcp.version: "optimized"
com.n8n-mcp.description: "Optimized build with pre-built database"
volumes:
n8n-mcp-logs:
name: n8n-mcp-logs

1
docker-compose.yml
View File

@@ -3,7 +3,6 @@ version: '3.8'
services: services:
n8n-mcp: n8n-mcp:
# Use 'latest' for optimized image (~200MB) or 'full' for development (2.6GB)
image: ghcr.io/czlonkowski/n8n-mcp:latest image: ghcr.io/czlonkowski/n8n-mcp:latest
container_name: n8n-mcp container_name: n8n-mcp
restart: unless-stopped restart: unless-stopped

30
docs/DOCKER_OPTIMIZATION_GUIDE.md
View File

@@ -80,19 +80,13 @@ The optimized build cannot:
- To update nodes, rebuild the Docker image - To update nodes, rebuild the Docker image
- Custom nodes must be present during build - Custom nodes must be present during build
## When to Use Each Version ## Benefits of Optimization
### Use Original When: The optimized Docker image is now the default and only version, providing:
- You need to dynamically scan for nodes - **Production-ready**: Pre-built database with all nodes
- You're developing custom nodes - **Resource-efficient**: Only ~283MB vs 2.6GB
- You need to rebuild database at runtime - **Fast startup**: No database building required
- Image size is not a concern - **Minimal attack surface**: No unnecessary dependencies
### Use Optimized When:
- Production deployments
- Resource-constrained environments
- Fast startup is important
- You want minimal attack surface
## Testing the Optimized Build ## Testing the Optimized Build
@@ -185,10 +179,10 @@ Some tools are disabled in optimized build:
## Summary ## Summary
The optimized Docker build is ideal for production deployments where: The optimized Docker build is now the standard n8n-MCP Docker image, providing:
- Image size matters - Dramatically reduced image size (283MB vs 2.6GB)
- Fast startup is required - Fast startup with pre-built database
- Resource usage should be minimal - Minimal resource usage
- Node set is stable - All 525+ nodes included and ready to use
For development or dynamic environments, continue using the original build. This optimization makes n8n-MCP suitable for any deployment scenario while maintaining full functionality.

47
docs/DOCKER_README.md
View File

@@ -33,11 +33,10 @@ curl http://localhost:3000/health
### 2. Using Pre-built Images ### 2. Using Pre-built Images
Pre-built images are available on GitHub Container Registry in two variants: Pre-built images are available on GitHub Container Registry:
#### Optimized Image (Recommended)
```bash ```bash
# Pull the optimized image (~200MB) # Pull the latest image (~283MB)
docker pull ghcr.io/czlonkowski/n8n-mcp:latest docker pull ghcr.io/czlonkowski/n8n-mcp:latest
# Run with HTTP mode # Run with HTTP mode
@@ -49,21 +48,6 @@ docker run -d \
ghcr.io/czlonkowski/n8n-mcp:latest ghcr.io/czlonkowski/n8n-mcp:latest
``` ```
#### Full Image (Development)
```bash
# Pull the full image with n8n packages (2.6GB)
docker pull ghcr.io/czlonkowski/n8n-mcp:full
# Run with dynamic node scanning capability
docker run -d \
--name n8n-mcp-full \
-e MCP_MODE=http \
-e AUTH_TOKEN=your-secure-token \
-p 3000:3000 \
-v n8n-mcp-data:/app/data \
ghcr.io/czlonkowski/n8n-mcp:full
```
## 📋 Configuration Options ## 📋 Configuration Options
### Environment Variables ### Environment Variables
@@ -439,31 +423,16 @@ secrets:
## 📦 Available Images ## 📦 Available Images
### Optimized Images (~200MB) - `ghcr.io/czlonkowski/n8n-mcp:latest` - Latest stable release
- `ghcr.io/czlonkowski/n8n-mcp:latest` - Latest optimized release - `ghcr.io/czlonkowski/n8n-mcp:2.3.0` - Specific version
- `ghcr.io/czlonkowski/n8n-mcp:2.3.0` - Specific version (optimized) - `ghcr.io/czlonkowski/n8n-mcp:main-abc123` - Development builds
- `ghcr.io/czlonkowski/n8n-mcp:main-abc123` - Development builds (optimized)
### Full Images (2.6GB)
- `ghcr.io/czlonkowski/n8n-mcp:full` - Latest full release
- `ghcr.io/czlonkowski/n8n-mcp:2.3.0-full` - Specific version (full)
- `ghcr.io/czlonkowski/n8n-mcp:main-full` - Development builds (full)
### Image Details ### Image Details
#### Optimized Variant
- Base: `node:20-alpine` - Base: `node:20-alpine`
- Size: ~200MB compressed - Size: ~283MB compressed
- Features: Pre-built database, minimal runtime - Features: Pre-built database with all node information
- Use case: Production deployments - Database: Complete SQLite with 525+ nodes
#### Full Variant
- Base: `node:20-alpine`
- Size: ~2.6GB compressed
- Features: Full n8n packages, dynamic scanning
- Use case: Development, custom nodes
Both variants:
- Architectures: `linux/amd64`, `linux/arm64` - Architectures: `linux/amd64`, `linux/arm64`
- Updated: Automatically via GitHub Actions - Updated: Automatically via GitHub Actions

9
docs/RELEASE_GUIDE.md
View File

@@ -15,18 +15,11 @@ git push origin v1.2.3
``` ```
This will automatically create the following Docker tags: This will automatically create the following Docker tags:
**Optimized Images:**
- `ghcr.io/czlonkowski/n8n-mcp:1.2.3` (exact version) - `ghcr.io/czlonkowski/n8n-mcp:1.2.3` (exact version)
- `ghcr.io/czlonkowski/n8n-mcp:1.2` (minor version) - `ghcr.io/czlonkowski/n8n-mcp:1.2` (minor version)
- `ghcr.io/czlonkowski/n8n-mcp:1` (major version) - `ghcr.io/czlonkowski/n8n-mcp:1` (major version)
- `ghcr.io/czlonkowski/n8n-mcp:latest` (if from main branch) - `ghcr.io/czlonkowski/n8n-mcp:latest` (if from main branch)
**Full Images:**
- `ghcr.io/czlonkowski/n8n-mcp:1.2.3-full` (exact version)
- `ghcr.io/czlonkowski/n8n-mcp:1.2-full` (minor version)
- `ghcr.io/czlonkowski/n8n-mcp:full` (if from main branch)
## Tag Types Explained ## Tag Types Explained
### Latest Tag ### Latest Tag
@@ -133,7 +126,7 @@ services:
n8n-mcp: n8n-mcp:
image: ghcr.io/czlonkowski/n8n-mcp:1.2 image: ghcr.io/czlonkowski/n8n-mcp:1.2
# Latest version (for development/testing) # Latest version (for testing)
services: services:
n8n-mcp: n8n-mcp:
image: ghcr.io/czlonkowski/n8n-mcp:latest image: ghcr.io/czlonkowski/n8n-mcp:latest