Tun8n - N8N + Ngrok Docker Starter

A complete CLI tool to create and manage n8n (workflow automation) with Docker and expose it to the internet using Ngrok with custom domain support.

🚀 Features

• ✅ Easy CLI Setup - Create new projects with one command
• ✅ n8n latest version with Docker Compose
• ✅ Ngrok integration with custom domain support
• ✅ Secure environment variables handling
• ✅ Health checks and auto-restart
• ✅ Persistent data storage
• ✅ Multi-platform support (macOS, Windows, Linux)
• ✅ Complete CLI interface for easy management
• ✅ Automatic script management with proper permissions
• ✅ Environment validation and error checking
• ✅ Fallback mechanisms for robust operation

📦 Installation

Method 1: Install via npm (Recommended)

# Install globally or from the latest GitHub version
npm install -g tun8n@latest
npm install github:ahmadrizal1st/tun8n

# Verify installation
tun8n --version
tun8n -v

Method 2: Manual Setup (if preferred)

# Clone the repository
git clone https://github.com/ahmadrizal1st/tun8n.git
cd tun8n

# Install dependencies(optional)
npm install

# Link for local development
npm link

🚀 Quick Start

1. Create a New Project

# Create new n8n project
tun8n create my-automation-project

# Navigate to project
cd my-automation-project

2. Initialize Environment

# Setup environment configuration
tun8n init

# Edit .env file with your settings
nano .env  # or use your favorite editor

3. Configure Environment

Edit the .env file:

# Ngrok Configuration
NGROK_AUTHTOKEN=your_ngrok_auth_token_here
NGROK_DOMAIN=your_custom_domain.ngrok-free.app  # Optional for paid plans

# n8n Configuration
N8N_PORT=5678
N8N_PROTOCOL=http
WEBHOOK_URL=your_ngrok_url
TZ=Asia/Jakarta

# Optional: Basic Auth (recommended)
# N8N_BASIC_AUTH_USER=admin
# N8N_BASIC_AUTH_PASSWORD=secure_password_here

⚠️ IMPORTANT: Get your Ngrok auth token from Ngrok Dashboard

4. Start Services

# Start n8n with Ngrok tunnel
tun8n start

🛠️ CLI Commands

Project Management

# Create new project
tun8n create <project-name>

# Initialize environment (create .env from template)
tun8n init

# Update to latest version
tun8n update

Service Control

# Start all services
tun8n start

# Check service status
tun8n status

# View debug information and logs
tun8n debug

# Stop all services
tun8n stop

Information

# Show version
tun8n --version
tun8n -v

# Show help
tun8n --help

📋 Prerequisites

Required Software

• Docker - Install Guide
• Docker Compose - Usually included with Docker Desktop
• Node.js (v14+) - Only required for CLI tool

Ngrok Setup

1. Create free account at ngrok.com
2. Get your auth token from dashboard
3. (Optional) Reserve custom domain for paid plans

🔧 Project Structure

my-automation-project/
├── docker-compose.yml    # Docker compose configuration
├── .env                  # Environment variables (created by tun8n init)
├── .env.example          # Environment template and dependencies
├── .gitignore           # Git ignore rules
├── package.json          # Project metadata
└── README.md            # Project documentation

🌐 Access Points

After starting services:

• Local n8n Access: http://localhost:5678
• Remote Access: Your Ngrok URL (shown in logs)
• Ngrok Dashboard: http://localhost:4040

📊 Monitoring

Check Service Status

tun8n status

# Or manually
docker-compose ps
docker stats

View Logs

tun8n debug

# Or follow specific logs
docker-compose logs -f n8n-app
docker-compose logs -f n8n-ngrok

🛑 Stopping Services

Graceful Shutdown

# Using CLI
tun8n stop

# Using Docker directly
docker-compose down

Complete Cleanup

# Remove everything (including volumes)
docker-compose down -v

# Clean Docker system
docker system prune -f

🔍 Troubleshooting

Common Issues

1. Port 5678 already in use

   # Change N8N_PORT in .env file
   N8N_PORT=5679

2. Ngrok authentication errors

   • Verify NGROK_AUTHTOKEN in .env file
   • Check token at Ngrok Dashboard

3. Docker permission issues (Linux)

   sudo usermod -aG docker $USER
   newgrp docker

4. Script permission issues

   # Grant execute permissions to scripts
   chmod +x bin/scripts/*.js

Debug Commands

# Check Ngrok tunnel status
docker exec n8n-ngrok curl -s http://localhost:4040/api/tunnels | jq

# Test n8n health
curl http://localhost:5678/healthz

# View container logs
docker logs n8n-app --tail 50

🔒 Security Notes

1. Never commit .env file to version control
2. Use strong passwords for basic authentication
3. Regularly rotate Ngrok authentication tokens
4. Monitor access logs frequently
5. Consider VPN for production use

📞 Support

Useful Links

• n8n Documentation
• Docker Documentation
• Ngrok Documentation
• Docker Installation Guide

Getting Help

1. Check logs: tun8n debug
2. Verify Ngrok token is correct
3. Ensure Docker is running
4. Check port availability
5. Validate environment variables: tun8n init and check .env file

🎯 Example Usage

# Complete workflow example
tun8n create my-n8n-project
cd my-n8n-project
tun8n init

# Edit .env with your Ngrok token and settings
nano .env

tun8n start
tun8n status

# When done working
tun8n stop

📝 License

MIT License - feel free to use this project for your automation needs!

---

Happy Automating! 🚀

For issues and contributions, please check the project repository.

🔄 Changelog

Version 1.3.28

• Enhanced CLI with better error handling and fallback mechanisms
• Automatic script permissions management
• Environment validation with helpful warnings
• Improved project structure with dedicated scripts directory
• Better Docker compatibility checks
• Template-based .env initialization
• Comprehensive .gitignore for security

Key Improvements

• ✅ Automatic script permission setting (chmod 755)
• ✅ Environment variable validation with warnings
• ✅ Fallback to direct docker commands if scripts fail
• ✅ Better error messages and user guidance
• ✅ Template-based project creation with proper structure
• ✅ Enhanced security with comprehensive .gitignore

---

Note: This tool automatically handles script permissions and provides fallback mechanisms for robust operation across different environments.