Find out how to Self-Host n8n on Docker in 5 Easy Steps

Picture by Writer

# Introduction

 
Automation has develop into the energy of well-structured enterprise operations. Corporations worldwide are automating repetitive duties, combining a number of purposes, and constructing clever workflows to avoid wasting time and reduce guide errors. n8n is a robust, open-source workflow automation device that is revolutionizing how groups method automation, and it is fully free to host your self.

In contrast to costly software program as a service (SaaS) options like Zapier, n8n provides you full management over your automation infrastructure. If you mix n8n with Docker, you get a containerized, scalable, and transportable automation platform that may be deployed wherever — out of your native machine to manufacturing servers on cloud suppliers akin to Amazon Net Providers (AWS) and Microsoft Azure.

This tutorial will information you thru the entire technique of self-hosting n8n on Docker in simply 5 easy steps, with detailed explanations and code samples, no matter your technical background.

# Understanding n8n

 
n8n (pronounced “n-eight-n”) is a fair-code licensed workflow automation platform that connects nearly any utility with an API to another. In accordance with the official n8n documentation, n8n helps you join apps with little to no code, making it accessible to each technical and non-technical customers.

Options of n8n:

• Connecting with standard companies like Slack, Google Sheets, Airtable, HubSpot, Salesforce, GitHub, and 1000’s extra
• Including Python code straight in workflows for advanced logic
• Utilizing a drag-and-drop interface that makes constructing automations intuitive
• Constructed-in LangChain assist for synthetic intelligence (AI) powered workflows and clever automation
• Selecting to host by yourself servers or use n8n Cloud
• Accessing a free group version with highly effective open-source capabilities

With n8n, you possibly can automate duties like:

• Syncing knowledge between a number of instruments robotically
• Processing incoming webhooks from exterior companies
• Sending notifications to Slack, e-mail, and different platforms
• Enriching buyer knowledge from exterior APIs
• Creating clever workflows utilizing AI brokers
• Operating scheduled duties (cron jobs) on any frequency you want

# Understanding Docker

 
Docker is a containerization platform that packages your whole utility, together with all dependencies, libraries, and configuration, into a light-weight, transportable container. Consider a Docker container as a self-contained field that comprises every thing n8n must run, guaranteeing consistency throughout totally different machines and environments.

Why Docker is ideal for n8n:
Docker runs the identical container in your laptop computer, a devoted server, or cloud infrastructure. n8n runs independently with out affecting different purposes in your server. You’ll be able to improve n8n with a single command with out worrying about breaking dependencies. You may also run a number of n8n situations or employee containers for dealing with advanced workflows, guaranteeing everybody in your staff runs the very same setting.

# Step 1: Putting in Docker and Docker Compose

 
This primary step is vital. Docker have to be put in in your machine earlier than you possibly can run n8n in a container. Earlier than set up, it is vital to know the distinction between Docker and Docker Compose. Docker is the core containerization engine that runs containers. Docker Compose is a device that orchestrates a number of containers and simplifies configuration by YAML recordsdata.

Docker Desktop is on the market for Home windows, macOS, and Linux and contains each Docker and Docker Compose, making set up simple.

// Downloading Docker Desktop

→ For Home windows 10/11

• Go to the Docker official web site
• Click on “Obtain for Home windows”
• Select your processor sort: Intel/AMD processors or Apple Silicon (M1/M2/M3)

→ Home windows Set up

• Double-click the Docker Desktop Installer.exe file you downloaded
• A immediate will seem asking for permission; click on “Sure”
• Click on “Subsequent” and comply with the prompts
• This course of could take a number of minutes
• Click on “End”
• Restart your pc to use the modifications

After a restart, you must see the Docker whale icon in your system tray.

Notice for Home windows: Docker Desktop requires both Hyper-V or Home windows Subsystem for Linux 2 (WSL2) to be enabled. The installer will robotically allow these options, however your pc should assist virtualization. If in case you have an older Home windows 10 Residence version, you might must improve to Home windows 10 Professional for Hyper-V assist.

// Verifying Docker Set up

No matter your working system, confirm that Docker is put in accurately by opening a terminal (or Command Immediate on Home windows) and working:

Anticipated Output:

Docker model 28.5.2, construct ecc6942

Additionally, confirm Docker Compose:

Anticipated Output:

Docker Compose model v2.40.3-desktop.1

In case you see model numbers, Docker is put in accurately. In case you see “command not discovered,” Docker is probably not in your system PATH. Restart your terminal or pc and check out once more.

# Step 2: Getting ready Your n8n Listing Construction

 
Now that Docker is prepared, we have to create a house for n8n in your pc. This step entails creating folders the place n8n will retailer its knowledge, configuration recordsdata, and workflow data.

Docker containers run in remoted environments. To entry recordsdata in your host machine and persist knowledge so your workflows do not disappear when the container restarts, we have to create quantity mount directories in your pc that the container can entry. Consider it like making a shared folder between your pc and the Docker container.

