Docker Setup Guide - Production-Ready Worklenz

This repository now includes a production-ready Docker setup with enterprise-grade features including nginx reverse proxy, SSL/TLS support, Redis caching, automated backups, and comprehensive management scripts.

🚀 Quick Start

Option 1: Automated Setup (Recommended)

./quick-setup.sh

Install and start Worklenz

During the process, you will be prompted for:

Domain: Enter localhost for local testing. For production, enter your server's domain.
Build and push images: Answer no (recommended) to use pre-built images from Docker Hub, which is much faster. Answer yes only if you want to build custom images.
Docker Hub username: If you chose to build custom images, enter your Docker Hub username. This is used to tag and push the images to your own repository.

Option 2: Manual Setup

# 1. Copy environment file
cp .env.example .env

# 2. Edit .env and set required values:
#    - DB_PASSWORD
#    - SESSION_SECRET (generate with: openssl rand -hex 32)
#    - COOKIE_SECRET (generate with: openssl rand -hex 32)
#    - JWT_SECRET (generate with: openssl rand -hex 32)
#    - AWS_SECRET_ACCESS_KEY (MinIO password)
#    - REDIS_PASSWORD

# 3. Start services (Express mode - includes PostgreSQL, Redis, MinIO)
docker compose --profile express up -d

# 4. For production with SSL
docker compose --profile express --profile ssl up -d

📋 What's New

1. Production-Ready Docker Compose

Nginx reverse proxy with SSL/TLS termination
Redis cache for session management
Automated database backups with retention policies
Health checks for all services
Network isolation (separate backend/frontend networks)
Security hardening (non-root users, no-new-privileges)
Profile-based deployment (express/advanced modes)

2. Enhanced Dockerfiles

Backend Dockerfile

Multi-stage build for smaller images
Non-root user (worklenz) for security
tini init system for proper signal handling
Health check endpoint
libvips42 for image processing
Proper log directory with permissions

Frontend Dockerfile

Multi-stage build with Alpine Linux
Non-root user for security
Runtime environment injection (supports reCAPTCHA, Google Login, etc.)
tini init system
Health check endpoint
Optimized serve configuration

3. Nginx Configuration

