else/clan-munix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Run a NixOS closure as a microVM with desktop integration
53 commits 4 branches 1 tag 139 KiB
Find a file
Jörg Thalheim ced0559be8 nixos: add munix.defaultCommand option and system.build.munix 
Add a NixOS option to configure the default command for the VM and
provide a system.build.munix output that wraps munix with the correct
toplevel and default command. This reduces boilerplate in downstream
flakes since they no longer need to manually wrap munix.

The template now uses these new features, significantly simplifying
the apps definition.
2025-12-15 16:24:56 +01:00
devShells Add sidebus integration 2025-11-14 06:20:44 -03:00
nixosModules nixos: add munix.defaultCommand option and system.build.munix 2025-12-15 16:24:56 +01:00
packages switch from git submodules to flake inputs 2025-12-04 23:59:33 -03:00
templates/musictest nixos: add munix.defaultCommand option and system.build.munix 2025-12-15 16:24:56 +01:00
.envrc Initial commit 2025-09-25 22:29:24 -03:00
.gitignore Introduce micro-activate (RIIR activate script + tiny bit of tmpfiles) 2025-12-04 07:17:31 -03:00
flake.lock Update sidebus (now reverse-client to a session bus in the guest) 2025-12-09 06:41:01 -03:00
flake.nix readme: move example to flake template 2025-12-15 16:12:56 +01:00
LICENSE.md Initial commit 2025-09-25 22:29:24 -03:00
micro-activate.rs micro-activate: x86_64 type fix 2025-12-04 07:24:41 -03:00
munix munix: make the default command overridable via env 2025-12-05 04:06:05 -03:00
README.md readme: move example to flake template 2025-12-15 16:12:56 +01:00

README.md

munix

WIP: A microVM runner for NixOS systems with desktop integration, powered by muvm/libkrun.

Quick Start

1. Build a test VM:

nix build '.#nixosConfigurations.testvm-x86_64.config.system.build.toplevel' -o testvm

2. Run the VM:

nix run '.#munix' -- testvm

This will start an interactive bash session inside the microVM.

Run a specific command:

nix run '.#munix' -- testvm fastfetch

Create a custom VM:

Use the template to bootstrap a new munix project:

mkdir my-vm && cd my-vm
nix flake init -t 'git+https://git.clan.lol/clan/munix#musictest'
git init && git add flake.nix
nix run

This creates a flake.nix with a music player demo (MPD + Euphonica). Edit the module to customize your VM.

munix Options

  • --uid UID, -u UID - Set microVM UID (default: 1337)
  • --gid GID, -g GID - Set microVM GID (default: 1337)
  • --no-gpu - Disable GPU acceleration
  • --no-wayland - Disable Wayland support
  • --no-pipewire - Disable PipeWire audio
  • --x11 - Enable X11 support
  • --bind SRC DST - Bind mount SRC to DST in the VM
  • --ro-bind SRC DST - Read-only bind mount
  • --expose PATH - Expose PATH in the VM at the same location
  • --ro-expose PATH - Expose PATH read-only

Example with options:

nix run '.#munix' -- --no-gpu --ro-expose /home/user/data testvm htop

Development

Working on muvm & munix locally (not built into the nix store):

cd muvm && cargo build --locked --release
PATH=$PWD/muvm/target/release:$PATH ./munix testvm

Requirements

  • Linux system with KVM support (/dev/kvm)
  • For GPU acceleration: Kernel 6.13+ with compatible drivers (amdgpu, msm)
  • For Wayland: XDG_RUNTIME_DIR and WAYLAND_DISPLAY set

Known Issues