n8n Docker Compose Example: A Production Ready Configuration

Setting up n8n with Docker Compose is an excellent way to manage your workflows in a scalable, efficient manner. For anyone looking to create a robust and production-ready setup, utilizing Docker Compose offers a seamless deployment solution. This guide will walk you through the process step by step, making it accessible even if you're new to Docker or workflow automation.

Why Use Docker Compose for n8n?

Docker Compose allows you to define and manage multi-container Docker applications. By using a YAML file, you can define all the services your application consists of. For n8n, this means you can easily manage the service along with its dependencies such as databases or reverse proxies. Docker Compose enhances scalability and ensures that your application can be shifted effortlessly between different environments.

Benefits of Docker Compose

• Simplicity: Define and manage all services with a single YAML file.
• Scalability: Easily scale up your n8n instance to meet demand.
• Portability: Move workloads across different cloud providers or environments.

Setting Up n8n with Docker Compose

Prerequisites

Before you start, ensure you have the following installed:

• Docker
• Docker Compose

Step-by-Step Guide

Let's break down the process into simpler steps:

Step 1: Create a Docker Compose File

Start by creating a directory for your n8n setup and navigate into it.

mkdir n8n-docker-setup
cd n8n-docker-setup

Create a file named docker-compose.yml and open it with your preferred text editor.

version: '3.1'

services:
  n8n:
    image: n8nio/n8n
    ports:
      - "5678:5678"
    environment:
      - DB_TYPE=postgresdb
      - DB_POSTGRESDB_HOST=postgres
      - DB_POSTGRESDB_PORT=5432
      - DB_POSTGRESDB_DATABASE=n8n
      - DB_POSTGRESDB_USER=n8n
      - DB_POSTGRESDB_PASSWORD=n8n
      - N8N_BASIC_AUTH_ACTIVE=true
      - N8N_BASIC_AUTH_USER=user
      - N8N_BASIC_AUTH_PASSWORD=password
    volumes:
      - ~/.n8n:/home/node/.n8n

  postgres:
    image: postgres:13
    environment:
      - POSTGRES_USER=n8n
      - POSTGRES_PASSWORD=n8n
      - POSTGRES_DB=n8n
    volumes:
      - ~/.n8n/database:/var/lib/postgresql/data

Step 2: Configure Environment Variables

Set up your environment variables to define database credentials and basic authentication for added security. You might want to store these in a .env file for sensitive data:

DB_TYPE=postgresdb
DB_POSTGRESDB_HOST=localhost
DB_POSTGRESDB_PORT=5432
DB_POSTGRESDB_DATABASE=n8n
DB_POSTGRESDB_USER=n8n
DB_POSTGRESDB_PASSWORD=n8npassword
N8N_BASIC_AUTH_ACTIVE=true
N8N_BASIC_AUTH_USER=n8nuser
N8N_BASIC_AUTH_PASSWORD=n8npassword

Step 3: Start Docker Compose

Navigate to your Docker Compose file's directory and run the following command to start both the n8n and Postgres containers:

docker-compose up -d

This command will download the necessary Docker images and start your containers.

Monitoring and Managing n8n

Docker Compose makes managing your n8n instance easy. You can start, stop, and scale your containers with simple commands like docker-compose start, docker-compose stop, and docker-compose scale n8n=3.

Troubleshooting Common Issues

With Docker Compose, you may encounter issues that could interrupt your workflows. Here are a few common problems and how to fix them:

Issue: Database Connection Error

This might occur if the Postgres service is not up before n8n tries to connect. Ensure your database credentials are correct and that the database service is fully operational. Using a dependency management tool like depends_on in Docker Compose can ensure the required containers start in the correct order.

Issue: Port Already in Use

If the port 5678 is already occupied, change it in your Docker Compose file.

ports:
  - "5679:5678"

Scaling Your n8n Setup

When traffic increases, you might need to scale your services. Use the docker-compose scale command to add more instances of n8n, which allows it to handle additional workload without downtime.

Integrating More Services

You can expand your n8n setup by extending the Docker Compose file to include additional services. For example, you might want to add Redis for task queueing or a reverse proxy like Nginx for SSL termination and routing.

For those interested in integrating other tools or improving n8n's capabilities, check out how n8n integrates with Google Sheets, Google Calendar, Google Drive and more or learn about automating social media posting using n8n.

FAQ

What are the basic authentication credentials in Docker Compose?

In the docker-compose.yml file, the basic authentication credentials are defined under the environment variables N8N_BASIC_AUTH_USER and N8N_BASIC_AUTH_PASSWORD.

How do I backup my n8n workflows with Docker?

You can easily backup workflows by mounting volumes where n8n data is stored, such as in the path ~/.n8n as mentioned in the Docker Compose example.

Can I use a different database with n8n?

Yes, n8n supports various databases, including MySQL and SQLite, by configuring the DB_TYPE and related environment variables appropriately.

Is it possible to integrate third-party services with this setup?

Absolutely. n8n is designed for integration, and you can extend it to work with third-party services, making it versatile for varied automation needs.

Can I run n8n locally without Docker?

Yes, if you prefer a non-Docker environment, there are guides like How to Run n8n Locally Without a Server (Mac, Windows, Linux) to help you out.

By setting up n8n with a production-ready Docker Compose configuration, you're equipping yourself with a scalable and efficient workflow automation solution. Experiment with different configurations and heavy integration to maximize the potential of n8n.