> For the complete documentation index, see [llms.txt](https://docs.layeronecloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.layeronecloud.com/pve-microvm/installation.md).

# Installation

Source project: `pve-microvm` (migrated from `docs/installation.md`). Run commands from the code checkout and directory specified below, not from this documentation repository.

## From GitHub Release <a href="#from-github-release" id="from-github-release"></a>

Download the latest `.deb` from the [releases page](https://github.com/LayerOne-LLC/pve-microvm-secure/releases). Verify it before installing: this package rewrites the code path that starts every VM on the node.

```bash
# Download and install the latest release
gh release download --repo LayerOne-LLC/pve-microvm-secure \
  --pattern 'pve-microvm_*.deb' --pattern 'SHA256SUMS'
sha256sum -c SHA256SUMS
# Provenance attestation is published when the repository's plan supports it.
gh attestation verify pve-microvm_*.deb --repo LayerOne-LLC/pve-microvm-secure || true
dpkg -i pve-microvm_*.deb
apt-get install -f   # resolve any missing dependencies
```

## From source <a href="#from-source" id="from-source"></a>

```bash
git clone https://github.com/LayerOne-LLC/pve-microvm-secure.git
cd pve-microvm-secure
dpkg-buildpackage -us -uc -b
dpkg -i ../pve-microvm_*_all.deb
```

## Manual (development) <a href="#manual-development" id="manual-development"></a>

```bash
make install DESTDIR=/
/usr/share/pve-microvm/pve-microvm-patch apply
```

## Verify <a href="#verify" id="verify"></a>

```bash
/usr/share/pve-microvm/pve-microvm-patch status
# Expected: applied (2026-04-18T...)

qm create 999 --machine microvm --memory 128 --name test-microvm
qm destroy 999
```

## Uninstall <a href="#uninstall" id="uninstall"></a>

```bash
apt remove pve-microvm
```

The `prerm` hook automatically reverts all patches and restores the original `qemu-server` files from backup. No VMs or data are affected.

## Requirements <a href="#requirements" id="requirements"></a>

**Minimum: Proxmox VE 9.0+** (Debian Trixie). PVE 8.x is not supported.

| Component            | Version | Tested                       | Notes                     |
| -------------------- | ------- | ---------------------------- | ------------------------- |
| **Proxmox VE**       | 9.0+    | 9.1.7, 9.1.9                 | Debian Trixie based       |
| **`qemu-server`**    | 9.1.x   | 9.1.6, 9.1.8                 | Patched by this package   |
| **`pve-qemu-kvm`**   | 10.x    | 10.1.2                       | QEMU with microvm support |
| **`pve-ha-manager`** | 5.x     | 5.1.3, 5.2.0                 | HA relocate tested        |
| **Host kernel**      | 6.14+   | 6.17.13-2-pve, 6.17.13-3-pve | PVE 9 default             |

### Tested nodes <a href="#tested-nodes" id="tested-nodes"></a>

| Node      | CPU                                     | RAM    | Notes                     |
| --------- | --------------------------------------- | ------ | ------------------------- |
| **z83ii** | Intel Atom x5-Z8350 @ 1.44 GHz          | 2 GB   | Low-end stability testing |
| **borg**  | Intel Core i7-12700 @ 4.9 GHz, 20 cores | 128 GB | Performance reference     |

### Dependencies <a href="#dependencies" id="dependencies"></a>

* `skopeo` — OCI image pulling
* `umoci` — OCI image unpacking
* `qemu-utils` — disk conversion
* KVM — `/dev/kvm` available


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.layeronecloud.com/pve-microvm/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.