Meet Worklenz, a powerful, open-source project management platform built to help teams plan smarter, collaborate better, and ship faster. No bloated tools. No unnecessary complexity. Just everything your team needs, in one place. 🚀

Worklenz is growing every day. Your bug reports, feature ideas, and feedback shape what we build next. Jump into Discord or open a GitHub issue - we read everything!

🚀 Getting Started

Pick the setup that works best for you:

☁️ Worklenz Cloud

The fastest way to get started - no setup, no infrastructure. Just sign up at worklenz.com and start managing projects in minutes.

🖥️ Self-Host Worklenz

Prefer full control over your data? Run Worklenz on your own server.

🌟 Features

• 🗺️ Project Management - Plan, execute, and monitor projects from start to finish with full visibility across every stage.
• 📋 Task Management - Break projects into tasks, set priorities, due dates, and track progress with multiple views (list, board, Gantt).
• 📐 Resource Planning - Allocate the right people to the right tasks at the right time - keep your team balanced and productive.
• 👥 Team & Client Collaboration - Bring your team and clients together in one shared space to align on goals, updates, and deliverables.
• 💰 Financial Insights - Track budgets, costs, and financial performance across projects to keep spending on track and transparent.
• ⏱️ Time Tracking - Log time directly on tasks to understand where your team's hours are actually going.
• 📊 Analytics & Reporting - Get real-time insights into project health, team workload, and performance.
• 🗓️ Resource Management - Plan team capacity, avoid overallocation, and schedule work with a visual scheduler.
• 🧩 Project Templates - Start new projects in seconds using pre-built templates for common workflows.
• 🤝 Team Collaboration - Comment on tasks, share files, and keep all communication in context - right where the work is.
  
  

📸 Screenshots

⚙️ Tech Stack

Requirements

• Node.js version v18 or newer
• PostgreSQL version v15 or newer
• Docker and Docker Compose (for containerized setup)

📝 Documentation

Explore Worklenz's product documentation to learn about features, setup, and usage and more.

🐳 Quick Start (Docker — Recommended)

The fastest way to get Worklenz running locally with all dependencies included. This setup includes production-ready features like nginx reverse proxy, SSL/TLS support, Redis caching, and automated backups.

📋 Prerequisites:

• Docker and Docker Compose installed on your system
• Git

🪜 Steps:

Option 1: Automated Setup (Easiest)

# 📥 Clone the repository
git clone https://github.com/Worklenz/worklenz.git
cd worklenz

# Run the automated setup script
./quick-setup.sh

This script will:

