You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
pikvm/README.md

838 lines
34 KiB
Markdown

# Open and cheap DIY IP-KVM based on Raspberry Pi
4 years ago
[![Discord](https://img.shields.io/discord/580094191938437144?logo=discord)](https://discord.gg/bpmXfz5) [![Reddit](https://img.shields.io/badge/reddit-join-orange?logo=reddit)](https://www.reddit.com/r/pikvm)
4 years ago
4 years ago
A very simple and fully functional Raspberry Pi-based KVM over IP that you can make with your own hands. This device helps to manage servers or workstations remotely, regardless of the health of the operating system or whether one is installed. You can fix any problem, configure the BIOS, and even reinstall the OS using the virtual CD-ROM or Flash Drive.
4 years ago
4 years ago
The website: [pikvm.org](https://pikvm.org). Also join to the [Discord Community Chat](https://discord.gg/bpmXfz5) for news, questions and support!
4 years ago
3 years ago
| **[>>> DIY Device Getting Started <<<](#diy-getting-started)** | **[>>> Pi-KVM v3 HAT Getting Started <<<](#pi-kvm-v3-hat-features)** |
3 years ago
| --------------------------------------------- | ------------------------------------------ |
3 years ago
| [DIY Review by **Novaspirit Tech**](https://youtu.be/plP9Y1likRg)<br>[**Hackaday**](https://hackaday.com/2020/11/24/true-networked-kvm-without-breaking-the-bank/) & [**Tom's HARDWARE**](https://www.tomshardware.com/how-to/kvm-over-ip-raspberry-pi)<br>[Our boring presentation for the DIY :)](https://youtu.be/9YhPWjWv5gw) | [Pi-KVM v3 Review by **Novaspirit Tech**](https://youtu.be/dTchVKxx7Fo)<br>[Another review by **Level1Techs**](https://www.youtube.com/watch?v=LwsznhIBPMc)<br>[Review by **The Geek Freaks** (DE)](https://www.youtube.com/watch?v=fnd6wojrw3c) |
3 years ago
| <img src="img/v2_example.jpg" alt="drawing"/> | <img src="img/v3_board.jpg" alt="drawing"/> |
| Web UI |
| ------------------------------------------ |
| <img src="img/screen1.png" alt="drawing" height=200/> |
# Features
4 years ago
* Supported **Raspberry Pi 2**, **3**, **4** and **ZeroW**;
* **FullHD video** using advanced **HDMI-to-CSI bridge** or **USB dongle**;
* Extra low **video latency** with **MJPEG** or **H.264 / WebRTC** (for CSI bridge);
4 years ago
* Bootable **Virtual CD-ROM** and **Flash Drive**;
4 years ago
* USB **Keyboard** and **mouse** (with leds and the wheel), PS/2 keyboard, Bluetooth HID;
4 years ago
* **Control the server power** using ATX functions;
4 years ago
* Access via **Web UI** or **VNC**;
4 years ago
* Ability to use **IPMI BMC**, **IPMI SoL**, **Redfish** and **Wake-on-LAN** to control the server;
4 years ago
* **The ready-made OS** with read-only filesystem;
3 years ago
* **Extensible authorization** and HTTPS out of the box;
4 years ago
* **Health monitoring** of the Pi;
4 years ago
* Control **GPIO** ports and **USB relays**;
4 years ago
* It only costs between $30 and $100 for parts!
4 years ago
* 100% Open Source!
4 years ago
<details>
<summary><b>More indepth details about the Pi-KVM features</b></summary>
4 years ago
## Fully-featured and modern IP-KVM
4 years ago
* **Cheaper, but better than commercial solutions**
Costs between $30 and $100 depending on the features desired. Even the most expensive configuration will be cheaper than a $500 commercial IP-KVM.
* **Easy to build - For the v0 variant**
A ready-to-use OS that can be created just by running `make build` and installed to an SD-card using `make install`. The hardware can be made in half an hour and without soldering.
4 years ago
* **The widest hardware support**
4 years ago
There are many ways to build a Pi-KVM. Video capture devices can be attached using the CSI-2 or USB interfaces. Raspberry Pi models 2, 3, 4, or ZeroW may be used. Any combination of hardware is supported, and Pi-KVM implements the maximum possible set of features.
4 years ago
* **Very low latency**
4 years ago
~100 milliseconds of video latency. This is the smallest delay of all existing solutions.
* **Extra lightweight and fancy Web UI**
No weird proprietary clients. No ugly Java applets. Just use your favorite browser to connect to the Pi-KVM. No flash plugins either!
4 years ago
* **Keyboard and mouse**
Mouse usage works directly in the browser. The keyboard emulator supports displaying the state of the keyboard LEDs.
4 years ago
* **Mass Storage Drive**
4 years ago
On the Raspberry Pi 4 and ZeroW, Pi-KVM can emulate a virtual CD-ROM or Flash Drive. A live image can be uploaded to boot the attached server.
4 years ago
* **ATX power management**
With a very simple circuit that can be assembled on a breadboard, the power button of the attached server can be controlled using the ATX button headers on the motherboard.
4 years ago
* **Security**
3 years ago
Pi-KVM can be opened to the Internet and no one will get access without the password. SSL is used to protect traffic from being intercepted by third parties.
4 years ago
* **Local monitoring**
Pi-KVM monitors the health of the Raspberry Pi board and will warn you if it's too hot or is not receiving enough power.
4 years ago
* **GPIO management**
You can control GPIO and USB relays via the web interface. The extensible interface allows you to make anything out of it.
4 years ago
## Production-ready
4 years ago
* **Linux-based embedded OS**
The Pi-KVM OS is based on [Arch Linux ARM](https://archlinuxarm.org) and can be customized for any needs. Thousands of pre-built binary packages are at your service and can be updated with a single command!
4 years ago
* **Read-only filesystem**
By default the OS runs in read-only mode, as an embedded system should. This prevents damage to the memory card due to a sudden power outage.
4 years ago
* **VNC server**
4 years ago
The managed server and its BIOS can be accessed using a regular VNC client which supports JPEG compression.
4 years ago
* **IPMI BMC and Redfish**
Use `ipmitool`, `ipmiutil` or any existing network infrastructure that supports IPMI to monitor and manage the server's power. Redfish and `redfishtool` supported too.
4 years ago
* **Wake-on-LAN**
4 years ago
Pi-KVM can be configured to power up a managed server using WoL. This will be available in the Web menu.
4 years ago
* **Extensible authorization methods**
Multiple Pi-KVMs can be configured to use a [common authorization service](https://github.com/pikvm/kvmd-auth-server). PAM and its rich authorization mechanisms can also be used to integrate Pi-KVM into your existing authentication infrastructure.
4 years ago
* **Macro scripts**
If repetitive actions must be performed on the attached server (or on several different servers), a macro can be recorded with keyboard & mouse actions and can be played back multiple times.
4 years ago
4 years ago
4 years ago
## Open Source
* **Community & support**
Pi-KVM has a large community. Join the [discord chat](https://discord.gg/bpmXfz5) if you have any questions.
4 years ago
* **Extensible**
Pi-KVM was designed as a set of microservices with a plug-in architecture. It's very easy to modify and maintain.
* **Comprehensive API**
Everything that can be done via the user interface can also be done via a powerful HTTP API.
4 years ago
* **Know-how**
We created [our very own MJPG video server](https://github.com/pikvm/ustreamer) written in C with multi-threading support and GPU video encoding - the fastest streaming solution available to provide the best video quality for Pi-KVM. We also tested a lot of hardware configurations so that you can be sure devices you assemble will work reliably.
4 years ago
</details>
4 years ago
4 years ago
-----
4 years ago
# DIY Getting Started
## Required hardware
4 years ago
Pi-KVM supports several different hardware configurations, referred to as **platforms**. Now available: **v2** and **v0**.
* **Recommended**: **v2** is the most modern implementation for **Raspberry Pi 4** and **ZeroW** supporting all of the features of Pi-KVM including the **Mass Storage Drive**. **For Raspberry Pi 4 (not for Zero), there is support for H.264 video.**. **It's also the easiest to make**.
4 years ago
* v0 was designed to work with Raspberry Pi 2 and 3 that do not have OTG and requires a few more components for a basic implementation. It also does not support the Mass Storage Drive feature.
4 years ago
4 years ago
## Hardware for v2
4 years ago
* Raspberry Pi board:
- **Recommended**: Raspberry Pi 4 (2 GB model is enough) for the best performance. However, the 1Gb models will also work (No longer sold).
4 years ago
- ... or Raspberry Pi ZeroW (slower alternative, no ethernet).
* MicroSD card (min 16 GB recommended).
* USB-A 3A charger (female socket) or official rpi recommended power supply.
4 years ago
* Video capture device:
- **Recommended**: [HDMI to CSI-2 bridge based on TC358743](https://aliexpress.com/item/4000102166176.html) - low latency, more reliable, **H.264 video**.
- ... or [HDMI to USB dongle](https://aliexpress.com/item/4001043540669.html) (not available for ZeroW) - high latency >200ms, [not very reliable](#a-few-words-about-hdmi-usb-dongle)), H.264 is not supported.
4 years ago
* Only for Raspberry Pi 4: parts for Y-splitter cable (**one variant at your choice**):
* <details><summary>:exclamation:Variant #1:exclamation:: (No mod solution) Y cable with power blocker ends.</summary>
4 years ago
<ul>
<li>1x USB-A to USB-C cable (male-male).</li>
<li>1x another cable USB-A to any (male-any).</li>
<li>1x Official Power Supply (USB-A or USB-C).</li>
<li>1x <a href="https://www.amazon.com/dp/B08C5FWQND">splitter</a> - This may need to be searched in your respecitve country.
<li><a href="https://www.amazon.com/gp/product/B092MLT2J3">USB Power Blocker</a> - Will go into the USB-A end towards the target</li>
4 years ago
</ul>
</details>
* <details><summary>:exclamation:Variant #2:exclamation:: DIY for soldering or twist.</summary>
<ul>
<li>1x USB-A to USB-C cable (male-male).</li>
<li>1x another cable USB-A to any (male-any).</li>
<li>1x Official Power Supply (USB-A or USB-C) depending on what cable you choose above.</li>
</ul>
</details>
* <details><summary>:exclamation:Variant #3:exclamation:: Ready-made using USB-micro splitter.</summary>
4 years ago
<ul>
<li>1x USB/Power Splitter Module (<a href="https://www.tindie.com/products/8086net/usbpwr-splitter">UK</a>/<a href="https://www.pishop.us/product/usb-pwr-splitter/">US</a>/<a href="https://www.buyapi.ca/product/usb-pwr-splitter/">CA</a>).</li>
<li>1x USB-A to USB-C cable (male-male) for connecting the Raspberry Pi to the splitter.</li>
<li>1x USB-A to micro USB-B cable (male-male) for connecting the server to the splitter.</li>
<li>1x USB-A to micro USB-B cable (male-male) to connect into a USB-A wall charger. Or you also can buy the official Raspberry Pi Power Supply with micro USB-B instead.</li>
4 years ago
</ul>
</details>
* <details><summary>:exclamation:Variant #4:exclamation:: Ready-made using USB-C splitter.</summary>
4 years ago
<ul>
<li>1x USB-C/Power Splitter Module (<a href="https://www.tindie.com/products/8086net/usb-cpwr-splitter">UK</a>/<a href="https://www.pishop.us/product/usb-c-pwr-splitter/">US</a>/<a href="https://www.buyapi.ca/product/usb-c-pwr-splitter/">CA</a>).</li>
<li>1x USB-C to USB-C cable (male-male) for connecting the Raspberry Pi to the splitter.</li>
<li>1x USB-A to USB-C cable (male-male) for connecting the server to the splitter.</li>
<li>1x USB-A to USB-C cable (male-male) to connect into a USB-A wall charger. Or 1x USB-C to USB-C cable to connect into a USB-C wall charger. Or you also can buy the official Raspberry Pi Power Supply with USB-C instead.</li>
4 years ago
</ul>
</details>
4 years ago
* Only for Raspberry Pi ZeroW:
* 2x USB A-to-micro cables (male-male, for power and keyboard & mouse emulator). A power splitter OR a modded cable is required for this 2x usb configuration. 1x USB A-to-Micro is ONLY needed for direct connection to the target.
* 1x [Raspberry Pi Zero Camera Cable](https://aliexpress.com/item/32953696917.html) (if using HDMI to CSI-2 Bridge, but not compatible with Auvidea B101, check pinout).
4 years ago
* For ATX control (optional):
- [4x MOSFET relays OMRON G3VM-61A1](https://www.digikey.com/products/en?keywords=G3VM-61A1).
4 years ago
- 4x 390 Ohm resistors.
- 2x 4.7k Ohm resistors.
4 years ago
- A breadboard and wires.
5 years ago
#### A few words about HDMI-USB dongle (H.264 is NOT officially supported at this time)
The dongle is completely supported and Pi-KVM works great with it. But it has some disadvantages compared with recommended [HDMI-CSI bridge](https://aliexpress.com/item/4000102166176.html): USB gives a lot of latency (200ms vs 100ms for MJPEG) and it doesn't support stream compression control (you won't be able to use Pi-KVM in a place with a poor internet connection). There is no H.264 support at the moment. It also cannot automatically detect screen resolution. All this is caused by the hardware limitations of the dongle itself. In addition, some users report hardware problems: the dongle may not work in the BIOS or simply stop working after a while. It's a black box, and no one knows what's inside it. If you have problems with it, it will not be possible to fix them.
4 years ago
4 years ago
## Hardware for v0
4 years ago
* Raspberry Pi 2 or 3.
* MicroSD card (8 GB is enough).
4 years ago
* USB-A 3A charger (female socket) or power supply.
4 years ago
* For keyboard & mouse emulator (HID):
- Arduino Pro Micro (based on an ATMega32u4).
- [Logic level shifter](https://www.sparkfun.com/products/12009).
4 years ago
- 1x NPN transistor (almost any NPN transistor: 2n2222 or similar).
4 years ago
- 1x 390 Ohm resistor.
4 years ago
- A breadboard and wires.
* 2x USB A-to-micro cables (male-male, for power and HID).
4 years ago
* HDMI capture device: [see v2 description](#hardware-for-v2).
* ATX control (optional): [see v2 description](#hardware-for-v2).
4 years ago
4 years ago
#### Addition
* If you want to capture VGA from your server instead of HDMI, buy the [VGA-to-HDMI converter](https://aliexpress.com/item/4000553298530.html).
* Pi-KVM can be powered using PoE, but it is not recommend to use the official PoE HAT: it is unreliable and [not compatible with the HDMI bridge](https://github.com/pikvm/pikvm/issues/6). Use any other PoE hat without an I2C fan controller.
* **Don't use random relay modules or random optocouplers!** Some relays or optocouplers may not be sensitive enough for the Raspberry Pi, some others may be low-level controlled. Either use relays that are activated by a high logic level, or follow the design provided and buy an OMRON. See details [here](https://github.com/pikvm/pikvm/issues/13).
4 years ago
# How to set up the device can be seen from [here](https://github.com/pikvm/pikvm/blob/master/pages/Wiring%20Examples.md)
4 years ago
3 years ago
# Pi-KVM v3 HAT Features
4 years ago
3 years ago
3 years ago
<img src="img/v3_kit.jpg" alt="drawing" height=200>
4 years ago
3 years ago
**[>>> Pi-KVM v3 HAT on Kickstarter! <<<](https://www.kickstarter.com/projects/mdevaev/pikvm-v3-hat)**
3 years ago
We have developed our own HAT for the Raspberry Pi 4. It will have all the features of the v2 platform, including:
4 years ago
3 years ago
* Fully **Open Source** software and ready-made maintainable Linux based OS.
* Access to the server via **Web UI** or **VNC**.
* **HDMI video capture** for extra low latency with **MJPEG** or **H.264/WebRTC** (1080p 50Hz max).
* **HDMI audio capture** (supported by hardware, software work in progress).
* **USB keyboard** & **mouse**, bootable **Virtual CD-ROM** & **Flash Drive**;
* Ability to simulate "**removal and insertion**" for **USB**.
* **Onboard ATX controller** to manage the server's power.
* **PWM fan controller**.
* **A real-time clock** for accurate logging.
* CISCO-style and USB **serial console port** (to manage Pi-KVM OS or to connect the server).
* Ability to use **IPMI BMC**, **IPMI SoL**, **Redfish** and **Wake-on-LAN** to control the server.
* **Extensible authorization** and **SSL encryption** out of the box.
* **Health monitoring** of the Raspberry Pi.
* Control **GPIO** ports and **USB relays** from the Web UI.
* **Bonus: It's compatible with Apple computers!**
* **Optional OLED screen** to display network status or other desired information.
* **No need for soldering or breadboarding**. It's a ready-made, reliable board which you can use yourself or provide to your clients.
Watch the video:
3 years ago
* [Pi-KVM v3 Review by **Novaspirit Tech**](https://youtu.be/dTchVKxx7Fo)
3 years ago
* [Another review by **Level1Techs**](https://www.youtube.com/watch?v=LwsznhIBPMc)
* [Review by **The Geek Freaks** (DE)](https://www.youtube.com/watch?v=fnd6wojrw3c)
3 years ago
3 years ago
**[>>> Pi-KVM v3 HAT on Kickstarter! <<<](https://www.kickstarter.com/projects/mdevaev/pikvm-v3-hat)**
4 years ago
-----
4 years ago
# Setting up the hardware
## Connecting the video capture
#### For the HDMI-CSI bridge
4 years ago
<details>
<summary>:exclamation:Click to show the instructions:exclamation:</summary>
Insert the flexible flat cable of the HDMI bridge into the narrow white connector on the Raspberry Pi (the closest one to big USB sockets). It is labeled CAMERA. To insert you need to open the connector first. On the Raspberry Pi side you can gently lift the black part up and a little bit sideways:
| Opening the MIPI CSI-2 slot on the Raspberry Pi |
| ------------------------------------------------------------------------------------------------ |
| <img src="img/open-MIPI-CSI2-Slot.png" alt="detailed picture of the MIPI-CSI2 slot" width="350"> |
For the HDMI-CSI bridge it depends on the version you bought. Either pull it gently up as on the Raspberry or push it sideways. Make sure that the cable is inserted on the correct side and until it stops, and then push the black latch back. Never connect or disconnect the flat cable from a powered device. This is not Plug-and-Play, and you can damage it. Also use only the cable that was included with the device package, or make sure that the third-party cable has the correct pinout.
| HDMI-CSI-2 bridge connected to Raspberry Pi 4 |
| ------------------------------------------------------------------------------------------------------------ |
| <img src="img/rpi4-hdmi-csi-connection.png" alt="HDMI-CSI-2 bridge connected to Raspberry Pi 4" width="350"> |
5 years ago
4 years ago
</details>
#### For the HDMI-USB dongle
4 years ago
<details>
<summary>:exclamation:Click to show the instructions:exclamation:</summary>
4 years ago
Connect USB dongle to exactly this port. It is bound in the software so the OS does not confuse the video device with something else.
4 years ago
| Raspberry Pi 2 and 3 | Raspberry Pi 4 |
| ------------------------------------------------------------- | ------------------------------------------------------------- |
4 years ago
| <img src="img/v2_usbcap_rpi2.png" alt="drawing" width="200"/> | <img src="img/v2_usbcap_rpi4.png" alt="drawing" width="200"/> |
4 years ago
4 years ago
There are many revisions of the Raspberry Pi boards and you may come across one that we haven't tested. If the binding fails, the device will be available for all ports. Everything will work, but if you use a webcam and Linux mistakes it for a dongle, [write to us](https://discord.gg/bpmXfz5) and we will fix it.
4 years ago
</details>
4 years ago
## Setting up the v2
4 years ago
<details>
<summary>:exclamation:Click to show the instructions:exclamation:</summary>
4 years ago
Here is a diagram shows that how to connect all of the pieces (click to full size).
4 years ago
| ATX control board | USB splitter cable (only for Raspberry Pi 4) |
| ------------------------------------------------- | ---------------------------------------------------------- |
4 years ago
| <img src="img/v2.png" alt="drawing" width="400"/> | <img src="img/v2_splitter.png" alt="drawing" width="400"/> |
4 years ago
3 years ago
**Raspberry Pi 4**: since one USB-C female connector is used to receive power and perform keyboard/mouse/drive emulation a special Y-cable must be made that splits the DATA and POWER lines of USB-C (see [reasons](https://github.com/pikvm/docs/issues/11)). It can be made from two suitable connecting cables, or soldered together from scratch. Be sure to check the circuit diagram below, otherwise you may damage your devices. The appropriate USB pinout(s) can easily be found on Google. Please note that if you make a Y-cable from two no-name cables, the colors of the wires may not match those shown. Use a multimeter to make sure the connections are correct.
**Raspberry Pi Zero W**: This board has two USB micro connectors: one for power supply, the second for emulating a USB OTG device. You need to prevent backpowering as in the RPi4 case. To do this, you need to cut off the red power wire in the OTG wire, or seal the +5v pin in the USB-A connector with electrical tape like this:
<img src="img/v2_tape_off.png" alt="drawing" width="300"/>
5 years ago
See video how-tos:
4 years ago
* [Making USB Y-splitter cable](https://www.youtube.com/watch?v=uLuBuQUF61o).
* [Soldering ATX controller](https://www.youtube.com/watch?v=hKnKOuH_f8M).
4 years ago
</details>
## Setting up the v0
4 years ago
<details>
<summary>:exclamation:Click to show the instructions:exclamation:</summary>
4 years ago
4 years ago
| ATX control board and Arduino HID (keyboard & mouse) |
| ---------------------------------------------------- |
| <img src="img/v0.png" alt="drawing" width="400"/> |
4 years ago
4 years ago
</details>
4 years ago
-----
4 years ago
4 years ago
# Installing the OS
4 years ago
Here the final steps. There are two ways to get the Pi-KVM OS:
* We provide the ready-made images for **Raspberry Pi 4** for platforms v3, **v2-hdmi** (the CSI-2 bridge) and **v2-hdmiusb** (the USB dongle); for **ZeroW** **v2-hdmi** [Follow these instructions](pages/flashing_os.md) to install the OS quickly.
4 years ago
* For the other boards and platforms, you need to build the operating system manually. Don't worry, it's very simple! [Just follow these instructions](pages/building_os.md). You can also build the OS for RPi4 manually if you really want to :)
5 years ago
4 years ago
# You're amazing!
- ❗NOTE❗ After performing any update of pikvm, clear web browser cache or use incognito/private browsing mode.
4 years ago
Congratulations! Your Pi-KVM will be available via SSH (`ssh root@<addr>` with password `root` by default) and HTTPS (try to open in a browser the URL `https://<addr>`, the login `admin` and password `admin` by default). For HTTPS a self-signed certificate is used by default.
4 years ago
To change the root password use command `passwd` via SSH or webterm. To change Pi-KVM web password use `kvmd-htpasswd set admin`. As indicated on the login screen use `rw` to make the root filesystem writable, before issuing these commands. After making changes, make sure to run the command `ro`.
4 years ago
4 years ago
# Access to Pi-KVM from the Internet
- ❗NOTE❗ Please take proper security precaustions when exposing this to the internet. The use of tailscale is HIGHLY suggested.
4 years ago
You can use port forwarding for port 443 on your router if it has an external IP address. In all other cases, you can use the excellent free VPN service [Tailscale](pages/tailscale.md), which is configured on Pi-KVM with a [few simple commands](pages/tailscale.md).
4 years ago
If you have any problems or questions, contact us using Discord: https://discord.gg/bpmXfz5
4 years ago
Subscribe to our Subreddit to follow news and releases: https://www.reddit.com/r/pikvm
4 years ago
Happy using of Pi-KVM :)
5 years ago
4 years ago
-----
4 years ago
# Limitations
3 years ago
* In rare cases, some very buggy BIOSes doesn't like HID and Mass Storage in a single USB device. You can either [disable Mass Storage](https://github.com/pikvm/pikvm/blob/master/pages/msd.md#disable-msd), or use [Arduino HID](https://github.com/pikvm/pikvm/blob/master/pages/arduino_hid.md) to physically separate them.
4 years ago
-----
3 years ago
# What's next?
* The Pi-KVM file system is always mounted in read-only mode. This prevents it from being damaged by a sudden power outage. To change the configuration you must first switch the filesystem to write mode using the command `rw` from root. After the changes, be sure to run the command `ro` to switch it back to read-only.
5 years ago
4 years ago
* **NEVER** edit `/etc/kvmd/main.yaml`. Use `/etc/kvmd/override.yaml` to redefine the system parameters. All other files that are also not recommended for editing have read-only permissions. If you edit any of these files, you will need to manually make changes to them when you upgrade your system. You can view the current configuration and all available KVMD parameters using the command `kvmd -m`.
5 years ago
* Almost all KVMD (the main daemon controlling Pi-KVM) configuration files use [YAML](https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html) syntax. Information on the format's syntax can be found at the link provided.
5 years ago
3 years ago
* [Disabling authorization](pages/cookbook.md#disabling-authorization).
* [Disabling ATX and hiding the menu](pages/cookbook.md#disabling-atx-and-hiding-the-menu).
* [Disabling webterm](pages/cookbook.md#disabling-webterm).
5 years ago
* [Using H.264 / WebRTC](pages/webrtc.md).
3 years ago
* [Video modes of HDMI CSI brodge (if no video in UEFI)](pages/edid.md).
3 years ago
4 years ago
* [Mouse modes (if the mouse doesn't work in UEFI)](pages/mouse.md).
3 years ago
* [Recording screen video](pages/video.md).
4 years ago
* [Multiport KVM over IP](pages/multiport.md).
3 years ago
* [Using Mass-Storage Drive](pages/msd.md).
- [Disable MSD](pages/msd.md#disable-msd).
- [Upload images manually (without Web UI)](pages/msd.md#upload-images-manually-without-web-ui).
- [Multiple and writable drives](pages/msd.md#multiple-and-writable-drives).
- [Create a Microsoft Windows based Flash disk image](pages/msd.md#create-a-microsoft-windows-based-flash-disk-image).
- [Create a drive image on macOS](pages/msd.md#create-a-drive-image-on-macos).
4 years ago
* [Using IPMI and Redfish](pages/ipmi.md).
3 years ago
* [Using Wake-on-LAN](pages/wol.md).
4 years ago
4 years ago
* [Using VNC](pages/vnc.md).
4 years ago
4 years ago
* [Using Arduino HID (for USB or PS/2) on v2 platform](pages/arduino_hid.md).
* [Using Bluetooth HID](pages/bluetooth_hid.md).
4 years ago
4 years ago
* [Wi-Fi configuration after install](pages/wifi_config.md).
4 years ago
4 years ago
* [Export monitoring metrics to Prometheus](pages/prometheus.md).
3 years ago
* [Control GPIO ports, USB relays, IPMI hosts, send Wake-on-LAN messages](pages/gpio.md).
4 years ago
4 years ago
* [Centralized authorization for multiple Pi-KVMs](https://github.com/pikvm/kvmd-auth-server).
4 years ago
* [Cookbook](pages/cookbook.md).
4 years ago
- [Take a HDMI screenshot via console on Pi-KVM](pages/cookbook.md#take-a-hdmi-screenshot-via-console-on-pi-kvm).
- [Get installed KVMD version via console](pages/cookbook.md#get-installed-kvmd-version-via-console).
- [Enable Serial-over-USB connection](pages/cookbook.md#enable-serial-over-usb-connection).
4 years ago
4 years ago
-----
# FAQ and Troubleshooting
3 years ago
If you have any questions or run into problems, take a look at [this page](pages/faq.md).
We've probably already found a solution for it :)
4 years ago
For any help, you can contact our discord chat: https://discord.gg/bpmXfz5
4 years ago
-----
4 years ago
# Donate
4 years ago
This project is developed on a non-commercial basis by Open Source enthusiasts. If you find Pi-KVM useful or it has saved you a long trip to check on an unresponsive server, you can support the lead developer by donating a few dollars via [Patreon](https://www.patreon.com/pikvm) or [PayPal](https://www.paypal.me/mdevaev). With this money, he will be able to buy new hardware (Raspberry Pi boards and other components) to test and maintain various configurations of Pi-KVM, and generally devote significantly more time to the project. At the bottom of this page are the names of all the people who have helped this project develop with their donations. Our gratitude knows no bounds!
4 years ago
If you wish to use Pi-KVM in production, we accept orders to modify it for your needs or implement custom features you require. Contact us via [live chat](https://discord.gg/bpmXfz5) or email the lead developer at: mdevaev@gmail.com
4 years ago
-----
4 years ago
# Special thanks
These kind people donated money to the Pi-KVM project and supported work on it. We are very grateful for their help, and commemorating their names is the least we can do in return.
3 years ago
<details>
<summary>View all people!</summary>
3 years ago
* A. Isenring
3 years ago
* Aaron Heise
4 years ago
* Accalia
3 years ago
* Adam Goodbar
3 years ago
* Adam S
3 years ago
* adipisicing
3 years ago
* Adrian Basham
3 years ago
* Ahmed Syed
4 years ago
* Alberto Bassi
3 years ago
* alejandro
4 years ago
* Aleksei Brusianskii
3 years ago
* Alessio Curri
3 years ago
* Alex T
3 years ago
* Alexander Martin
3 years ago
* Alexander Pankov
3 years ago
* Alexandre Jablonski
3 years ago
* Alexey Kamenskiy
3 years ago
* alm0241
3 years ago
* Alok Anand
4 years ago
* Alucard
3 years ago
* Ananthaneshan Elampoornan
3 years ago
* Andreas Marufke
3 years ago
* Andreas Schmid
3 years ago
* Andrew Melton
4 years ago
* Andrew Reusch
3 years ago
* Andrew Ruan
4 years ago
* Andrzej V
3 years ago
* Andy Keys
3 years ago
* Anish Patel
4 years ago
* Anix
3 years ago
* anonymous
3 years ago
* Anthony Junk
4 years ago
* Anton Kovalenko
3 years ago
* Armen
3 years ago
* Aron Green
4 years ago
* Aron Perelman
3 years ago
* Artem Simonov
4 years ago
* Arthur Woimbée
4 years ago
* Ashlesh Chaudhari
4 years ago
* Augusto Becciu
4 years ago
* AVS Computer
4 years ago
* baddog
4 years ago
* Bao Tin Hoang
3 years ago
* Belf Igor
4 years ago
* Ben Gordon
4 years ago
* Ben Scott
3 years ago
* Benedikt Heine
3 years ago
* Benedikt Meier
3 years ago
* Benjamin Frewert
4 years ago
* Benjamin Melancon
3 years ago
* Benni Stauder
3 years ago
* Bernhard Fitzke
3 years ago
* bikmaek
3 years ago
* bitjoe
4 years ago
* Bits and Bytes Computers LLC
3 years ago
* Bjoern Petsch
3 years ago
* Blue Frog LLC
3 years ago
* Bootstrapper - Programmierung erklärt
3 years ago
* Bosco
3 years ago
* Bradford King
4 years ago
* Brainspore Networks
4 years ago
* Branden Shaulis
3 years ago
* Brandon Daniels
3 years ago
* Brian Moses
4 years ago
* Brian Vecchiarelli
4 years ago
* Brian White
4 years ago
* Bruno Gomes
4 years ago
* Bryan Adams
3 years ago
* Bryan Montgomery
3 years ago
* C P ELSE
3 years ago
* Cameron Tacklind
4 years ago
* Carl Mercier
3 years ago
* Carl-Fredrik Johansson
3 years ago
* Carlos Manuel Torres
3 years ago
* cbad536
3 years ago
* CHINATERA LIMITED
4 years ago
* Chris Burton
3 years ago
* Chris Jackson
3 years ago
* Chris Lewis
3 years ago
* Chris Rizio
4 years ago
* Christian Schlögl
3 years ago
* Christian Svensson
4 years ago
* Christoph Dette
4 years ago
* Christof Maluck
4 years ago
* Christoffer Lund
3 years ago
* Christopher Hearn
3 years ago
* Christopher Mandlbaur
3 years ago
* Christopher Simms
3 years ago
* Chucktastic
3 years ago
* clauskj3r
4 years ago
* Clifford Coleman
4 years ago
* Clinton Lee Taylor
3 years ago
* Cole Imhoff
3 years ago
* Colin Goodman
3 years ago
* Corey Layton
* Corey Lista
3 years ago
* Craig Keenan
3 years ago
* Crossfactor
3 years ago
* ctag
3 years ago
* Curt Sammer
3 years ago
* CyB0rgg
3 years ago
* DeMentor
3 years ago
* Desmond Whitt
4 years ago
* Damon Meledones
3 years ago
* Dan Berkowitz
4 years ago
* Dan Brakeley
3 years ago
* Daniel Cabrera
3 years ago
* Daniel Davila
3 years ago
* David
3 years ago
* David Godibadze
4 years ago
* David Howell
3 years ago
* David Irvine
3 years ago
* David Klinkman
3 years ago
* David Niemann
3 years ago
* David Shay
3 years ago
* David Ye
3 years ago
* David York
3 years ago
* Denis
4 years ago
* Denis Andreev
4 years ago
* Denis Yatsenko
3 years ago
* Dennis Becker
3 years ago
* Dennis Joslin
3 years ago
* Dennis Lomet
3 years ago
* Derek Yap
3 years ago
* Didrik
3 years ago
* Dimitrij Jedich
4 years ago
* dixon wong
3 years ago
* dizztrukshin
4 years ago
* Dmitry Shilov
3 years ago
* Dominik Klonowski
3 years ago
* Egan Ford
3 years ago
* Elani Ferri
3 years ago
* Elliot Woo
4 years ago
* Eric Phenix
4 years ago
* ewook
3 years ago
* eye-catcher.com
3 years ago
* Fabiano Sidler
3 years ago
* Far Pin Solutions, LLC
3 years ago
* Felyx Gabryel
4 years ago
* Fergus McKay
3 years ago
* Finn Ebenritter
3 years ago
* fo0bar
4 years ago
* Foamy
3 years ago
* Foli Ayivoh
3 years ago
* Folkert Weistra
4 years ago
* Francisco Pavon
3 years ago
* Frank
3 years ago
* Frederick Czajka
4 years ago
* Fredrik Idréus
3 years ago
* Garrett Dangerfield
4 years ago
* Ge Men
3 years ago
* Genkinger Andreas
3 years ago
* Georgy Brodsky
3 years ago
* Gerald
3 years ago
* Gernot Neuschröer
3 years ago
* Giovanni Fulco
3 years ago
* GK
3 years ago
* Glen Dragon
3 years ago
* Greg Winterstein
3 years ago
* Gregory Smith
3 years ago
* Gregory Treantos
4 years ago
* Grey Cynic
4 years ago
* Guido Bernacchi
3 years ago
* Gustin Johnson
3 years ago
* György Tamás Vizi
3 years ago
* Heibunny
4 years ago
* Heikki Tiittanen
3 years ago
* Helio Leonardo Pinheiro e Mota
3 years ago
* Henrik Ählström
4 years ago
* Henry Hood
4 years ago
* HimKo
3 years ago
* HouseFPV
3 years ago
* Icculus
4 years ago
* iks
3 years ago
* Invader Monks
3 years ago
* IT Lifesaver
3 years ago
* Ivan Ganev
4 years ago
* Ivan Shapovalov
3 years ago
* J L
3 years ago
* Jaanus
3 years ago
* Jackson Wyatt
3 years ago
* Jacob Karaffa
4 years ago
* Jacob Morgan
4 years ago
* James Cadd
4 years ago
* James Cobb
3 years ago
* James Edwards
3 years ago
* James Kocher
3 years ago
* James Mayhugh
3 years ago
* James Ye
4 years ago
* Jamie Murphy
3 years ago
* Jamie Scott
4 years ago
* Jan Niehusmann
4 years ago
* Jari Hiltunen
3 years ago
* Jason Crossley
4 years ago
* Jason Downey
4 years ago
* Jason Toland
3 years ago
* Jasper Backer
4 years ago
* Jay Davis
3 years ago
* Jay Isaacs
3 years ago
* Jazereel Goh
3 years ago
* Jean-Daniel Croteau
3 years ago
* Jean-Philippe Guilbault
3 years ago
* Jeff
4 years ago
* Jeff Bowman
3 years ago
* Jeff Urlwin
3 years ago
* Jennifer Herting
4 years ago
* Jennifer Rowlett
4 years ago
* Jerremy Holland
3 years ago
* Jerry Nall
3 years ago
* Jim Harbin
3 years ago
* Jimmy Stanley
4 years ago
* Joachim Bruening
3 years ago
* Joe Hanson
3 years ago
* Joe Hinteregger
3 years ago
* Joe Ventura
3 years ago
* Joel Jacobs
3 years ago
* John Andersen
3 years ago
* John Copeland
4 years ago
* John F Glenn
4 years ago
* John Kelley
4 years ago
* John McGovern
3 years ago
* Johnny Henson
3 years ago
* Jon Ferguy
3 years ago
* Joni Ruuskanen
3 years ago
* Jonathan Slenders
4 years ago
* Jonathan Vaughn
3 years ago
* Joost Backer
4 years ago
* Josh Ricker
3 years ago
* Joshua Futterer
4 years ago
* Jordi Pakey-Rodriguez
4 years ago
* Joris van Embden
4 years ago
* Jozef Riha
3 years ago
* Jörgen Fredriksson
4 years ago
* Julian Forero
3 years ago
* Julian Schneider
4 years ago
* Justin Waters
3 years ago
* Kai Hadler
3 years ago
* Karl Dunne
3 years ago
* Keith Muggleton
3 years ago
* Ken Lee
3 years ago
* Kenneth Younger III
3 years ago
* Kenny Hui
3 years ago
* Kevin Bajohr
3 years ago
* Kevin Schwartz
3 years ago
* Kevin Sherwood
3 years ago
* Kiran Schuler
3 years ago
* Koloman
3 years ago
* Konrad Neitzel
4 years ago
* Krzysztof Żelaśkiewicz
3 years ago
* Lance Ward
3 years ago
* Larry Meaney
4 years ago
* Lars
3 years ago
* Lee Wilkinson
4 years ago
* LeeNX
3 years ago
* Leonard Feineis
3 years ago
* Lizardo Hernandez
3 years ago
* LoCascio
3 years ago
* Lordbob75
4 years ago
* Lothar Schweikle-Droll
3 years ago
* Louis Müller
3 years ago
* LSDTripp
3 years ago
* Luca Di Diomede
3 years ago
* Lucio De Carli
3 years ago
* Lukas Bischof
3 years ago
* Lukas Kammerer
4 years ago
* Lukas Söder
4 years ago
* Malcolm Cameron
3 years ago
* Manfred Radeschnig
3 years ago
* Marc Khouri
3 years ago
* Marcin Wilk
3 years ago
* Marcio Zimbres
3 years ago
* Marco Rossi
4 years ago
* Marcos Wolf
3 years ago
* Marek Marczykowski-Górecki
3 years ago
* Marius
3 years ago
* Mar. Balske
4 years ago
* Mark Gilbert
3 years ago
* Mark Knam
4 years ago
* Mark Robinson
3 years ago
* Markrosoft
3 years ago
* Markus Halm
4 years ago
* Markus Schicker
4 years ago
* Markus Sobczack
3 years ago
* Marshall Bjerke
4 years ago
* Marten Hermans
4 years ago
* Martin Gasser
3 years ago
* Martin Suelmann
3 years ago
* Marvin Honderboom
4 years ago
* Mateusz Grabowski
4 years ago
* Matthew Cameron
4 years ago
* Mauricio Allende
3 years ago
* Mecky
4 years ago
* Mehmet Aydoğdu
3 years ago
* Michael Bombe
3 years ago
* Michael Collins
3 years ago
* Michael Copeland
4 years ago
* Michael Kovacs
* Michael Lynch
3 years ago
* Michael Pennington
4 years ago
* Michael Sage
3 years ago
* MichaelZ
3 years ago
* Michel Bissonnette
3 years ago
* Mikael Wikström
3 years ago
* Mike Mason
3 years ago
* Milan Múčka
4 years ago
* Miles Davis
3 years ago
* Minh Tang
3 years ago
* Moez Tharani
4 years ago
* Morgan Helton
3 years ago
* Myron Weber
3 years ago
* Nathaniel Griswold
3 years ago
* Nelson Lee
4 years ago
* Nicholas Jeppson
3 years ago
* Nicholas Kopas
3 years ago
* Nicholas Walczak
4 years ago
* Nick Leffler
4 years ago
* Nick Roethemeier
3 years ago
* Nico Baumgartner
3 years ago
* Nicolai Kragh-Hansen
* Nihal Fernando
4 years ago
* Nils Orbat
3 years ago
* Nis Wechselberg
4 years ago
* Nithin Philips
4 years ago
* Nod Swal
3 years ago
* Nolan Haynes
3 years ago
* nubbn
4 years ago
* nybble
4 years ago
* Oh Be
3 years ago
* Oliver Schwarz
3 years ago
* Oliver Zimmer
3 years ago
* Omar El-Domeiri
3 years ago
* Omar Siam
3 years ago
* Oscar
3 years ago
* Patrick
3 years ago
* Patrick Fortin-Ducharme
3 years ago
* Patrick McDowell
3 years ago
* Patrick Wagstrom
4 years ago
* Paul Bishop
3 years ago
* Paul De La Rosa
3 years ago
* Paul Pietkiewicz
3 years ago
* Pawel Trofimiuk
3 years ago
* Peder Madsen
3 years ago
* Peter
3 years ago
* Peter Drayton
3 years ago
* Peter Farrelly
3 years ago
* Peter Okelmann
3 years ago
* Petri Heiskanen
3 years ago
* Phil Wu
3 years ago
* Philip Edwards
4 years ago
* Philip Merricks
4 years ago
* posicat
4 years ago
* pozitron03
3 years ago
* Qteal
4 years ago
* Quentin Peten
3 years ago
* Ralph Borchers
4 years ago
* Ranc1d
3 years ago
* Randall D Bilbrey
3 years ago
* Raphael Schitz
4 years ago
* Richard Bernarts
3 years ago
* Richard Fancher
4 years ago
* Richard Freemantle
3 years ago
* Richard Michael
3 years ago
* Rico Cantrell
3 years ago
* Rob Tongue
3 years ago
* Robert Klauco
4 years ago
* Robin Gfatter
3 years ago
* Rodion DENISYUK
3 years ago
* Rohit Priyadarshi
3 years ago
* Rolfs 3D UG
3 years ago
* Ronald LeBaron
3 years ago
* Ronald Wells
3 years ago
* Ronny Haldorsen
3 years ago
* rotx
3 years ago
* Russell Scott
3 years ago
* Ryan Peacock
4 years ago
* Samed Ozoglu
3 years ago
* Sameul Davies
3 years ago
* Samuel Vetsch
3 years ago
* Samuel Walker
3 years ago
* Sarah Foster
3 years ago
* Sarten X
3 years ago
* Satish Alwani
4 years ago
* Scott
3 years ago
* Scott Gagon
4 years ago
* Scott Spicola
3 years ago
* Scott Tusing
3 years ago
* Sean
4 years ago
* Seonwoo Lee
4 years ago
* Sergey Lukjanov
3 years ago
* Seth Jennings
3 years ago
* Sheran Gunasekera
4 years ago
* Shichun Chen
3 years ago
* Shin Guey Wong
3 years ago
* Simon Evans
3 years ago
* Simon Sundgaard
4 years ago
* Simplistic Realities
3 years ago
* Solve Technology
3 years ago
* srepac
4 years ago
* Stefan Bautz
4 years ago
* Stefan Müller
4 years ago
* Stefan Stemmer
3 years ago
* Stefan Vaillant
3 years ago
* Stephan Schmidt
3 years ago
* Stephen Hocking
3 years ago
* Steve Jones
3 years ago
* Steve Kerr
4 years ago
* Steve Ovens
3 years ago
* Steve Stringham
4 years ago
* Steven Richter
3 years ago
* Stratagem Solutions Ltd
3 years ago
* Sven Breckler
3 years ago
* sudo34
3 years ago
* Tango_Echo_Alpha
3 years ago
* Tarlak Desaydrone
3 years ago
* TechBear
3 years ago
* Ted
4 years ago
* Tejun Heo
3 years ago
* TheSnowedOne
3 years ago
* TheTechGiant
3 years ago
* Thomas Hagenmaier
3 years ago
* Thomas Price
4 years ago
* Thomas Søfteland
3 years ago
* Tim Lenz
3 years ago
* Tim Wilkinson
3 years ago
* Timo Brinkmann
4 years ago
* Timothee Besset
3 years ago
* Tom Lawson
3 years ago
* Tom York
4 years ago
* Tomas Kuchta
4 years ago
* Tomáš hrubý
3 years ago
* Torsten Droste
3 years ago
* Tobias Schafferhans
4 years ago
* Tristan Schoening
4 years ago
* Truman Kilen
3 years ago
* turbochris
3 years ago
* tutanak
4 years ago
* Tyler
4 years ago
* Udo Schroeter
3 years ago
* Uli Fahrer
3 years ago
* Vasily Lazarev
3 years ago
* Vicente Salvador Cubedo
3 years ago
* Vidru Eduard
3 years ago
* Viktor Aschenbrenner
3 years ago
* Viktor Ekmark
4 years ago
* Walter_Ego
3 years ago
* Will Froning
3 years ago
* William Hooper
4 years ago
* William Stearns
3 years ago
* Yethal
3 years ago
* Yevgeniy Kuksenko
3 years ago
* Yogi
3 years ago
* Yigal Dar
4 years ago
* YURI LEE
4 years ago
* Yurii Ostapchuk
4 years ago
* zgen
3 years ago
* Zoltan Magyari
4 years ago
* Zsombor Vari
3 years ago
</details>