public_git
/
pikvm
mirror of https://github.com/pikvm/pikvm.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Cosmetic fixes to V3 and V4 guides

This commit is contained in:
Aleksandr Prokudin 2025-04-27 19:56:01 +02:00
parent 3bda5fe5ac
commit 044e996e4b
2 changed files with 16 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/v3.md
View File

@ -5,13 +5,18 @@ description: Getting started with PiKVM V3 & pre-assembled
# PiKVM V3 HAT & pre-assembled quick start # PiKVM V3 HAT & pre-assembled quick start
<img src="assembled.jpg" width="400" /> ![PiKVM V3 HAT](assembled.jpg "PiKVM V3 HAT")
PiKVM is a feature-rich, production grade, open-source, Raspberry Pi based KVM over IP device. It allows you to turn on/off or restart your computer, configure the UEFI/BIOS, and even reinstall the OS using the Virtual CD-ROM or Flash Drive. PiKVM is a feature-rich, production grade, open-source, Raspberry Pi based KVM over IP device. It allows you to turn on/off or restart your computer, configure the UEFI/BIOS, and even reinstall the OS using the Virtual CD-ROM or Flash Drive.
You can use your remote keyboard and mouse or PiKVM can simulate a keyboard, mouse, and a monitor, which are then presented in a web browser as if you were working on a remote system directly. You can use your remote keyboard and mouse or PiKVM can simulate a keyboard, mouse, and a monitor, which are then presented in a web browser as if you were working on a remote system directly.
PiKVM V3 is available as an assembly kit (HAT) and as a pre-assembled unit in a metallic box. The two versions have the same ports and functionality. PiKVM V3 is available in two version:
- An assembly kit (HAT).
- A pre-assembled unit in a metallic box.
The two versions have the same ports and functionality.
## What's in the box ## What's in the box
@ -90,13 +95,13 @@ Once you have that, do the following:
## Wiring ## Wiring
Both the HAT and the pre-assembled version require several items available separately: Both the HAT and the pre-assembled V3 require several items available separately:
- Ethernet cable - Ethernet cable
- Optional RJ-45 cable for ATX - RJ-45 cable for ATX (optional)
- USB-C cable - USB-C cable
- HDMI cable - HDMI cable
- USB power adapter - 5V USB power adapter
Let's connect all the wires before you power up the device. Let's connect all the wires before you power up the device.
@ -118,8 +123,6 @@ V3 comes has a USB-C 5V power supply. Attach the appropriate connector on the **
After turning on the power, PiKVM OS generates unique SSH keys and certificates and performs all necessary operations on the memory card. It takes a few minutes. Do **not** turn off the device until it's fully booted for the first time. Once it's done, the PiKVM will show a greeting on the built-in display. After turning on the power, PiKVM OS generates unique SSH keys and certificates and performs all necessary operations on the memory card. It takes a few minutes. Do **not** turn off the device until it's fully booted for the first time. Once it's done, the PiKVM will show a greeting on the built-in display.
![MISSING GREETING IMAGE](greeting.jpg)
## Connect and set up ## Connect and set up
### Configure the display ### Configure the display
@ -259,7 +262,6 @@ For security's sake, it's best to change the default passwords immediately after
- Set up [ATX connection](atx_board.md). - Set up [ATX connection](atx_board.md).
- Set up [USB 3.0](usb3v4.md) - Set up [USB 3.0](usb3v4.md)
-----
## Known issues and limitations ## Known issues and limitations
* **Max resolution**. PiKVM V3 supports maximum resolution 1920x1080@50Hz, 60Hz will not work. You can use any other resolution less than the specified one, for example: 1600x1200@60Hz, 1280x720@60Hz, etc. If you have problems with the video, follow [this guide](edid.md). * **Max resolution**. PiKVM V3 supports maximum resolution 1920x1080@50Hz, 60Hz will not work. You can use any other resolution less than the specified one, for example: 1600x1200@60Hz, 1280x720@60Hz, etc. If you have problems with the video, follow [this guide](edid.md).
@ -323,7 +325,6 @@ The standard Raspberry Pi HDMI output (marked as `VIDEO OUT` on the PiKVM case)
{!_basic_troubleshooting.md!} {!_basic_troubleshooting.md!}
-----
## Getting user support ## Getting user support
If something doesn't work, check out our [FAQ](faq.md). Otherwise, head straight to our [Discord chat](https://discord.gg/bpmXfz5). If something doesn't work, check out our [FAQ](faq.md). Otherwise, head straight to our [Discord chat](https://discord.gg/bpmXfz5).

20
docs/v4.md
View File

@ -5,7 +5,7 @@ description: Getting started with PiKVM V4 Mini & Plus
# PiKVM V4 Mini & Plus quick start # PiKVM V4 Mini & Plus quick start
![PiKVM V4 Mini & Plus](overview.jpg) ![PiKVM V4 Mini & Plus](overview.jpg "PiKVM V4 Mini (left) & Plus (right)")
PiKVM is a feature-rich, production grade, open-source, Raspberry Pi based KVM over IP device. It allows you to turn on/off or restart your computer, configure the UEFI/BIOS, and even reinstall the OS using the Virtual CD-ROM or Flash Drive. PiKVM is a feature-rich, production grade, open-source, Raspberry Pi based KVM over IP device. It allows you to turn on/off or restart your computer, configure the UEFI/BIOS, and even reinstall the OS using the Virtual CD-ROM or Flash Drive.
@ -17,8 +17,6 @@ You can use your remote keyboard and mouse or PiKVM can simulate a keyboard, mou
## What's in the box ## What's in the box
![MISSING TOP VIEW IMAGE](v4-in-the-box.jpg)
- PiKVM V4 Mini or Plus device - PiKVM V4 Mini or Plus device
- Micro SD card with pre-imaged PiKVM software - Micro SD card with pre-imaged PiKVM software
- ATX control board - ATX control board
@ -112,8 +110,6 @@ Attach the appropriate connector on the **front** side. Do **not** block the ven
After turning on the power, PiKVM OS generates unique SSH keys and certificates and performs all necessary operations on the memory card. It takes a few minutes. Do **not** turn off the device until it's fully booted for the first time. Once it's done, the PiKVM will show a greeting on the built-in display. After turning on the power, PiKVM OS generates unique SSH keys and certificates and performs all necessary operations on the memory card. It takes a few minutes. Do **not** turn off the device until it's fully booted for the first time. Once it's done, the PiKVM will show a greeting on the built-in display.
![MISSING GREETING IMAGE](greeting.jpg)
## Connect and set up ## Connect and set up
### Configure the display ### Configure the display
@ -247,20 +243,16 @@ For security's sake, it's best to change the default passwords immediately after
Then run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the device. Then run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the device.
## Basic troubleshooting
{!_basic_troubleshooting.md!}
-----
## Getting user support
-----
## Known issues and limitations ## Known issues and limitations
* There may be compatibility issues with some motherboards, such as **HP** or **DELL**. If there is no image from the BIOS, you can fine-tune the HDMI settings, but it is possible that the mass storage devices will not be available in the BIOS. In the latter case, [USB dynamic configuration](usb.md) will solve the problem. * There may be compatibility issues with some motherboards, such as **HP** or **DELL**. If there is no image from the BIOS, you can fine-tune the HDMI settings, but it is possible that the mass storage devices will not be available in the BIOS. In the latter case, [USB dynamic configuration](usb.md) will solve the problem.
* While there is a Mini-PCIe slot in the V4 Plus, it was only designed for LTE modems. An NVME card will not work. * While there is a Mini-PCIe slot in the V4 Plus, it was only designed for LTE modems. An NVME card will not work.
----- ## Basic troubleshooting
{!_basic_troubleshooting.md!}
## Getting user support ## Getting user support
If something doesn't work, check out our [FAQ](faq.md). Otherwise, head straight to our [Discord chat](https://discord.gg/bpmXfz5). If something doesn't work, check out our [FAQ](faq.md). Otherwise, head straight to our [Discord chat](https://discord.gg/bpmXfz5).