Luma documentation#

New to Luma? Read the first two pages in order, then pick guides as you need them. 简体中文

Start here#

Getting started: install the CLI, bootstrap a manager, deploy a first application, add nodes.
Concepts: nodes, regions, exposure, egress and services, and how they fit together.

Guides#

Guide	Covers
Deploying applications	Images, local builds, repository imports, Compose, recorded workflows and CI
Operations	Logs, history, rollback, restart, removal, updates and node maintenance
Compose and storage	Multi-service applications and persistent volumes
Secrets	Tokens, application secrets and registry credentials
Exposure model	Every ingress mode with requirements and examples
Custom-region public ingress	Upgrade, enable render relay, Mac Compose networking and rollback
Egress gateway	Outbound proxy for image pulls and `proxy: true` services
Observability	Metrics, alerts and the optional observe stack
Console guide	The web dashboard
AI agent skills	Skills that teach coding assistants to deploy with Luma
Troubleshooting	Known failures and their fixes

Reference#

Reference	Covers
Manifest reference	Every field of a service manifest
CLI reference	Every command and option, generated from the CLI
Control storage and recovery	The manager's SQLite state, retention, backup and restore
Installation lifecycle	How installs and updates are validated on each machine
Bootstrap profiles	Role sets used by `luma bootstrap --profile`

For maintainers#

Release process · Website · Dashboard design

View source on GitHub ↗ · Raw Markdown