// Creating the n8n Venture Listing

Open your terminal or command immediate and run these instructions:

Navigate to a handy location; we’ll use the consumer’s house listing:

Create an n8n mission listing:

Navigate into the listing:

Confirm you are in the appropriate place:

This could present your n8n-docker path. It’s best to see a folder referred to as n8n-docker in your house listing. This can be your mission root the place all n8n configuration and knowledge dwell.

// Creating Knowledge Storage Directories

Contained in the n8n-docker folder, we have to create subdirectories for knowledge persistence:

Create the information listing construction:

mkdir knowledge
mkdir dataworkflows

Confirm that directories had been created:

The listing construction serves the next functions:

• knowledge/ is the primary storage for n8n’s database and configuration
• knowledge/workflows/ is the place your workflow recordsdata are saved
• knowledge/credentials/ is the place encrypted credentials for integrations are saved

You could have now created the primary n8n-docker mission listing and arrange subdirectories for knowledge persistence with correct permissions for knowledge entry.

# Step 3: Creating Your Docker Compose Configuration File

 
Docker Compose makes use of YAML, which is a human-readable knowledge format. YAML makes use of indentation (areas) to point out relationships, so indentation have to be actual. Consider it like Python code the place indentation ranges outline the construction.

// Creating the docker-compose.yml File

In your n8n-docker listing, comply with the steps under to create a brand new file referred to as docker-compose.yml.

Create an empty file:

New-Merchandise -Path "docker-compose.yml" -ItemType File

Open it with Notepad (or your favourite textual content editor):

notepad docker-compose.yml

Alternatively, for Linux customers, create and open the file with:

In case you’re utilizing nano, paste the content material under, then press Ctrl+X, then Y, then Enter to avoid wasting.

// Including the Full Docker Compose Configuration

Paste this content material into your docker-compose.yml file:

companies:
  n8n:
    picture: n8nio/n8n:newest
    container_name: n8n
    restart: at all times
    ports:
      - "5678:5678"
    setting:
      - N8N_HOST=0.0.0.0
      - N8N_PORT=5678
      - NODE_ENV=manufacturing
      - N8N_BASIC_AUTH_ACTIVE=true
      - N8N_BASIC_AUTH_USER=admin
      - N8N_BASIC_AUTH_PASSWORD=changeme123
      - N8N_ENCRYPTION_KEY=your-secure-encryption-key
    volumes:
      - ./knowledge:/house/node/.n8n
    networks:
      - n8n-network
    healthcheck:
      take a look at: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:5678/healthz"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 40s

networks:
  n8n-network:
    driver: bridge

Let’s break down what every part of this configuration does:

This declares that we’re defining a service referred to as “n8n”. That is the identify used to reference this container.

picture: n8nio/n8n:newest
container_name: n8n

The picture instruction makes use of the official n8n picture from Docker Hub. The :newest tag downloads the latest model obtainable, whereas container_name names our working container “n8n”.

Restart Coverage

This tells Docker to robotically restart the n8n container if it crashes or if the server reboots.

Port Mapping

That is essential for accessing n8n out of your browser:

• Left quantity (5678): The port in your host pc
• Proper quantity (5678): The port contained in the container

This implies once you entry http://localhost:5678 in your pc, it connects to port 5678 contained in the n8n container.

Surroundings Variables

setting:
  - N8N_HOST=0.0.0.0
  - N8N_PORT=5678
  - NODE_ENV=manufacturing
  - N8N_BASIC_AUTH_ACTIVE=true
  - N8N_BASIC_AUTH_USER=admin
  - N8N_BASIC_AUTH_PASSWORD=changeme123
  - N8N_ENCRYPTION_KEY=your-secure-encryption-key

Surroundings variables configure n8n’s conduct:

• N8N_HOST: Which community interface n8n listens on. 0.0.0.0 means “hear on all obtainable interfaces.”
• N8N_PORT: The port n8n runs on contained in the container.
• NODE_ENV: Set to manufacturing for safety hardening and efficiency optimization.
• N8N_BASIC_AUTH_ACTIVE: Allows primary username/password authentication.
• N8N_BASIC_AUTH_USER: Username for accessing the n8n interface.
• N8N_BASIC_AUTH_PASSWORD: Password for accessing the n8n interface (Change this!).
• N8N_ENCRYPTION_KEY: Secret key for encrypting credentials and delicate knowledge.

Essential safety word: Change N8N_BASIC_AUTH_PASSWORD and N8N_ENCRYPTION_KEY to robust values! These are credentials that shield your automation workflows and integrations.

Instance safe values:

N8N_BASIC_AUTH_PASSWORD=Pr0t3ctY0urN8n!D0sH3y7k@Safe
N8N_ENCRYPTION_KEY=aB3xC9dE2fG4hI7jK5lM8nO1pQ4rS6tU9vW2xY5z$#@!%&

Quantity Mounting:

