How-to guides¶
You have a task and roughly know what you want. Each guide here solves one problem and assumes LDM is already installed. If you are new and want to be walked through from the start, begin with The First 5 Minutes instead.
Install¶
- Installation & Setup — the full guide: prerequisites, per-OS SSL tooling, Docker permissions, shell completion, and troubleshooting for the things that commonly go wrong. Start here if LDM is not installed yet, or if something is broken.
- macOS · Windows · Linux — per-platform installation.
Get a project running¶
- Starting a Fresh Vanilla Liferay — a clean stack with no existing project or data.
- Workspace Import and Packaging — bring an existing
Liferay Workspace or an
.ldmppackage under LDM. - Nightly & Master Builds — run unreleased DXP builds rather than a published tag.
- Version Upgrades — move an existing project to a newer Liferay version.
Develop¶
- Client Extensions — deploy and iterate on Client Extensions, including deployment ordering.
- Patching Core Portal JARs — apply patches to the portal itself.
- Runtime Overrides & Fragment Substitutions — substitute fragments and override runtime behaviour.
- Development & Building — working on LDM itself.
Data and environments¶
- Data Management — snapshots, backups, and moving real datasets between environments.
- Custom Containers — run your own services alongside Liferay.
- Multi-Compose Architecture — decoupled compose stacks and shared networks.
Share and connect¶
- Sharing & Tunnels — expose a local Liferay to the internet for a demo or a webhook.
- AI & MCP — drive LDM from an AI agent over MCP.
Operate at scale¶
- Multi-Node Orchestration — run projects on remote compute nodes.
- Cloud Deployment — deploy to Liferay Cloud PaaS.
- AWS IAM Least Privilege — the minimum policy a target node's power control needs.
- End-to-End Testing — run the E2E verification suite.
Last Updated: 2026-10-16 | Last Reviewed: 2026-10-16