DEPLOYMENT.md
This guide covers deploying the N8N Workflows Documentation Platform in various environments.
# Clone repository
git clone <repository-url>
cd n8n-workflows-1
# Start development environment
docker compose -f docker-compose.yml -f docker-compose.dev.yml up --build
# Production deployment
docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d --build
# With monitoring
docker compose --profile monitoring up -d
# Start development environment with auto-reload
docker compose -f docker-compose.yml -f docker-compose.dev.yml up
# With additional dev tools (DB admin, file watcher)
docker compose --profile dev-tools up
# Basic production deployment
docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d
# With reverse proxy and SSL
docker compose --profile production up -d
# With monitoring stack
docker compose --profile monitoring up -d
# Build image
docker build -t workflows-doc:latest .
# Run container
docker run -d \
--name n8n-workflows-docs \
-p 8000:8000 \
-v $(pwd)/database:/app/database \
-v $(pwd)/logs:/app/logs \
-e ENVIRONMENT=production \
workflows-doc:latest
# Install dependencies
pip install -r requirements.txt
# Development mode
python run.py --dev
# Production mode
python run.py --host 0.0.0.0 --port 8000
# Install gunicorn
pip install gunicorn
# Start with gunicorn
gunicorn -w 4 -k uvicorn.workers.UvicornWorker -b 0.0.0.0:8000 api_server:app
# Apply Kubernetes manifests
kubectl apply -f k8s/namespace.yaml
kubectl apply -f k8s/configmap.yaml
kubectl apply -f k8s/deployment.yaml
kubectl apply -f k8s/service.yaml
kubectl apply -f k8s/ingress.yaml
# Install with Helm
helm install n8n-workflows-docs ./helm/workflows-docs
| Variable | Description | Default | Required |
|---|---|---|---|
ENVIRONMENT | Deployment environment | development | No |
LOG_LEVEL | Logging level | info | No |
HOST | Bind host | 127.0.0.1 | No |
PORT | Bind port | 8000 | No |
DATABASE_PATH | SQLite database path | database/workflows.db | No |
WORKFLOWS_PATH | Workflows directory | workflows | No |
ENABLE_METRICS | Enable Prometheus metrics | false | No |
MAX_WORKERS | Max worker processes | 1 | No |
DEBUG | Enable debug mode | false | No |
RELOAD | Enable auto-reload | false | No |
Create environment-specific configuration:
.env (Development)ENVIRONMENT=development
LOG_LEVEL=debug
DEBUG=true
RELOAD=true
.env.production (Production)ENVIRONMENT=production
LOG_LEVEL=warning
ENABLE_METRICS=true
MAX_WORKERS=4
# traefik/config/dynamic.yml
http:
middlewares:
auth:
basicAuth:
users:
- "admin:$2y$10$..." # Generate with htpasswd
security-headers:
headers:
customRequestHeaders:
X-Forwarded-Proto: "https"
customResponseHeaders:
X-Frame-Options: "DENY"
X-Content-Type-Options: "nosniff"
sslRedirect: true
# In docker-compose.prod.yml
command:
- "--certificatesresolvers.myresolver.acme.tlschallenge=true"
- "--certificatesresolvers.myresolver.acme.email=admin@yourdomain.com"
volumes:
- ./ssl:/ssl:ro
# Generate htpasswd entry
htpasswd -nb admin yourpassword
# Add to Traefik labels
- "traefik.http.middlewares.auth.basicauth.users=admin:$$2y$$10$$..."
# docker-compose.prod.yml
deploy:
resources:
limits:
memory: 512M
cpus: '0.5'
reservations:
memory: 256M
cpus: '0.25'
# Force reindex for better performance
python run.py --reindex
# Or via API
curl -X POST http://localhost:8000/api/reindex
# Traefik middleware for static files
http:
middlewares:
cache-headers:
headers:
customResponseHeaders:
Cache-Control: "public, max-age=31536000"
# Docker health check
HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
CMD curl -f http://localhost:8000/api/stats || exit 1
# Manual health check
curl http://localhost:8000/api/stats
# View application logs
docker compose logs -f workflows-docs
# View specific service logs
docker logs n8n-workflows-docs
# Log location in container
/app/logs/app.log
# Start monitoring stack
docker compose --profile monitoring up -d
# Access Prometheus
http://localhost:9090
# Backup SQLite database
cp database/workflows.db database/workflows.db.backup
# Or using docker
docker exec n8n-workflows-docs cp /app/database/workflows.db /app/database/workflows.db.backup
# Backup entire configuration
tar -czf n8n-workflows-backup-$(date +%Y%m%d).tar.gz \
database/ \
logs/ \
docker-compose*.yml \
.env*
# Stop services
docker compose down
# Restore database
cp database/workflows.db.backup database/workflows.db
# Start services
docker compose up -d
# docker-compose.scale.yml
services:
workflows-docs:
deploy:
replicas: 3
# Scale up
docker compose up --scale workflows-docs=3
# Traefik load balancing
labels:
- "traefik.http.services.workflows-docs.loadbalancer.server.port=8000"
- "traefik.http.services.workflows-docs.loadbalancer.sticky=true"
Database locked error
# Check file permissions
ls -la database/
# Fix permissions
chmod 664 database/workflows.db
Port already in use
# Check what's using the port
lsof -i :8000
# Use different port
docker compose up -d -p 8001:8000
Out of memory
# Check memory usage
docker stats
# Increase memory limit
# Edit docker-compose.prod.yml resources
# Application logs
docker compose logs -f workflows-docs
# System logs
docker exec workflows-docs tail -f /app/logs/app.log
# Database logs
docker exec workflows-docs sqlite3 /app/database/workflows.db ".tables"
# Pull latest changes
git pull origin main
# Rebuild and restart
docker compose down
docker compose up -d --build
# Backup current database
cp database/workflows.db database/workflows.db.backup
# Force reindex with new schema
python run.py --reindex
# Blue-green deployment
docker compose -p n8n-workflows-green up -d --build
# Switch traffic (update load balancer)
# Verify new deployment
# Shut down old deployment
docker compose -p n8n-workflows-blue down
Daily
Weekly
Monthly