🚀 Transform your NixOS system into a powerful KVM-over-IP solution! 🌟

This project brings the awesome PiKVM experience to NixOS through a clean, declarative configuration! 🎉

PiKVM turns your device into a remote KVM (Keyboard, Video, Mouse) solution, allowing you to:

• 🖱️ Control computers remotely
• 📺 View their screens in real-time
• ⌨️ Type on their keyboards
• 🔌 Manage power states
• 💾 Mount virtual drives
• 🔒 Access BIOS/UEFI settings

All through a beautiful web interface! ✨

• 🏗️ Declarative Configuration - Pure NixOS module approach
• 📦 Flake-based - Modern Nix development experience
• 🔧 Configurable - Customize hostname, OCR support, and more
• 🛡️ Secure - Proper user/group isolation
• 🎮 Multi-architecture - Supports x86_64 and ARM64
• 🖼️ OCR Support - Optional Tesseract integration for text recognition
• 🌊 µStreamer Integration - High-performance video streaming

• 🌐 Remote Access: Access your PiKVM web UI from anywhere, with real-time MJPEG video streaming and full keyboard/mouse control.

• 💾 ISO Upload: Easily upload ISO images to your Raspberry Pi for virtual media mounting.

• 🧹 Module Cleanup: Refactor and polish the NixOS module for maintainability and clarity.

• 🔄 Exact nginx Config Parity: Ensure the nginx configuration matches the official PiKVM kvmd setup exactly for full compatibility.

• 📚 Installation Documentation: Write step-by-step instructions for installing on NixOS, including disk formatting (potentially using disko for automated setup).

• 🚀 Virtual Media Mounting Support: Add support for mounting virtual media (such as ISO images) directly through PiKVM.

• ⬆️ Upstream to nixpkgs: Prepare and submit the module/package for inclusion in the official nixpkgs repository.

This section outlines a typical installation workflow for NixOS PiKVM on a Raspberry Pi, inspired by a real-world home lab setup.

Create a NixOS configuration for your Raspberry Pi. Example (see default.nix for a full config):

{
  imports = [
    inputs.nixos-hardware.nixosModules.raspberry-pi-4
    inputs.pikvm.nixosModules.default
  ];

  services.kvmd = {
    enable = true;
    package = inputs.pikvm.packages.aarch64-linux.default;
  };

  # ...other options (see linked config for details)
}

Use nixos-generators to build an SD image:

nix run nixpkgs#nixos-generators -- -f sd-aarch64 --flake .#<machine> --system aarch64-linux -o ./<machine>-sd-aarch64

Replace <machine> with your hostname or flake target.

Flash the generated image to your SD card using a tool like Caligula or dd.

After flashing, add two ext4 partitions to your SD card:

• PIMSD: Used for virtual USB (make it large enough for your ISOs)
• PIPST: Used for PiKVM persistent storage

You can use gparted or fdisk for partitioning.

Insert the SD card, boot your Raspberry Pi, and cross your fingers!

sudo systemctl status kvmd
sudo systemctl status ustreamer

sudo journalctl -u kvmd -f
sudo journalctl -u ustreamer -f

• TODO later

I love contributions! 💝 Dont hesitate to open issues or pull requests for bugs, features, or improvements.

• 🥧 PiKVM - The original PiKVM project
• 📺 µStreamer - Lightweight streaming server
• ❄️ nixpkgs - The Nix packages collection

This project is licensed under the GPL-3.0+ License - see the original PiKVM license for details.

If this project helped you, please consider giving it a ⭐! It helps others discover this awesome NixOS integration.