• ✅ Create .env file with auto-generated security secrets
• ✅ Configure URLs based on your domain (localhost or production)
• ✅ Set up SSL certificates (self-signed for localhost, Let's Encrypt for production)
• ✅ Install and start all services

Option 2: Manual Setup

# 📥 Clone the repository
git clone https://github.com/Worklenz/worklenz.git
cd worklenz

# 📄 Copy and configure environment file
cp .env.example .env
# Edit .env and set required values (DB_PASSWORD, SESSION_SECRET, etc.)

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

🌐 Access the application:

• Application: https://localhost (or http://localhost)
• MinIO Console: http://localhost:9001 (login: minioadmin/minioadmin)

🛠️ Management:

# Use the management script for common operations
./manage.sh status    # View service status
./manage.sh logs      # View logs
./manage.sh backup    # Create database backup
./manage.sh stop      # Stop all services
./manage.sh start     # Start all services

For detailed documentation, see DOCKER_SETUP.md

Video Guide: For a visual walkthrough of the local Docker deployment process, check out our step-by-step video guide.

🛠️ Manual Installation (For Development)

For developers who want to run the services individually or customize the setup.

📋 Prerequisites:

• Node.js (version 18 or higher)
• PostgreSQL (version 15 or higher)
• An S3-compatible storage service (like MinIO) or Azure Blob Storage

🪜 Steps:

1. 📥 Clone the repository:

   git clone https://github.com/Worklenz/worklenz.git
   cd worklenz

2. ⚙️ Set up environment variables:

   cp worklenz-backend/.env.template worklenz-backend/.env
   # Update the environment variables with your configuration

3. 📦 Install dependencies:

   
   # Backend dependencies
   cd worklenz-backend
   npm install

🖥️ Frontend dependencies

cd ../worklenz-frontend npm install

4. 🗄️ Set up the database:
```bash
# Create a PostgreSQL database named worklenz_db
cd worklenz-backend

# Execute the SQL setup files in the correct order
psql -U your_username -d worklenz_db -f database/sql/0_extensions.sql
psql -U your_username -d worklenz_db -f database/sql/1_tables.sql
psql -U your_username -d worklenz_db -f database/sql/indexes.sql
psql -U your_username -d worklenz_db -f database/sql/4_functions.sql
psql -U your_username -d worklenz_db -f database/sql/triggers.sql
psql -U your_username -d worklenz_db -f database/sql/3_views.sql
psql -U your_username -d worklenz_db -f database/sql/2_dml.sql
psql -U your_username -d worklenz_db -f database/sql/5_database_user.sql

1. ▶️ Start the development servers:

   
   # Backend (single command for build, watch, and auto-restart)
   cd worklenz-backend
   npm run dev:all

Frontend (in another terminal)

cd worklenz-frontend npm run dev

6. 🌐 Access the application at http://localhost:5000

## 🚢 Deployment

### 🏠 Local Development

For local development, follow the [Quick Start (Docker)](#quick-start-docker) section above.

### 🌍 Production Deployment

The new Docker setup includes production-ready features for secure and scalable deployments.

#### ⚡ Quick Production Setup

```bash
# Clone and navigate to the repository
git clone https://github.com/Worklenz/worklenz.git
cd worklenz

# Run the automated setup
./quick-setup.sh
# When prompted, enter your production domain (e.g., worklenz.example.com)
# The script will configure SSL with Let's Encrypt automatically

🔧 Manual Production Setup

1. Configure environment for your domain:

   cp .env.example .env
   # Edit .env and set:
   # - DOMAIN=your-domain.com
   # - VITE_API_URL=https://your-domain.com
   # - VITE_SOCKET_URL=wss://your-domain.com
   # - ENABLE_SSL=true
   # - LETSENCRYPT_EMAIL=your-email@domain.com
   # - Generate secure secrets for DB_PASSWORD, SESSION_SECRET, etc.

2. Point your domain's DNS A record to your server IP

3. Start services with SSL:

   docker compose --profile express --profile ssl up -d

4. Access your application at: https://your-domain.com

🛠️ Management Commands

./manage.sh install    # Interactive installation
./manage.sh upgrade    # Upgrade to latest version
./manage.sh backup     # Create database backup
./manage.sh restore    # Restore from backup
./manage.sh ssl        # Manage SSL certificates
./manage.sh status     # View service status

🗂️ Deployment Modes

• 🟢 Express Mode (default): All services bundled (PostgreSQL, Redis, MinIO)

  docker compose --profile express up -d

• 🔵 Advanced Mode: Use external services (AWS S3, Azure Blob, external PostgreSQL)

  # Set DEPLOYMENT_MODE=advanced in .env
  docker compose up -d

For complete deployment documentation, see DOCKER_SETUP.md

Video Guide: For a complete walkthrough of deploying Worklenz to a remote server, check out our deployment video guide.

⚙️ Configuration

Environment Variables

Worklenz uses a comprehensive environment configuration system. Copy .env.example to .env and configure according to your needs.

📂 Key Configuration Areas:

• Deployment Mode: express (all services bundled) or advanced (external services)
• Domain & URLs: Configure for localhost or production domain
• Database: PostgreSQL credentials and connection settings
• Security Secrets: Session, cookie, and JWT secrets (auto-generated by setup scripts)
• Storage: MinIO (default), AWS S3, or Azure Blob Storage
• Redis: Cache configuration (Express mode)
• SSL/TLS: Let's Encrypt for production, self-signed for localhost
• Backups: Automated backup retention settings
• Optional Features: Google OAuth, reCAPTCHA, email notifications

⚡ Quick Configuration:

# Auto-generate all secrets and configure based on domain
./manage.sh auto-configure

# Or manually generate secrets
openssl rand -hex 32  # Use for SESSION_SECRET, COOKIE_SECRET, JWT_SECRET

📌 Important Variables:

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

For a complete list of variables with detailed documentation, see .env.example.

🪣 MinIO Integration

The project uses MinIO as an S3-compatible object storage service, which provides an open-source alternative to AWS S3 for development and production.

🔧 Working with MinIO

MinIO provides an S3-compatible API, so any code that works with S3 will work with MinIO by simply changing the endpoint URL. The backend has been configured to use MinIO by default, with no additional configuration required.

• 🖥️ MinIO Console: http://localhost:9001

  • Username: minioadmin
  • Password: minioadmin

• 🪣 Default Bucket: worklenz-bucket (created automatically when the containers start)

🛠️ Backend Storage Configuration

The backend is pre-configured to use MinIO with the following settings:

// S3 credentials with MinIO defaults
export const REGION = process.env.AWS_REGION || "us-east-1";
export const BUCKET = process.env.AWS_BUCKET || "worklenz-bucket";
export const S3_URL = process.env.S3_URL || "http://minio:9000/worklenz-bucket";
export const S3_ACCESS_KEY_ID = process.env.AWS_ACCESS_KEY_ID || "minioadmin";
export const S3_SECRET_ACCESS_KEY = process.env.AWS_SECRET_ACCESS_KEY || "minioadmin";

🔒 Security

Worklenz is built with security in mind:

• 🔐 Non-root Docker containers
• 🌐 Network isolation (backend is internal-only)
• 🔑 SSL/TLS (Let's Encrypt for produ