Liferay Docker Manager documentation¶
LDM runs, manages and develops Liferay DXP and Portal environments in Docker from a single CLI: declarative stacks, instant snapshots, and local workspaces linked to running containers.
π° As featured on the Liferay Blog: Effortless Liferay Orchestration: Advanced Docker Scripts for Local Development β Peter Richards, March 2026.
Community project
Not an official Liferay product and not covered by Liferay Support. About this project
I want to⦶
| I want to⦠| Go to |
|---|---|
| Get Liferay running for the first time | The First 5 Minutes |
| Install LDM, or fix a broken setup | Installation & Setup |
| Do a specific task β import a workspace, move data, expose a demo | How-to guides |
| Look something up β a flag, a setting, a port | Reference |
| Understand why LDM behaves as it does | Explanation |
| Fix something that is broken | Troubleshooting |
| Contribute to LDM itself | Playbook Β· Testing |
Each section above opens on a page that groups its own contents and says when to pick each one. The categorised index further down lists every page in one place, organised by subject rather than by what you are trying to do β use whichever suits how you are looking.
By subject¶
Getting started and core reference¶
- The First 5 Minutes β Start here. From nothing to a running Liferay, with Client Extensions attached and logs streaming.
- Installation & Setup β Step-by-step setup for macOS (Colima/OrbStack), Linux, and Windows (WSL2/Native). Reach for this if LDM is not installed yet, or something is broken.
- Key Features β What LDM gives you out of the box: session isolation, zero-config SSL, snapshots, fail-fast checks.
- Conventions & Configuration β The default stack, and how an LDM setting is resolved.
- CLI Reference & Automation β Subcommands, global options, and scripting parameters.
- Compatibility Matrix β Verified host operating systems, Docker engines, and providers.
- Troubleshooting & Diagnostics β Docker locks, port collisions, volume lag, and diagnostic commands.
Local development and customisation¶
- 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 β Hydrating local setups using remote Liferay Cloud backups.
- Liferay Workspace Local Dev β Linking 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.
- Patching Core Portal JARs β Applying patched core JARs from
portal-patches/, with version-drift protection. - Properties Hierarchy & Precedence β Merging cascading properties and using
# !importantrules.
Environment and remote infrastructure¶
- 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 database seeds, and volume archives.
- Sharing & Tunnels β Exposing local projects securely to public subdomains (lfr-tunnel, Ngrok).
- Networking, DNS & Zero-Config SSL β Traefik proxy configurations, virtual hostnames, and HTTPS cert trust.
Integration and developer resources¶
- AI Command Center & LDM MCP Server β Driving AI developer environments via FastMCP tools.
- Advanced CLI Tuning β Sudo policy, global defaults, colorless outputs, and custom environment variables.
- Development & Build Guide β Setting up local dev, packaging egg binaries, and contributing.
- Operational Playbook & CI Release Specs β Build pipelines, branch workflows, and release tags.
- Testing & Validation β Unit tests, mock suites, and multi-OS E2E validation.
- Architecture Overview β LDM micro-architecture, abstraction layers, and directory layouts.
- Remote Node Architecture: Target Resolution β How
--node/--targetprecedence, pinning, and conflict handling work under the hood. - Security Posture & Disclosures β Safe secrets handling and security policy.
- Third-Party Tools List β Internal and external dependencies (mkcert, Traefik, etc.).
- Future Roadmap β Planned features and strategic milestones.
Showcase¶
Short demonstrations of LDM in action -- fast provisioning, cloud hydration, and snapshots and restoration: Video Showcase.
Related Liferay tools¶
Three community tools from the same maintainer. None is an official Liferay product or covered by Liferay Support.
| Tool | What it does |
|---|---|
| Liferay Docker Manager | You are here. Run, manage and develop Liferay DXP and Portal environments in Docker. |
| Liferay AI Commerce Accelerator | Generate and manage AI-driven commerce data in Liferay DXP. |
| Liferay Tunnel | Securely expose a local Liferay environment on a public HTTPS subdomain. |
Last Updated: 2026-10-16 | Last Reviewed: 2026-10-16