Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/mikronita/mikrom/llms.txt

Use this file to discover all available pages before exploring further.

Mikrom is a Rust-first edge platform for deploying applications into isolated microVMs. Point it at a Git repository, choose your CPU and RAM preset, and Mikrom handles building the OCI image, scheduling the workload onto a worker node, wiring up ingress routing with automatic TLS, and connecting everything through an internal WireGuard mesh.

Quickstart

Deploy your first application in minutes using the CLI or dashboard.

Architecture

Understand how the control plane, traffic plane, and platform services fit together.

CLI Reference

Full reference for every mikrom command, flag, and output format.

Configuration

Environment variables and runtime options for every Mikrom service.

​
What Mikrom Does

Mikrom turns a Git repository URL into a running microVM workload. The platform supports Phoenix, Rails, Django, Laravel, Go, Rust, JavaScript, Static, and Docker-based applications — the builder detects the stack and produces an OCI image without any additional configuration.

Deploy Applications

Create apps from Git repos and deploy with selectable CPU and RAM presets.

Managed Databases

Provision Neon-backed PostgreSQL databases running in Cloud Hypervisor microVMs.

Persistent Volumes

Attach Ceph-backed block volumes with snapshot and restore support.

Autoscaling

Configure fixed replicas or CPU/memory-based autoscaling. All apps scale to zero automatically.

​
Platform Services

Router

Pingora-based ingress with automatic TLS and ACME certificate management.

Networking

WireGuard mesh that connects workers, databases, and platform services.

DNS

Internal name resolution with DNS64 synthesis for IPv4 egress.

Agent

Worker daemon that manages microVM lifecycle, metrics, and log streaming.

Builder

Source-to-image engine that converts Git repos into OCI images via BuildKit.

Scheduler

Placement engine that assigns workloads to worker nodes based on capacity.

​
Get Started

1

Install the CLI

Build and install the mikrom binary from the workspace.
make install-cli
2

Authenticate

Log in with your email and password to obtain a session token.
mikrom auth login --email user@example.com --password secret
3

Create and deploy an application

Point Mikrom at a Git repository and trigger a build and deployment.
mikrom app create --name my-app --git-url https://github.com/user/my-app.git
mikrom app deploy --name my-app --cpu 2 --memory 1G
4

Check deployment status

List active deployments across all apps to confirm your workload is running.
mikrom deployment list

Build docs developers (and LLMs) love

Get started for freeTalk to us