zenkiet/traefik-tunnel-expose repository overview

graph TB
    A[🌐 Internet] --> B[☁️ Cloudflare CDN]
    B --> C[🔒 Cloudflare Tunnel]
    C --> D[🚀 Traefik Proxy]
    D --> E[📱 Your Services]

    F[🤖 DNS API] --> G[📝 Auto DNS Records]
    H[🔐 Let's Encrypt] --> I[📜 SSL Certificates]

git clone https://github.com/zenkiet/traefik-tunnel-expose.git
cd traefik-tunnel-expose

# Copy example environment file
cp env.example .env

# Edit configuration
nano .env  # or your preferred editor

# ===== REQUIRED =====
# Cloudflare Configuration
CF_API_TOKEN=your_cloudflare_api_token_here
CF_ZONE_ID=your_cloudflare_zone_id_here
CF_TUNNEL_ID=your_cloudflare_tunnel_id_here
CF_ACCOUNT_ID=your_cloudflare_account_id
[email protected]

# Domain Configuration
BASE_DOMAIN=yourdomain.com
HOST=127.0.0.1

# SSL Configuration (use staging for testing)
ACME_CA_SERVER=https://acme-staging-v02.api.letsencrypt.org/directory

# 🚀 Start services
make dev # or make prod (for production)

# 📊 Check status
make status

# 📝 View logs
make logs

# 🚀 HTTP Router and Service Configuration
http:
  routers:
    myapp:
      rule: "Host(`myapp.yourdomain.com`)"
      service: "myapp-service"
      entrypoints:
        - websecure
      tls:
        certResolver: cloudflare
      middlewares:
        - default-headers
        - rate-limit

  services:
    myapp-service:
      loadBalancer:
        servers:
          - url: "http://myapp-container:3000"
        healthCheck:
          path: "/health"
          interval: "30s"

  middlewares:
    default-headers:
      headers:
        frameDeny: true
        sslRedirect: true
        browserXssFilter: true
        contentTypeNosniff: true
        forceSTSHeader: true
        stsIncludeSubdomains: true
        stsPreload: true
        stsSeconds: 31536000

    rate-limit:
      rateLimit:
        burst: 100
        average: 50

# 📥 Install cloudflared
curl -L https://github.com/cloudflare/cloudflared/releases/latest/download/cloudflared-linux-amd64.deb -o cloudflared.deb
sudo dpkg -i cloudflared.deb

# 🔐 Authenticate with Cloudflare
cloudflared tunnel login

# 🚇 Create tunnel
cloudflared tunnel create my-tunnel

# 🎫 Generate tunnel token
cloudflared tunnel token my-tunnel

cloudflared tunnel token --cred-file ./credentials.json <TUNNEL_ID>

# 🔍 Check DNS records
dig myapp.yourdomain.com
nslookup myapp.yourdomain.com

# Start services
make run                    # Start with auto-restart
make dev                    # Development mode
make prod                   # Production mode

# Control services
make stop                   # Stop all services
make restart                # Zero-downtime restart
make update                 # Update to latest images

# View service status
make status                 # Comprehensive status overview
make health-check          # Full health diagnostics

# Log management
make logs                  # Live logs with timestamps
make logs-traefik          # Traefik-specific logs
make logs-errors           # Error logs only

# Quality assurance
make test                  # Run test suite
make lint                  # Validate configurations
make security-scan         # Security vulnerability scan

# Development tools
make shell                 # Enter container shell
make info                  # Image information

# Cleanup operations
make clean                 # Clean containers & resources
make clean-all             # Deep cleanup with cache
make clean-logs            # Remove old log files

# Build and deployment
make build                 # Build Docker image
make push                  # Push to registry
make release VERSION=v1.0.0  # Create versioned release

# Pipeline execution
make ci                    # Complete CI pipeline
make cd                    # Complete CD pipeline

# Start services
make run                    # Start with auto-restart
make dev                    # Development mode
make prod                   # Production mode

# Control services
make stop                   # Stop all services
make restart                # Zero-downtime restart
make update                 # Update to latest images

# 🔐 TLS Configuration
tls:
  options:
    default:
      sslProtocols:
        - "TLSv1.2"
        - "TLSv1.3"
      cipherSuites:
        - "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
        - "TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305"
        - "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"

# 📊 Global Middlewares
http:
  middlewares:
    secure-headers:
      headers:
        accessControlAllowMethods:
          - GET
          - OPTIONS
          - PUT
        accessControlMaxAge: 100
        hostsProxyHeaders:
          - "X-Forwarded-Host"
        referrerPolicy: "same-origin"

# 🎯 Latest version
docker pull zenkiet/traefik-tunnel-expose:latest

# 🏷️ Specific version
docker pull zenkiet/traefik-tunnel-expose:v1.0.0

# 📊 Check image info
docker inspect zenkiet/traefik-tunnel-expose:latest

docker run -d \
  --name traefik-tunnel \
  --restart unless-stopped \
  -p 80:80 \
  -p 443:443 \
  -p 8080:8080 \
  -v /var/run/docker.sock:/var/run/docker.sock:ro \
  -v ./data:/data \
  -v ./config:/etc/traefik \
  -e CF_API_TOKEN=your_token \
  -e CF_ZONE_ID=your_zone_id \
  zenkiet/traefik-tunnel-expose:latest

# 🍴 Fork and clone
git clone https://github.com/your-username/traefik-tunnel-expose.git
cd traefik-tunnel-expose

# 🌿 Create feature branch
git checkout -b feature/amazing-feature

# 🔧 Make changes and test
docker-compose up -d

# ✅ Commit changes
git commit -m "✨ Add amazing feature"

# 🚀 Push and create PR
git push origin feature/amazing-feature

MIT License

Copyright (c) 2025 ZenKiet