Skip to content

clawstudios/n8n

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 

Repository files navigation

claw-text-blue

N8N Local Environment Boilerplate

This repository provides a quick setup for running n8n locally with MongoDB integration using Docker Compose.

🚀 Features

  • N8N workflow automation platform
  • MongoDB database with authentication
  • Persistent data storage
  • Docker-based setup for easy deployment
  • SSL/TLS support with Traefik and Let's Encrypt

📋 Prerequisites

  • Docker
  • Docker Compose
  • Git (optional)
  • Domain name pointing to your server (for SSL)

🛠️ Installation

  1. Clone this repository or copy the docker-compose.yml file:
git clone https://github.com/clawstudios/n8n.git
  1. Ensure acme.json is created and has the right permissions for Traefik:
chmod 600 traefik-data/acme.json
  1. Run the Docker Compose setup:
docker compose up -d
  1. Access N8N at https://your-domain.com (or http://localhost:5678 for local development).

🔧 Configuration

MongoDB

  • Host: localhost
  • Port: 27017
  • Root Username: root
  • Root Password: root
  • Default Database: n8n

N8N

  • URL: https://your-domain.com or http://localhost:5678 (local development)
  • Default credentials will be created on first launch

Traefik

  • Automatically handles SSL certificates via Let's Encrypt
  • Redirects HTTP to HTTPS
  • Manages routing to the n8n service

📦 Volume Information

The setup uses three Docker volumes:

  • mongo_data: Stores MongoDB data
  • n8n_data: Stores n8n configurations and workflows
  • Local directory traefik-data: Stores Traefik configuration and SSL certificates

🔒 Security Notes

  • The MongoDB credentials in this setup are for development purposes only
  • Change the default credentials before using in a production environment
  • Consider implementing additional security measures for production use
  • The chmod 600 traefik-data/acme.json step is critical for security and proper functioning of SSL

🤝 Contributing

Feel free to submit issues, fork the repository, and create pull requests for any improvements.

📝 License

[Your chosen license]

⚠️ Disclaimer

This is a development setup and should be properly secured before using in a production environment.

🔗 Useful Links

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published