docs: add Railway one-click deployment option with setup guide and images

This commit is contained in:
czlonkowski
2025-07-17 01:34:27 +02:00
parent 637e7f978b
commit cd3233cabe
4 changed files with 39 additions and 2 deletions

View File

@@ -6,6 +6,7 @@
[![npm version](https://img.shields.io/npm/v/n8n-mcp.svg)](https://www.npmjs.com/package/n8n-mcp) [![npm version](https://img.shields.io/npm/v/n8n-mcp.svg)](https://www.npmjs.com/package/n8n-mcp)
[![n8n version](https://img.shields.io/badge/n8n-v1.101.1-orange.svg)](https://github.com/n8n-io/n8n) [![n8n version](https://img.shields.io/badge/n8n-v1.101.1-orange.svg)](https://github.com/n8n-io/n8n)
[![Docker](https://img.shields.io/badge/docker-ghcr.io%2Fczlonkowski%2Fn8n--mcp-green.svg)](https://github.com/czlonkowski/n8n-mcp/pkgs/container/n8n-mcp) [![Docker](https://img.shields.io/badge/docker-ghcr.io%2Fczlonkowski%2Fn8n--mcp-green.svg)](https://github.com/czlonkowski/n8n-mcp/pkgs/container/n8n-mcp)
[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/VY6UOG?referralCode=n8n-mcp)
A Model Context Protocol (MCP) server that provides AI assistants with comprehensive access to n8n node documentation, properties, and operations. Deploy in minutes to give Claude and other AI assistants deep knowledge about n8n's 525+ workflow automation nodes. A Model Context Protocol (MCP) server that provides AI assistants with comprehensive access to n8n node documentation, properties, and operations. Deploy in minutes to give Claude and other AI assistants deep knowledge about n8n's 525+ workflow automation nodes.
@@ -285,6 +286,38 @@ Add to Claude Desktop config:
> 💡 Tip: If youre running n8n locally on the same machine (e.g., via Docker), use http://host.docker.internal:5678 as the N8N_API_URL. > 💡 Tip: If youre running n8n locally on the same machine (e.g., via Docker), use http://host.docker.internal:5678 as the N8N_API_URL.
### Option 4: Railway Cloud Deployment (One-Click Deploy) ☁️
**Prerequisites:** Railway account (free tier available)
Deploy n8n-MCP to Railway's cloud platform with zero configuration:
[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/VY6UOG?referralCode=n8n-mcp)
**Benefits:**
- ☁️ **Instant cloud hosting** - No server setup required
- 🔒 **Secure by default** - HTTPS included, auth token warnings
- 🌐 **Global access** - Connect from any Claude Desktop
-**Auto-scaling** - Railway handles the infrastructure
- 📊 **Built-in monitoring** - Logs and metrics included
**Quick Setup:**
1. Click the "Deploy on Railway" button above
2. Sign in to Railway (or create a free account)
3. Configure your deployment (project name, region)
4. Click "Deploy" and wait ~2-3 minutes
5. Copy your deployment URL and auth token
6. Add to Claude Desktop config using the HTTPS URL
> 📚 **For detailed setup instructions, troubleshooting, and configuration examples, see our [Railway Deployment Guide](./docs/RAILWAY_DEPLOYMENT.md)**
**Configuration file locations:**
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
- **Linux**: `~/.config/Claude/claude_desktop_config.json`
**Restart Claude Desktop after updating configuration** - That's it! 🎉
## 💻 Connect your IDE ## 💻 Connect your IDE
n8n-MCP works with multiple AI-powered IDEs and tools. Choose your preferred development environment: n8n-MCP works with multiple AI-powered IDEs and tools. Choose your preferred development environment:

View File

@@ -6,7 +6,7 @@ Deploy n8n-MCP to Railway's cloud platform with zero configuration and connect i
Deploy n8n-MCP with one click: Deploy n8n-MCP with one click:
[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/Ep_b-Y?referralCode=n8n-mcp) [![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/VY6UOG?referralCode=n8n-mcp)
## 📋 Overview ## 📋 Overview
@@ -33,6 +33,8 @@ Railway deployment provides:
**IMPORTANT**: The deployment includes a default AUTH_TOKEN for instant functionality, but you MUST change it: **IMPORTANT**: The deployment includes a default AUTH_TOKEN for instant functionality, but you MUST change it:
![Railway Dashboard - Variables Tab](./img/railway-variables.png)
1. **Go to your Railway dashboard** 1. **Go to your Railway dashboard**
2. **Click on your n8n-mcp service** 2. **Click on your n8n-mcp service**
3. **Navigate to "Variables" tab** 3. **Navigate to "Variables" tab**
@@ -48,13 +50,15 @@ Railway deployment provides:
### 3. Get Your Service URL ### 3. Get Your Service URL
![Railway Dashboard - Domain Settings](./img/railway-domain.png)
1. In Railway dashboard, click on your service 1. In Railway dashboard, click on your service
2. Go to **"Settings"** tab 2. Go to **"Settings"** tab
3. Under **"Domains"**, you'll see your URL: 3. Under **"Domains"**, you'll see your URL:
``` ```
https://your-app-name.up.railway.app https://your-app-name.up.railway.app
``` ```
4. Copy this URL for Claude Desktop configuration 4. Copy this URL for Claude Desktop configuration and add /mcp at the end
### 4. Connect Claude Desktop ### 4. Connect Claude Desktop

BIN
docs/img/Railway_api.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 151 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 144 KiB