# pikvm/pikvm architecture

> Architecture diagram of the GitHub repository pikvm/pikvm, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/pikvm/pikvm
- Repository: https://github.com/pikvm/pikvm

## Overview

PiKVM is a Raspberry Pi-based IP-KVM for remotely operating a server or workstation, including when its operating system is unavailable. The documented workflow is remote access through the Web UI or VNC, viewing captured video, then controlling the host with emulated input, virtual media, or power-management features. The tree contains documentation but no runtime source, so nodes identify the relevant capability guides rather than implementation modules; edges reflect only relationships stated in the README.

Main entry points: [`README.md`](https://github.com/pikvm/pikvm/blob/master/README.md) (PiKVM appliance), [`docs/msd.md`](https://github.com/pikvm/pikvm/blob/master/docs/msd.md) (Virtual media), [`docs/webui.md`](https://github.com/pikvm/pikvm/blob/master/docs/webui.md) (Web UI), [`docs/vnc.md`](https://github.com/pikvm/pikvm/blob/master/docs/vnc.md) (VNC access)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_access["Remote access"]
  node_pikvm["PiKVM appliance<br/>[README.md]"]
  node_webui["Web UI<br/>[webui.md]"]
  node_vnc["VNC access<br/>[vnc.md]"]
end

subgraph group_interaction["Host interaction"]
  node_video["Video capture<br/>[video.md]"]
  node_webrtc["WebRTC video<br/>[webrtc_config.md]"]
  node_usbinput["USB input<br/>[usb.md]"]
  node_bluetooth["Bluetooth HID<br/>[bluetooth_hid.md]"]
  node_virtualmedia["Virtual media<br/>[msd.md]"]
  node_nfs[("NFS images<br/>[msd.md]")]
end

subgraph group_operations["Management features"]
  node_atx["ATX power<br/>[atx_board.md]"]
  node_ipmi["IPMI control<br/>[ipmi.md]"]
  node_redfish["Redfish control<br/>[ipmi.md]"]
  node_wol["Wake-on-LAN<br/>[wol.md]"]
  node_gpio["GPIO control<br/>[gpio.md]"]
  node_auth["Authorization<br/>[auth.md]"]
  node_https["HTTPS access<br/>[letsencrypt.md]"]
  node_monitoring["Health monitoring<br/>[prometheus.md]"]
  node_switch["Multiport switching<br/>[multiport.md]"]
end

node_operator(("Remote operator"))
node_host["Managed host"]

node_operator -->|"accesses"| node_webui
node_operator -->|"accesses"| node_vnc
node_webui -->|"controls"| node_pikvm
node_vnc -->|"accesses"| node_pikvm
node_pikvm -->|"captures"| node_video
node_video -->|"displays output"| node_host
node_pikvm -->|"streams video"| node_webrtc
node_pikvm -->|"emulates input"| node_usbinput
node_usbinput -->|"controls"| node_host
node_pikvm -->|"supports HID"| node_bluetooth
node_pikvm -->|"emulates media"| node_virtualmedia
node_virtualmedia -->|"presents media"| node_host
node_nfs -->|"supplies images"| node_virtualmedia
node_pikvm -->|"controls power"| node_atx
node_atx -->|"manages power"| node_host
node_pikvm -->|"supports control"| node_ipmi
node_pikvm -->|"supports control"| node_redfish
node_pikvm -->|"supports wake"| node_wol
node_pikvm -->|"controls ports"| node_gpio
node_operator -->|"authenticates through"| node_auth
node_operator -->|"connects securely"| node_https
node_pikvm -->|"reports health"| node_monitoring
node_pikvm -->|"supports switching"| node_switch

click node_pikvm "https://github.com/pikvm/pikvm/blob/master/README.md"
click node_webui "https://github.com/pikvm/pikvm/blob/master/docs/webui.md"
click node_vnc "https://github.com/pikvm/pikvm/blob/master/docs/vnc.md"
click node_video "https://github.com/pikvm/pikvm/blob/master/docs/video.md"
click node_webrtc "https://github.com/pikvm/pikvm/blob/master/docs/webrtc_config.md"
click node_usbinput "https://github.com/pikvm/pikvm/blob/master/docs/usb.md"
click node_bluetooth "https://github.com/pikvm/pikvm/blob/master/docs/bluetooth_hid.md"
click node_virtualmedia "https://github.com/pikvm/pikvm/blob/master/docs/msd.md"
click node_nfs "https://github.com/pikvm/pikvm/blob/master/docs/msd.md"
click node_atx "https://github.com/pikvm/pikvm/blob/master/docs/atx_board.md"
click node_ipmi "https://github.com/pikvm/pikvm/blob/master/docs/ipmi.md"
click node_redfish "https://github.com/pikvm/pikvm/blob/master/docs/ipmi.md"
click node_wol "https://github.com/pikvm/pikvm/blob/master/docs/wol.md"
click node_gpio "https://github.com/pikvm/pikvm/blob/master/docs/gpio.md"
click node_auth "https://github.com/pikvm/pikvm/blob/master/docs/auth.md"
click node_https "https://github.com/pikvm/pikvm/blob/master/docs/letsencrypt.md"
click node_monitoring "https://github.com/pikvm/pikvm/blob/master/docs/prometheus.md"
click node_switch "https://github.com/pikvm/pikvm/blob/master/docs/multiport.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_pikvm,node_webui,node_vnc toneBlue
class node_video,node_webrtc,node_usbinput,node_bluetooth,node_virtualmedia,node_nfs toneAmber
class node_atx,node_ipmi,node_redfish,node_wol,node_gpio,node_auth,node_https,node_monitoring,node_switch toneMint
class node_operator,node_host toneIndigo
```

## Components

### Remote access

- [PiKVM appliance](https://github.com/pikvm/pikvm/blob/master/README.md): `README.md`
- [Web UI](https://github.com/pikvm/pikvm/blob/master/docs/webui.md): `docs/webui.md`
- [VNC access](https://github.com/pikvm/pikvm/blob/master/docs/vnc.md): `docs/vnc.md`

### Host interaction

- [Video capture](https://github.com/pikvm/pikvm/blob/master/docs/video.md): `docs/video.md`
- [WebRTC video](https://github.com/pikvm/pikvm/blob/master/docs/webrtc_config.md): `docs/webrtc_config.md`
- [USB input](https://github.com/pikvm/pikvm/blob/master/docs/usb.md): `docs/usb.md`
- [Bluetooth HID](https://github.com/pikvm/pikvm/blob/master/docs/bluetooth_hid.md): `docs/bluetooth_hid.md`
- [Virtual media](https://github.com/pikvm/pikvm/blob/master/docs/msd.md): `docs/msd.md`
- [NFS images](https://github.com/pikvm/pikvm/blob/master/docs/msd.md): `docs/msd.md`

### Management features

- [ATX power](https://github.com/pikvm/pikvm/blob/master/docs/atx_board.md): `docs/atx_board.md`
- [IPMI control](https://github.com/pikvm/pikvm/blob/master/docs/ipmi.md): `docs/ipmi.md`
- [Redfish control](https://github.com/pikvm/pikvm/blob/master/docs/ipmi.md): `docs/ipmi.md`
- [Wake-on-LAN](https://github.com/pikvm/pikvm/blob/master/docs/wol.md): `docs/wol.md`
- [GPIO control](https://github.com/pikvm/pikvm/blob/master/docs/gpio.md): `docs/gpio.md`
- [Authorization](https://github.com/pikvm/pikvm/blob/master/docs/auth.md): `docs/auth.md`
- [HTTPS access](https://github.com/pikvm/pikvm/blob/master/docs/letsencrypt.md): `docs/letsencrypt.md`
- [Health monitoring](https://github.com/pikvm/pikvm/blob/master/docs/prometheus.md): `docs/prometheus.md`
- [Multiport switching](https://github.com/pikvm/pikvm/blob/master/docs/multiport.md): `docs/multiport.md`

### Other components

- **Remote operator**
- **Managed host**

## Connections

- Remote operator → Web UI: accesses (evidence: `README.md`)
- Remote operator → VNC access: accesses (evidence: `README.md`)
- Web UI → PiKVM appliance: controls (evidence: `README.md`)
- VNC access → PiKVM appliance: accesses (evidence: `README.md`)
- PiKVM appliance → Video capture: captures (evidence: `README.md`)
- Video capture → Managed host: displays output (evidence: `README.md`)
- PiKVM appliance → WebRTC video: streams video (evidence: `README.md`)
- PiKVM appliance → USB input: emulates input (evidence: `README.md`)
- USB input → Managed host: controls (evidence: `README.md`)
- PiKVM appliance → Bluetooth HID: supports HID (evidence: `README.md`)
- PiKVM appliance → Virtual media: emulates media (evidence: `README.md`)
- Virtual media → Managed host: presents media (evidence: `README.md`)
- NFS images → Virtual media: supplies images (evidence: `README.md`)
- PiKVM appliance → ATX power: controls power (evidence: `README.md`)
- ATX power → Managed host: manages power (evidence: `README.md`)
- PiKVM appliance → IPMI control: supports control (evidence: `README.md`)
- PiKVM appliance → Redfish control: supports control (evidence: `README.md`)
- PiKVM appliance → Wake-on-LAN: supports wake (evidence: `README.md`)
- PiKVM appliance → GPIO control: controls ports (evidence: `README.md`)
- Remote operator → Authorization: authenticates through (evidence: `README.md`)
- Remote operator → HTTPS access: connects securely (evidence: `README.md`)
- PiKVM appliance → Health monitoring: reports health (evidence: `README.md`)
- PiKVM appliance → Multiport switching: supports switching (evidence: `README.md`)