SSL/TLS support (Let's Encrypt + self-signed)
Rate limiting (API and login endpoints)
WebSocket support for Socket.IO
Security headers (HSTS, CSP, X-Frame-Options, etc.)
Gzip compression
Static asset caching
Upstream load balancing

4. Database Initialization

Backup restoration on startup
Migration tracking system
Proper error handling
Initialization marker to prevent re-runs

5. Management Scripts

`manage.sh` - Comprehensive Management

./manage.sh [command]

Commands:
  install          Install Worklenz (auto-generates secrets)
  start            Start all services
  stop             Stop all services
  restart          Restart all services
  status           Show service status
  logs             View service logs
  backup           Create database backup
  restore          Restore from backup
  upgrade          Upgrade to latest version
  configure        Interactive configuration
  auto-configure   Auto-configure from .env DOMAIN
  ssl              Manage SSL certificates
  build            Build Docker images locally
  push             Push images to Docker Hub
  build-push       Build and push in one step

`quick-setup.sh` - Automated Installation

One-command setup with auto-generated secrets and SSL configuration.

🏗️ Architecture

┌─────────────────────────────────────────────────────────┐
│                    Nginx (Port 80/443)                  │
│              SSL/TLS, Rate Limiting, Caching            │
└────────────────────┬────────────────────────────────────┘
                     │
        ┌────────────┴────────────┐
        │                         │
┌───────▼────────┐       ┌───────▼────────┐
│   Frontend     │       │    Backend     │
│  (Node:22)     │       │   (Node:20)    │
│  Port: 5000    │       │   Port: 3000   │
└────────────────┘       └───────┬────────┘
                                 │
                    ┌────────────┼────────────┐
                    │            │            │
            ┌───────▼──┐   ┌────▼────┐  ┌───▼────┐
            │PostgreSQL│   │  Redis  │  │ MinIO  │
            │  Port:   │   │ Port:   │  │ Port:  │
            │  5432    │   │  6379   │  │ 9000   │
            └──────────┘   └─────────┘  └────────┘

🔧 Configuration

Deployment Modes

Express Mode (Default)

All services bundled together - PostgreSQL, Redis, MinIO included.

docker compose --profile express up -d

Advanced Mode

Use external services (AWS S3, Azure Blob, external PostgreSQL).

# Set in .env:
DEPLOYMENT_MODE=advanced
STORAGE_PROVIDER=s3  # or azure

docker compose up -d

Environment Variables

Key variables in .env:

DOMAIN - Your domain (localhost for local testing)
DEPLOYMENT_MODE - express or advanced
STORAGE_PROVIDER - s3 or azure
ENABLE_SSL - true/false
BACKUP_RETENTION_DAYS - Days to keep backups (default: 30)

See .env.example for complete documentation.

🔐 Security Features

Non-root containers - All services run as non-root users
Security options - no-new-privileges enabled
Network isolation - Backend network is internal-only
SSL/TLS - Let's Encrypt for production, self-signed for localhost
Rate limiting - API and login endpoints protected
Security headers - HSTS, CSP, X-Frame-Options, etc.
Secret management - Auto-generated secure secrets

💾 Backup & Restore

Automated Backups

Database backups run automatically every 24 hours with configurable retention:

# Enable backup service
docker compose --profile backup up -d

Manual Backup

./manage.sh backup

Restore from Backup

./manage.sh restore

Backups are stored in ./backups/ directory and compressed with gzip.

🌐 SSL/TLS Setup

Localhost (Self-Signed)

Automatically configured for localhost testing.

Production Domain (Let's Encrypt)

# 1. Set domain in .env
DOMAIN=your-domain.com
ENABLE_SSL=true
LETSENCRYPT_EMAIL=your-email@domain.com

# 2. Point DNS A record to your server IP

# 3. Start with SSL profile
docker compose --profile express --profile ssl up -d

Or use the management script:

./manage.sh ssl

📊 Monitoring

View Service Status

./manage.sh status
# or
docker compose ps

View Logs

./manage.sh logs
# or
docker compose logs -f [service-name]

Health Checks

All services include health checks:

Backend: http://localhost:3000/public/health
Frontend: http://localhost:5000
PostgreSQL: pg_isready
Redis: redis-cli ping
MinIO: /minio/health/live

🔄 Upgrading

./manage.sh upgrade

This will:

Create a backup
Pull latest images
Rebuild containers
Restart services

🐳 Building Custom Images

Build Locally

./manage.sh build

Push to Docker Hub

./manage.sh push

Build and Push

./manage.sh build-push

📁 Directory Structure

worklenz/
├── docker-compose.yaml          # Main compose file
├── .env.example                 # Environment template
├── manage.sh                    # Management script
├── quick-setup.sh              # Quick setup script
├── nginx/                      # Nginx configuration
│   ├── nginx.conf
│   ├── conf.d/
│   │   └── worklenz.conf
│   └── ssl/                    # SSL certificates
├── scripts/                    # Database scripts
│   └── db-init-wrapper.sh
├── backups/                    # Database backups
├── worklenz-backend/
│   └── Dockerfile              # Backend Dockerfile
└── worklenz-frontend/
    └── Dockerfile              # Frontend Dockerfile

❓ FAQ

What if Docker is not installed?

You must install Docker and Docker Desktop (for Windows/Mac) or Docker Engine (for Linux). Follow the official Docker installation guide.

How do I install Docker Compose?

Modern Docker installations (Docker Desktop and latest Docker Engine) include Docker Compose by default. You can check by running docker compose version. If you need to install it separately, see the Compose installation guide.

Why do I get "permission denied" errors on Linux?

On Linux, you may need to run Docker commands with sudo or add your user to the docker group:

sudo usermod -aG docker $USER

Note: You may need to log out and back in for this change to take effect.

I'm on Windows, why isn't it working?

For the best experience on Windows, we recommend using WSL2 (Windows Subsystem for Linux).

Install WSL2.
Install Docker Desktop for Windows.
Enable WSL2 integration in Docker Desktop Settings -> Resources -> WSL Integration.

How do I check if my hardware supports virtualization?

Windows: Check Performance tab in Task Manager. Look for "Virtualization: Enabled".
Linux: Run lscpu | grep Virtualization.

🆘 Troubleshooting

Services won't start

# Check logs
docker compose logs

# Check service status
docker compose ps

# Restart services
./manage.sh restart

Database initialization fails

# Check database logs
docker compose logs postgres

# Verify database scripts exist
ls -la worklenz-backend/database/sql/

SSL certificate issues

# For Let's Encrypt
./manage.sh ssl

# Check certificate info
openssl x509 -in nginx/ssl/cert.pem -text -noout

Port conflicts

# Change ports in .env
HTTP_PORT=8080
HTTPS_PORT=8443

📝 Migration from Old Setup

If you're migrating from the old docker-compose.yml:

Backup your data:

docker compose exec db pg_dump -U postgres worklenz_db > backup.sql

Stop old containers:

docker compose -f docker-compose.yml down

Copy your .env files to the new structure
Start new setup:
```
docker compose --profile express up -d
```
Restore data if needed:
```
./manage.sh restore
```

🤝 Contributing

When making changes to Docker configuration:

Test with both express and advanced modes
Verify health checks work
Test SSL setup for both localhost and production
Update this documentation

FilesExpand file tree

DOCKER_SETUP.md

Latest commit

History