Package Information
Downloads: 582 weekly / 1,032 monthly
Latest Version: 3.0.0
Documentation
n8n Local Development with Docker
This repository contains configuration to run n8n locally using Docker.
Prerequisites
- Docker
- Docker Compose
Getting Started
- Start n8n and PostgreSQL:
docker-compose up -d
Access n8n in your browser at: http://localhost:5678
To stop the containers:
docker-compose down
Configuration
The setup uses PostgreSQL for data persistence. All n8n data is stored in the postgres_data volume.
The n8n configuration is stored at ~/.n8n on your host machine.
Additional Commands
- View logs:
docker-compose logs -f
- Restart n8n:
docker-compose restart n8n
Custom Nodes
This setup includes support for custom nodes. Custom nodes are stored in the custom-nodes directory.
Working with Custom Nodes
- Make sure you have Node.js installed on your local machine
- To build the custom nodes:
# Make the build script executable
chmod +x build-custom-nodes.sh
# Build the custom nodes
./build-custom-nodes.sh
- After building, restart n8n for the changes to take effect:
docker-compose restart n8n
Creating a New Custom Node
- Create a new directory in the
nodesdirectory - Add your node's TypeScript files and package.json
- Build the nodes using the build script
- Restart n8n
For detailed information about creating custom nodes, refer to the n8n documentation.