n8n

Overview

n8n is a fair-code licensed workflow automation platform with native AI capabilities. It combines the flexibility of code with the speed of no-code development, allowing technical teams to build powerful automated workflows that connect to 400+ integrations. n8n stands out by offering full control over your data and deployments with self-hosting options, native AI integration with LangChain, and the ability to write custom JavaScript or Python code when needed.

System Requirements

• CPU: 2+ cores (4+ recommended for production)
• RAM: 4GB+ (8GB+ recommended for production)
• GPU: Not required
• Storage: 2GB+ (SSD recommended)
• Operating System: Linux, macOS, Windows, or Docker-compatible platforms
• Node.js: v16.9 or later (if installing manually)

Installation Guide

Prerequisites

• Basic knowledge of command line interfaces
• Docker and Docker Compose (for Docker installation)
• Node.js and npm (for manual installation)
• Understanding of basic automation concepts is helpful

Option 1: Docker Installation (Recommended)

1. Create a docker-compose.yml file:

   version: "3"
   services:
     n8n:
       image: docker.n8n.io/n8nio/n8n
       restart: always
       ports:
         - "5678:5678"
       environment:
         - N8N_PORT=5678
         - N8N_PROTOCOL=http
         - NODE_ENV=production
         - N8N_ENCRYPTION_KEY=your-secret-key-here
         - WEBHOOK_URL=http://localhost:5678/
       volumes:
         - n8n_data:/home/node/.n8n
   
   volumes:
     n8n_data:
   

2. Start the Docker container:

   docker-compose up -d
   

3. Access the n8n editor:

   Open your browser and navigate to http://localhost:5678

Option 2: NPM Installation

1. Install n8n globally using npm:

   npm install n8n -g
   

2. Start n8n:

   n8n start
   

3. Access the n8n editor:

   Open your browser and navigate to http://localhost:5678

Option 3: Quick Start with npx (No Installation)

For a quick test without installing anything:

1. Run n8n using npx:

   npx n8n
   

2. Access the n8n editor:

   Open your browser and navigate to http://localhost:5678

Option 4: Cloud Service

If you prefer not to self-host:

1. Sign up for an n8n Cloud account at n8n.io
2. Follow the onboarding process to create your first workflow

Note: For detailed installation instructions specific to your operating system and environment, please refer to the official documentation on the project’s GitHub repository.

Practical Exercise: Building an AI-Powered Workflow with n8n

Let’s create a simple AI-powered workflow that monitors a folder for new documents, extracts text content, summarizes it using an LLM, and sends notifications with the summary.

Step 1: Setting Up Your First Workflow

1. Open n8n in your browser (http://localhost:5678 if self-hosted)
2. Click “Create workflow” to start a new workflow
3. Name it “Document Summarization Workflow”

Step 2: Creating the Trigger Node

1. Click the “+” button to add a node
2. Search for and select “Watch Folder” (or use “Schedule Trigger” for testing)
3. Configure the node:
   • Folder Path: Select your documents folder
   • Check “Include Subdirectories” if needed
   • File Types: pdf,docx,txt (for document files)

Step 3: Setting Up the LangChain Integration

1. Click the “+” button after the trigger node

2. Search for “LangChain” and select “LangChain Prompt Template”

3. Configure the node:

   • LLM Provider: OpenAI (or any other supported provider)

   • API Key: Enter your API key

   • Model: Select a model (e.g., gpt-3.5-turbo)

   • Prompt: Enter the following prompt:

     You are a helpful assistant that summarizes documents.
     Please create a concise summary (maximum 3 paragraphs) of the following document:
     
     {{$json["fileContent"]}}
     

   • Output Field Name: summary

Step 4: Reading File Content

Before the LangChain node, we need to add a node to read the file content:

1. Add a “Read Binary File” node between the Watch Folder and LangChain nodes
2. Configure it to read the file path from the previous node
3. If you’re processing PDFs or DOCXs, you may need to add a “Text Extraction” node after this

Step 5: Sending a Notification

1. Click the “+” button after the LangChain node
2. Choose a notification method:
   • Email: Use the “Send Email” node
   • Slack: Use the “Slack” node
   • Telegram: Use the “Telegram” node
3. Configure with your credentials and the following settings:
   • Subject/Title: New Document Summary: {{$json["fileName"]}}
   • Body/Message: Here's a summary of the document: \n\n{{$json["summary"]}}

Step 6: Adding Error Handling

1. Click on any node and select “Add Error Workflow” from the menu
2. Add a “Send Email” or other notification node to the error workflow
3. Configure it to send an alert if the workflow fails

Step 7: Activate and Test

1. Click “Save” to save your workflow
2. Click “Active” toggle to activate it
3. Drop a test document into your monitored folder to test the workflow

Step 8: Extending the Workflow

Once you have the basic workflow working, you can extend it with:

• Document Classification: Add another LangChain node to classify the document by topic
• Data Extraction: Extract structured data like dates, names, or amounts
• Webhook Integration: Create an API endpoint to trigger the workflow
• Database Storage: Store the document summaries in a database for later retrieval

Resources

Official Documentation

n8n provides comprehensive documentation for all skill levels:

n8n Documentation API Reference

Key Features

• 400+ Integrations: Connect to hundreds of services through pre-built nodes
• AI-Native Platform: Built-in support for AI tools and LangChain integration
• Code Flexibility: Write JavaScript/Python within workflows when needed
• Self-Hosting: Deploy on your own infrastructure with fair-code license
• Visual Workflow Builder: Intuitive drag-and-drop interface
• Error Handling: Robust error handling capabilities with customizable flows
• Webhooks: Support for incoming and outgoing webhook triggers
• Queuing System: Efficient queue-based execution for reliable processing
• Version Control: Built-in version control for workflows
• Credentials Management: Secure credential storage for all integrations

Community and Support

Connect with other n8n users and get help:

Community Forum GitHub Repository Discord Community

Tutorials and Templates

Get started quickly with pre-built templates and tutorials:

n8n Workflow Templates AI Workflow Templates n8n Blog