From 79bbd4ba49919ec10590100a9b59157cee2e43ac Mon Sep 17 00:00:00 2001 From: czlonkowski <56956555+czlonkowski@users.noreply.github.com> Date: Wed, 25 Jun 2025 11:19:25 +0200 Subject: [PATCH] docs: clarify Docker installation requirements and add platform-specific instructions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Replace "Docker Desktop" prerequisite with generic "Docker installed" - Add detailed Docker installation instructions for macOS, Linux, and Windows - Include package manager options (Homebrew, apt-get, winget, Chocolatey) - Add Docker verification command - Update related documentation files for consistency - Use collapsible section to keep Quick Start clean Now users understand they can use any Docker installation method, not just Docker Desktop. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- README.md | 47 ++++++++++++++++++++++++++++++++++++- docs/DOCKER_README.md | 2 +- docs/INSTALLATION.md | 4 ++-- docs/README_CLAUDE_SETUP.md | 2 +- 4 files changed, 50 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3628489..d44ded7 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,52 @@ Get n8n-MCP running in 5 minutes: ### Option 1: Docker (Easiest) 🚀 -**Prerequisites:** [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed on your system +**Prerequisites:** Docker installed on your system + +
+📦 Install Docker (click to expand) + +**macOS:** +```bash +# Using Homebrew +brew install --cask docker + +# Or download from https://www.docker.com/products/docker-desktop/ +``` + +**Linux (Ubuntu/Debian):** +```bash +# Update package index +sudo apt-get update + +# Install Docker +sudo apt-get install docker.io + +# Start Docker service +sudo systemctl start docker +sudo systemctl enable docker + +# Add your user to docker group (optional, to run without sudo) +sudo usermod -aG docker $USER +# Log out and back in for this to take effect +``` + +**Windows:** +```bash +# Option 1: Using winget (Windows Package Manager) +winget install Docker.DockerDesktop + +# Option 2: Using Chocolatey +choco install docker-desktop + +# Option 3: Download installer from https://www.docker.com/products/docker-desktop/ +``` + +**Verify installation:** +```bash +docker --version +``` +
```bash # Pull the Docker image (~280MB, no n8n dependencies!) diff --git a/docs/DOCKER_README.md b/docs/DOCKER_README.md index 7da2f8c..12db288 100644 --- a/docs/DOCKER_README.md +++ b/docs/DOCKER_README.md @@ -5,7 +5,7 @@ This guide provides comprehensive instructions for deploying n8n-MCP using Docke ## 🚀 Quick Start ### Prerequisites -- Docker Engine 20.10+ or Docker Desktop +- Docker Engine 20.10+ (Docker Desktop on Windows/macOS, or Docker Engine on Linux) - Docker Compose V2 - (Optional) openssl for generating auth tokens diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 0833557..80074b1 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -27,8 +27,8 @@ docker compose up -d ### Prerequisites -- Docker Desktop or Docker Engine -- Docker Compose (included with Docker Desktop) +- Docker Engine (install via package manager or Docker Desktop) +- Docker Compose V2 (included with modern Docker installations) ### Method 1: Using Pre-built Images diff --git a/docs/README_CLAUDE_SETUP.md b/docs/README_CLAUDE_SETUP.md index 4892c65..bc87aeb 100644 --- a/docs/README_CLAUDE_SETUP.md +++ b/docs/README_CLAUDE_SETUP.md @@ -6,7 +6,7 @@ This guide helps you connect n8n-MCP to Claude Desktop, giving Claude comprehens - Claude Desktop installed - For local installation: Node.js (any version) -- For Docker: Docker Desktop or Docker Engine +- For Docker: Docker installed (see installation instructions in main README) ## 🛠️ Configuration Methods