GET STARTED · THREE PATHS
Start with the path that fits
MIAO is an open-source, self-hostable workspace. Choose what you want to verify first: understand it locally, run one instance for a team, or contribute to the source and public Issues. This page only uses installation and operations facts already documented in the repository.
Boundaries firstThere is no SaaS plan, cloud SLA, autoscaling or enterprise support promise here. Production domains, models, mail, backup and restore, and reverse proxies require separate target-environment acceptance.
01 · LOCAL EVALUATION
Evaluate locally
For people who want to create a workspace, inspect the examples and read the API entry points first. Source installation needs the Go toolchain; a local process does not become a production service by itself.
- Prerequisites
- Source checkout and the pinned Go 1.27.1 toolchain. Node.js/npm is only needed for an optional browser bundle build.
- What you get
- A local MIAO process, embedded UI/PocketBase, and a local data directory.
- Updates and support
- Follow source and Release records; there is no hosted service or production SLA.
Source path documented
02 · SINGLE-SERVER PRODUCTION
Run one production server
For teams deploying one version to their own Linux or macOS host. The Go binary, embedded UI, PocketBase migrations and data directory are managed together.
- Prerequisites
- Supported x64/ARM64 host, PM2, curl, openssl, and an HTTPS reverse proxy maintained by the operator.
- What you get
- A versioned binary, PM2 process, configuration file, and an operator-owned data directory.
- Upgrade and rollback
- Back up before upgrading; PM2 manages process switching. Database rollback is not automatic and recovery must be rehearsed from the operations guide.
Needs target-environment acceptance
03 · CONTRIBUTE
Contribute to the source
For people who want to fix a problem, improve documentation or discuss the next capability. Public Issues are the source of truth; planned work is not automatically a current product capability.
- Prerequisites
- A GitHub account, the source repository, and a clear problem or change description.
- What you get
- An Issue, pull request, documentation change or reproducible source update.
- Maintenance boundary
- Align product boundaries and acceptance evidence first; private validation environments are not visitor prerequisites.
Public collaboration path
NEXT CHECK
After you choose a path
miao.my