volumes:
  - ./knowledge:/house/node/.n8n

This creates a bridge between your pc and the container. The left facet (./knowledge) is the listing in your host machine, and the appropriate facet (/house/node/.n8n) is the listing contained in the container the place n8n shops all its knowledge.

Why is that this vital?
If the container is deleted or up to date, your workflows and knowledge persist within the ./knowledge folder in your pc.

This locations the container on a Docker community, which is beneficial if you happen to add extra companies later, like a devoted database.

healthcheck:
  take a look at: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:5678/healthz"]
  interval: 30s
  timeout: 10s
  retries: 3
  start_period: 40s

This tells Docker to periodically test if n8n remains to be working. It prevents Docker from pondering n8n has crashed throughout a traditional startup.

# Step 4: Creating an Surroundings File

 
Whereas the Docker Compose file above works, utilizing a separate setting file is a finest follow for managing delicate data. In the identical n8n-docker listing, create a file named .env.

New-Merchandise -Path ".env" -ItemType File

Open it with Notepad or your built-in improvement setting (IDE):

// Including Your Configuration Variables

Paste this content material into your .env file:

# n8n Configuration
N8N_HOST=0.0.0.0
N8N_PORT=5678
NODE_ENV=manufacturing

# Authentication
N8N_BASIC_AUTH_ACTIVE=true
N8N_BASIC_AUTH_USER=admin
N8N_BASIC_AUTH_PASSWORD=your_secure_password_here_change_this
N8N_ENCRYPTION_KEY=your_encryption_key_here_change_this

// Updating Docker Compose to Use the .env File

Modify your docker-compose.yml to reference the .env file. Exchange the setting: part with:

// Understanding the .env File Benefits

Utilizing a .env file gives a number of advantages: delicate knowledge will not be saved straight in orchestration recordsdata, and you’ll change configurations with out modifying the primary docker-compose.yml.

In case you’re utilizing Git model management, by no means commit your .env file to the repository. Create a .gitignore file in your mission:

New-Merchandise -Path ".gitignore" -ItemType File

Add .env and knowledge/ to this file to make sure delicate knowledge and native database recordsdata are ignored by Git.

# Step 5: Launching n8n and Accessing It

 
Open your terminal, navigate to your n8n-docker listing, and run the next command to start out n8n within the background:

The -d command runs in “indifferent” mode. If that is your first time, Docker will obtain the n8n picture, which can take a few minutes.

// Monitoring n8n Startup

Examine the logs to see if n8n began efficiently:

docker compose logs -f n8n

// Accessing n8n in Your Browser

Open your net browser and navigate to http://localhost:5678. You will note a setup display; enter the credentials you set in your .env file. After logging in, you will see the n8n workflow editor.

Picture by Writer

The n8n interface comprises all obtainable nodes (Slack, Gmail, HTTP requests, logic nodes, and many others.), a workflow space for constructing automations, and configuration choices for chosen nodes.

To confirm your n8n container is wholesome, run:

# Managing Your n8n Container

 
Now that n8n is working, listed below are the vital instructions you will use recurrently:

• Viewing Dwell Logs: See what’s taking place contained in the container in real-time.

  docker compose logs -f n8n

   
  Press Ctrl+C to exit.

• Stopping n8n: Gracefully cease the container whereas preserving your knowledge.

   

• Updating n8n: Pull the latest n8n picture and restart.

  docker compose pull n8n
  docker compose up -d

   

# Constructing Your First Workflow

 
Let’s create a easy workflow that listens for incoming webhook requests, extracts knowledge, and sends a message to Slack.

Within the n8n interface:

• Click on the “+” button to create a brand new workflow
• Click on on “New Workflow”

// Including a Webhook Node

• Within the left sidebar, seek for “Webhook”
• Drag the Webhook node onto your canvas
• Within the node settings, choose POST for the strategy and enter send-slack-message as the trail
• Click on “Save”

// Including a Slack Node

• Seek for “Slack” and drag the node onto your canvas
• Join the Webhook node to the Slack node
• Configure the Slack node along with your bot token and goal channel

// Activating the Workflow

• Click on “Execute” to check the connection
• If profitable, toggle the workflow to “Energetic”
• Copy the webhook URL to make use of as your set off

# Conclusion

 
You now have a completely useful, self-hosted n8n automation platform working in Docker. You could have discovered easy methods to set up Docker and Docker Compose, create a correct listing construction for knowledge persistence, and configure n8n. You could have additionally arrange authentication and safety, accessed the net interface, and created your first workflow.

The great thing about this setup is its portability and scalability. With just some instructions, you possibly can transfer n8n to a unique server or improve to a more moderen model. From right here, your automation journey has countless potentialities.
 
 

Shittu Olumide is a software program engineer and technical author captivated with leveraging cutting-edge applied sciences to craft compelling narratives, with a eager eye for element and a knack for simplifying advanced ideas. You may also discover Shittu on Twitter.