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 deploys applications directly from Git repositories into isolated microVMs running on either Firecracker or Cloud Hypervisor. The builder service automatically detects your project’s stack — no configuration files required — and produces an OCI image that the scheduler then places onto available agent nodes. Every deployment gets its own microVM boundary, giving you strong workload isolation without sacrificing the fast startup times that make edge deployments practical.

​
Supported Stacks

The Mikrom builder auto-detects the following stacks from your repository contents. You do not need to specify a framework — the builder identifies it from project files and applies the appropriate build strategy.

Phoenix

Elixir / Phoenix web applications

Ruby on Rails

Rails applications with standard layouts

Django

Python Django web applications

Laravel

PHP Laravel applications

JavaScript

Node.js and JavaScript runtimes

Go

Go module-based applications

Rust

Cargo-based Rust applications

Docker

Any repository with a Dockerfile

Static

Static sites and single-page apps

​
Creating and Deploying an App

1

Create the application record

Register your application with a unique name and a Git repository URL. Mikrom stores the repository reference and creates the application in your active project.
mikrom app create --name my-app --git-url https://github.com/you/my-app.git
FlagDescription
--nameUnique name for this application
--git-urlHTTPS URL of the source Git repository
2

Deploy the application

Trigger a build and deployment. Mikrom clones the repository, auto-detects the stack, builds an OCI image, and schedules a microVM with the resources you choose.
mikrom app deploy --name my-app --cpu 2 --memory 1G
Resource flags are optional — defaults are 1 CPU and 512M RAM.
3

Verify the deployment

List all applications to confirm the deployment is live and check its assigned hostname.
mikrom app list

​
Resource Presets

All apps are deployed using fixed resource presets. Fractional or arbitrary values are not supported — choose one from each column.
ResourceAvailable ValuesDefault
CPU cores1, 2, 3, 41
Memory512M, 1G, 2G, 4G512M
# Maximum preset: 4 vCPUs and 4 GB RAM
mikrom app deploy --name my-app --cpu 4 --memory 4G
Start with the default preset (1 CPU, 512M RAM) and scale up only after profiling your application under real load. Mikrom’s autoscaling can handle traffic bursts without permanently over-provisioning resources.

​
Hypervisor Selection

Mikrom supports two VMM backends. You can specify your preferred hypervisor at deploy time, or leave it unspecified to let the scheduler decide.
Firecracker is a KVM-based VMM optimised for minimal overhead and sub-second boot times. It is well-suited for stateless, latency-sensitive workloads.
mikrom app deploy --name my-app --hypervisor firecracker
  • Boot time: ~125 ms
  • Memory overhead: ~5 MB per VM
  • Best for: stateless APIs, event-driven workloads

​
Managing Deployments

​
List all applications

mikrom app list

​
View deployment history

Each deploy command produces a versioned deployment record. Use this command to list all past deployments for a given app. 
mikrom app deployments --name my-app

​
Activate or roll back a deployment

You can promote any previous deployment to active status. This is the primary rollback mechanism — no re-build is required. 
mikrom app activate --app my-app --deployment-id dep_abc123
Activating a previous deployment does not delete the current one. The former active deployment is retained in history and can be re-activated at any time.

​
GitHub Webhook Integration

Mikrom can automatically redeploy your application whenever you push to your repository. To set this up, retrieve the webhook secret for your app and configure it in your GitHub repository’s webhook settings. 
mikrom app secret --name my-app
Copy the returned secret into your GitHub repository under Settings → Webhooks, set the payload URL to your Mikrom API endpoint, and choose the push event. Mikrom will then trigger a new deployment on every push to the default branch.

​
Deleting an Application

mikrom app delete --name my-app
You will be prompted for confirmation. To skip the prompt in scripts, add --yes.
Deleting an application removes all its deployment history and associated secrets. Active microVMs are terminated immediately. This action cannot be undone.

Build docs developers (and LLMs) love

Get started for freeTalk to us