Files

czlonkowski 887e98ca0b Add production deployment scripts and quickstart guide

- Add deploy-to-vm.sh script for easy VM deployment
- Add systemd service file template
- Add Nginx configuration with SSL and rate limiting
- Add DEPLOYMENT_QUICKSTART.md for n8ndocumentation.aiservices.pl
- Update REMOTE_DEPLOYMENT.md to reference quickstart

The deployment process is now streamlined:
1. Copy .env.example to .env
2. Configure for production (domain, auth token)
3. Run ./scripts/deploy-to-vm.sh

Tested locally with production configuration - all endpoints
working correctly with authentication.

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

Co-Authored-By: Claude <noreply@anthropic.com>

2025-06-08 08:21:38 +00:00

3.3 KiB

Raw Blame History

Quick Deployment Guide for n8ndocumentation.aiservices.pl

This guide walks through deploying the n8n Documentation MCP Server to a VM.

Prerequisites

Ubuntu 20.04+ VM with root access
Domain pointing to your VM (e.g., n8ndocumentation.aiservices.pl)
Node.js 18+ installed on your local machine
Git installed locally

Step 1: Prepare Local Environment

# Clone the repository
git clone https://github.com/yourusername/n8n-mcp.git
cd n8n-mcp

# Install dependencies
npm install

# Copy and configure environment
cp .env.example .env

Step 2: Configure for Production

Edit .env file:

# Change these values:
NODE_ENV=production
MCP_DOMAIN=n8ndocumentation.aiservices.pl
MCP_CORS=true

# Generate and set auth token:
openssl rand -hex 32
# Copy the output and set:
MCP_AUTH_TOKEN=your-generated-token-here

Step 3: Build and Deploy

# Build the project
npm run build

# Run the deployment script
./scripts/deploy-to-vm.sh

If you don't have SSH key authentication set up, you'll be prompted for the server password.

Step 4: Server Setup (First Time Only)

SSH into your server and run:

# Install Node.js 18+
curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt install -y nodejs

# Install PM2
sudo npm install -g pm2

# Install Nginx
sudo apt install -y nginx

# Copy Nginx configuration
sudo cp /opt/n8n-mcp/scripts/nginx-n8n-mcp.conf /etc/nginx/sites-available/n8n-mcp
sudo ln -s /etc/nginx/sites-available/n8n-mcp /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl reload nginx

# Get SSL certificate
sudo apt install -y certbot python3-certbot-nginx
sudo certbot --nginx -d n8ndocumentation.aiservices.pl

# Setup PM2 startup
pm2 startup
# Follow the instructions it provides

Step 5: Configure Claude Desktop

Add to your Claude Desktop configuration:

{
  "mcpServers": {
    "n8n-nodes-remote": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/client-http",
        "https://n8ndocumentation.aiservices.pl/mcp"
      ],
      "env": {
        "MCP_AUTH_TOKEN": "your-auth-token-from-env-file"
      }
    }
  }
}

Verify Deployment

Test the endpoints:

# Health check
curl https://n8ndocumentation.aiservices.pl/health

# Statistics (public)
curl https://n8ndocumentation.aiservices.pl/stats

# MCP endpoint (requires auth)
curl -X POST https://n8ndocumentation.aiservices.pl/mcp \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your-auth-token" \
  -d '{"jsonrpc": "2.0", "method": "tools/list", "id": 1}'

Management Commands

On the server:

# View logs
pm2 logs n8n-docs-mcp

# Restart service
pm2 restart n8n-docs-mcp

# View status
pm2 status

# Rebuild database
cd /opt/n8n-mcp
npm run db:rebuild:v2
pm2 restart n8n-docs-mcp

Troubleshooting

Service won't start

# Check logs
pm2 logs n8n-docs-mcp --lines 50

# Check if port is in use
sudo lsof -i :3000

SSL issues

# Renew certificate
sudo certbot renew

Database issues

# Rebuild database
cd /opt/n8n-mcp
rm data/nodes-v2.db
npm run db:rebuild:v2

Security Notes

Keep your MCP_AUTH_TOKEN secret
Regularly update dependencies: npm update
Monitor logs for suspicious activity
Use fail2ban to prevent brute force attacks
Keep your VM updated: sudo apt update && sudo apt upgrade

3.3 KiB Raw Blame History