Docs
MeteorCloud documentation
Learn and operate MeteorCloud — from first boot to production. Website: meteor-edge.com.
Start here
| Step | Doc |
|---|---|
| 1. Run the stack locally | Getting started |
| 2. Understand the three planes | Concepts |
3. Enroll a device with meteorcli | Getting started → First device |
Guides
How to use the product day to day.
| Topic | Doc |
|---|---|
| Users, organizations, members | Identity and organizations |
| Roles and access | Authorization (RBAC) |
| Device types and groups | Device types and groups |
| Admin-initiated enroll | Registration tokens · Device registration |
| Device-initiated enroll | Enrollment API keys · Request / approve / claim |
| Device HTTP auth & heartbeat | Device authentication · Heartbeat |
| MQTT connectivity | MQTT |
| Artifacts (images, firmware, …) | Artifacts |
| Releases (software versions) | Releases |
| Deployments (send a release) | Deployments |
| Operator console | Console |
Reference
Commands and APIs you look up while working.
| Topic | Doc |
|---|---|
| Control-plane HTTP API | API overview · interactive OpenAPI at /docs on a running API |
| Device CLI | meteorcli |
| MQTT ↔ control-plane contract | contracts/mqtt-http.md |
| Architecture & providers | Architecture |
Deploy and operate
| Path | Doc |
|---|---|
| Local / contributor setup | Development |
| Compose + Ansible (VM, EC2, on-prem) | Deployment |
| Kubernetes (existing cluster) | Kubernetes |
| AWS EC2 quick install | Install quickstart |
installation.yaml | Installer configuration |
Modular services (cloud_app, vpn) | Services |
| AWS prerequisites & deploy | Prerequisites · AWS deployment |
| Upgrades · destroy · logs | Upgrades · Destroy · Observability |
| When something breaks | Troubleshooting |
| EC2 smoke test (CI) | AWS CI |
Related code docs
- Device agent package:
src/device-plane/agent/README.md - Installer package:
infrastructure/installer/README.md