A professional command-line orchestrator for running, managing, and developing Liferay Portal and Liferay DXP environments in Docker using Docker Compose.
Setting up Liferay in Docker manually requires managing complex Docker Compose files, container health checks, database volume permissions, Traefik reverse proxies, and pre-seeded databases. Liferay Docker Manager (LDM) streamlines your entire Liferay Docker environment into simple, declarative CLI commands:
- Zero-Config Liferay Docker Stacks: Boot production-grade Liferay DXP, PostgreSQL, and Search containers instantly.
- Fast Local Dev & Workspace Linking: Link local Liferay Workspaces directly with running Liferay Docker containers.
- Instant Database Snapshots: Save and restore complete state snapshots of your Liferay Docker volumes.
Check out our Video Showcase to see short demonstrations of LDM in action, including Fast Provisioning, Cloud Hydration, and instant Snapshots & Restoration!
The standalone binary is the recommended way to use LDM. Copy and run the block specific to your environment:
sudo curl -L https://github.com/peterrichards-lr/liferay-docker-manager/releases/latest/download/ldm-macos-arm64 -o /usr/local/bin/ldm
sudo chmod +x /usr/local/bin/ldmsudo curl -L https://github.com/peterrichards-lr/liferay-docker-manager/releases/latest/download/ldm-macos-x86_64 -o /usr/local/bin/ldm
sudo chmod +x /usr/local/bin/ldmsudo curl -L https://github.com/peterrichards-lr/liferay-docker-manager/releases/latest/download/ldm-linux -o /usr/local/bin/ldm
sudo chmod +x /usr/local/bin/ldmNew-Item -ItemType Directory -Force -Path "$HOME\bin"
Invoke-WebRequest -Uri "https://github.com/peterrichards-lr/liferay-docker-manager/releases/latest/download/ldm-windows.exe" -OutFile "$HOME\bin\ldm.exe"
[Environment]::SetEnvironmentVariable("Path", [Environment]::GetEnvironmentVariable("Path", "User") + ";$HOME\bin", "User")For detailed platform-specific prerequisites, see the Full Installation Guide.
Once installed, bootstrap or run your stacks instantly:
# 1. THE CONFIDENCE BOOSTER: Run Liferay with pre-configured samples
# For more information see LDM Conventions & Features
ldm run my-sample-project --samples
# 2. THE VANILLA FLOW: Run a fresh vanilla Liferay instance (LTS release)
# For more information see Fresh Vanilla Start
ldm run my-vanilla-project --vanilla --tag 2026.q1.7-lts
# 3. THE DEVELOPER FLOW: Link a local workspace and start monitoring
# For more information see Liferay Workspace Local Dev
ldm link /path/to/workspace my-project
# 4. THE PREDEFINED QUICKSTART: Bootstrap an accelerator demo stack
# For more information see LDM Conventions & Features
ldm quickstart aica
# 5. THE TIME MACHINE: Take a snapshot of your database and volumes, and restore them later
# For more information see Data Management & Backup Snapshots
ldm snapshot my-project
ldm restore my-project
# 6. THE CLONE FLOW: Clone and setup a remote Git workspace repository
# For more information see Liferay Workspace Local Dev
ldm clone https://github.com/my-org/my-workspace.git my-project
# 7. THE PORTABLE PACKAGE: Export and Import compiled project snapshots (.ldmp)
# For more information see Portable Packages & Remote Repositories (.ldmp)
ldm package my-project
ldm import /path/to/my-project.ldmp
# 8. THE MULTI-NODE FLOW: Register compute targets and live-migrate workloads
# For more information see Multi-Node Orchestration & Remote Node Setup
ldm target add prod-aws --host 34.200.10.5 --user ubuntu --key ~/.ssh/aws-key.pem
ldm target migrate local prod-awsNote
Headless & Seeding Prompt Behaviors:
- By default, LDM checks for a cached pre-warmed database seed. If not cached, it will prompt you interactively to download it.
- CI/CD / Headless Scripts: To prevent interactive prompts from blocking headless environments, pass
-y/--yes/--non-interactiveto automatically confirm seed downloads, or pass--vanilla/
--no-seedto skip seeding entirely and start a clean baseline database.
Legacy Commands Note:
ldm init-from has been deprecated and is superseded by the ldm link command.
LDM is conventions-driven and highly customizable. Choose a topic below for detailed information:
- Installation Guide — Setting up macOS (Colima/OrbStack), Linux, and Windows (WSL2).
- LDM Conventions & Features — Default stacks, ports, database options, and key features.
- Compatibility Matrix — Supported host OS, Docker providers, and engines.
- Troubleshooting & Diagnostics — Logs, Docker deadlocks, port conflicts, and common fixes.
- Multi-Node Orchestration & Remote Node Setup — Registering compute nodes, remote stack execution, and live workload migration (
ldm target). - Fresh Vanilla Start — Launching empty Liferay instances for quick tests.
- Liferay DXP Nightly & Master Builds Guide — Orchestrating Liferay DXP nightly builds without compiling source code locally.
- PaaS "Golden Path" Local Dev — Fetching backups and replicating Liferay Cloud environments locally.
- Liferay Workspace Local Dev — Linking local workspaces with LDM for active source code development.
- Liferay Version Upgrades — Safely upgrading Liferay Docker image tags, database backup snapshots, and schema auto-upgrades.
- Runtime Overrides & Fragments — Dynamic substitution and environment-aware client extension patching.
- Properties Hierarchy & Precedence — The 5-layer cascading properties and
# !importantoverrides.
- Multi-Node Orchestration & Remote Node Setup — Registering compute nodes, remote stack execution, and live workload migration (
ldm target). - Portable Packages & Remote Repositories (.ldmp) — Exporting, sharing, and importing compiled
.ldmppackages and GitHub repositories. - Data Management & Backup Snapshots — Snapshots, pre-warmed seeds, and volume archives.
- Sharing & Tunnels — Securely sharing local stacks publicly using tunnels.
- Networking, DNS & Zero-Config SSL — Traefik routing, hostname mappings, and trust certificates.
- AI Command Center & LDM MCP Server — Powering AI workflows with LDM FastMCP tools.
- Advanced CLI Overrides — Colorless/ASCII outputs and global cli defaults.
- End-to-End Testing with LDM — Using LDM as an orchestration layer for automated CI/CD and local tests.
- Architecture Diagrams & Overview — Visual environment diagrams, hybrid volumes, routing, and lifecycles.
- Release Playbook — Pipeline standards and release workflow triggers.
For a complete structured table of contents, visit the Documentation Index.
Last Updated: 2026-08-04 | Last Reviewed: 2026-08-03