Magda Documentation

How to build and run
Architecture Decision Records (ADRs)
How to Release a New Version
Testing a PR with a Preview Release Before Merging
End-to-End Full Cluster Deployment Test
Migration & Upgrade Documents
Deploy Magda with helm charts release
Magda Helm Chart Reference
How to update Helm chart docs (helm-docs)
How to deploy Magda on Google Cloud GKE
How to deploy Magda on Amazon AWS EKS
How to deploy Magda on Microsoft Azure Cloud AKS
How to use APIs
mgd CLI — terminal & coding-agent access to a catalog (search, download, create/edit datasets; Claude Code / Codex / opencode skills)
How to document APIs
How API docs are generated & served (magda-apidocs-server)
How to create API key
How to set/unset admin users
How to manage users, roles & permissions
How to manage organizational hierarchy
How to create local users
How to setup HTTPS access to Local Dev Cluster
How to Customise Magda UI
Plugin UI Component SDK Doc
How to build your own connectors / minions
Authentication Plugin Spec Document
How to recover with continuous archive backup
Ports used when running locally
Windows Setup Instructions
Regions Config