mirror of https://github.com/pikvm/pikvm.git
Add missing front matter, part 2 of 2
This commit is contained in:
Aleksandr Prokudin
parent
165aa6d3a3
commit
7a3762044a
|
|
@ -1,4 +1,7 @@
|
|||
# Bluetooth HID
|
||||
---
|
||||
title: Bluetooth HID
|
||||
description: How to configure PiKVM to emulate a Bluetooth keyboard & mouse
|
||||
---
|
||||
|
||||
PiKVM is able to emulate a Bluetooth keyboard & mouse.
|
||||
This is not the main case of using PiKVM since you still need it to pair with a remote host, but can be used for something like mobile KVM.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,7 @@
|
|||
# Building PiKVM OS
|
||||
---
|
||||
title: Building PiKVM OS
|
||||
description: How to build PiKVM OS from source code with Docker
|
||||
---
|
||||
|
||||
The assembly of PiKVM OS is carried out using a special build environment.
|
||||
Here the minimum required for its use, imposed on the build machine:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,7 @@
|
|||
# Cloudflare Tunnels
|
||||
---
|
||||
title: Cloudflare tunnels
|
||||
description: How to configure Cloudflare tunnels for your PiKVM
|
||||
---
|
||||
|
||||
!!! warning
|
||||
This is unofficial instructions proposed by the community. We don't officially support this and don't know what problems may arise when using cloudflared.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,7 @@
|
|||
# EDID
|
||||
---
|
||||
title: EDID
|
||||
description: How to manipulate the EDID information on your PiKVM
|
||||
---
|
||||
|
||||
!!! info
|
||||
|
||||
|
|
|
|||
|
|
@ -1,11 +1,20 @@
|
|||
# ezCoo managed multiport KVM switch
|
||||
---
|
||||
title: ezCoo managed multiport KVM switch
|
||||
description: The ezCoo managed switch can be controlled by PiKVM to allow it to connect to multiple hosts
|
||||
---
|
||||
|
||||
!!! warning
|
||||
While we provide this document for your convenience, this is a third-party hardware device in the same path as a PiKVM. Therefore, you may need to experiment (trial and error) to get it to work how you like. In the case of the U3P (hot key version), it may or may not work as expected.
|
||||
|
||||
{!_multiport_usb.md!}
|
||||
|
||||
The ezCoo managed switch can be controlled by PiKVM to allow it to connect to multiple hosts. A typical scenario is a single PiKVM device which can control and switch between multiple hosts or servers using the ezCoo switch. UI elements can be added to the [GPIO dropdown](gpio.md) to allow switching between hosts from the PiKVM webpage. The instructions here were tested with the ~~[ezCoo SW41HA HDMI 4x1 switch](https://www.easycoolav.com/products/hdmi20-switch-4x1-with-usb20-kvm-4-port-usbsupport-4k60hz-444-and-hdr-audio-breakout)~~ [ezCoo EZ-SW41HA-KVMU3L 4x1 switch](https://www.easycoolav.com/products/hdmi20-switch-4x1-with-usb30-kvm-3-port-usbsupport-4k60hz-444-and-hdr-audio-breakout-36) OR [ezCoo EZ-SW41HA-KVMU3P 4x1 switch](https://www.amazon.com/gp/product/B09ZKZK7ZB). Both older USB2.0 and newer USB3.0 variants are supported. The following was testing on a Raspberry Pi 4 but should also work on the Pi 2 and 3. This document was created using the contributions from multiple users in our [Discord](https://discord.gg/bpmXfz5) and the author appreciates their efforts.
|
||||
The ezCoo managed switch can be controlled by PiKVM to allow it to connect to multiple hosts. A typical scenario is a single PiKVM device which can control and switch between multiple hosts or servers using the ezCoo switch. UI elements can be added to the [GPIO dropdown](gpio.md) to allow switching between hosts from the PiKVM webpage.
|
||||
|
||||
The instructions here were tested with the ~~[ezCoo SW41HA HDMI 4x1 switch](https://www.easycoolav.com/products/hdmi20-switch-4x1-with-usb20-kvm-4-port-usbsupport-4k60hz-444-and-hdr-audio-breakout)~~ [ezCoo EZ-SW41HA-KVMU3L 4x1 switch](https://www.easycoolav.com/products/hdmi20-switch-4x1-with-usb30-kvm-3-port-usbsupport-4k60hz-444-and-hdr-audio-breakout-36) OR [ezCoo EZ-SW41HA-KVMU3P 4x1 switch](https://www.amazon.com/gp/product/B09ZKZK7ZB).
|
||||
|
||||
Both older USB2.0 and newer USB3.0 variants are supported. The following was testing on a Raspberry Pi 4 but should also work on the Pi 2 and 3.
|
||||
|
||||
This document was created using the contributions from multiple users in our [Discord](https://discord.gg/bpmXfz5) and the author appreciates their efforts.
|
||||
|
||||
!!! info
|
||||
While most images of the switch do not show the sides, there is a Micro USB port on the side of the ezCoo switch. This is the management port, which is controlled via COM port on the ezCoo KVM. When plugged into the Raspberry Pi, it appears as `/dev/ttyUSB0`.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,11 @@
|
|||
# FAQ & Troubleshooting
|
||||
---
|
||||
title: FAQ & Troubleshooting
|
||||
description: Frequently asked questions and troubleshooting for your PiKVM
|
||||
---
|
||||
|
||||
As a first step, we recommend carefully reading our documentation on [GitHub](https://github.com/pikvm/pikvm) or the updated [documentation](https://docs.pikvm.org). Most steps to successfully set up your PiKVM are already described there. If you run into any issues you can check this page which will list common errors. If that still doesn't help you you're welcome to raise an [issue ticket](https://github.com/pikvm/pikvm/issues) or [join our Discord](https://discord.gg/bpmXfz5) for further help.
|
||||
As a first step, we recommend carefully reading our documentation on [GitHub](https://github.com/pikvm/pikvm) or the updated [documentation](https://docs.pikvm.org). Most steps to successfully set up your PiKVM are already described there.
|
||||
|
||||
If you run into any issues you can check this page which will list common errors. If that still doesn't help you you're welcome to raise an [issue ticket](https://github.com/pikvm/pikvm/issues) or [join our Discord](https://discord.gg/bpmXfz5) for further help.
|
||||
|
||||
|
||||
## Common questions
|
||||
|
|
|
|||
|
|
@ -1,4 +1,7 @@
|
|||
# Flashing PiKVM OS image
|
||||
---
|
||||
title: Flashing PiKVM OS image
|
||||
description: How to flash a PiKVM OS image to an SD card
|
||||
---
|
||||
|
||||
!!! warning "Micro-SD Card Requirements"
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,7 @@
|
|||
# GPIO
|
||||
---
|
||||
title: GPIO
|
||||
description: "How to use GPIO on a PiKVM: drivers, configuration, modules, and more"
|
||||
---
|
||||
|
||||
[GPIO (general-purpose input/output)](https://en.wikipedia.org/wiki/General-purpose_input/output) is a series of digital interfaces that can be used to connect relays, LEDs, sensors, and other components.
|
||||
|
||||
|
|
|
|||
11
docs/id.md
11
docs/id.md
|
|
@ -1,7 +1,12 @@
|
|||
# Identifying PiKVM on the target host
|
||||
---
|
||||
title: Identifying PiKVM on the target host
|
||||
description: How PiKVM is presented to the target host's operating system, and how this can be changed
|
||||
---
|
||||
|
||||
This page explains how PiKVM is presented to the target host's operating system, and how this can be changed.
|
||||
This is useful for developers, testers and system administrators who need PiKVM to emulate a specific USB device or monitor.
|
||||
This page explains how PiKVM is presented to the target host's operating
|
||||
system, and how this can be changed. This is useful for developers,
|
||||
testers and system administrators who need PiKVM to emulate a specific
|
||||
USB device or monitor.
|
||||
|
||||
!!! info
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,14 @@
|
|||
# PiKVM Handbook
|
||||
---
|
||||
title: PiKVM Handbook
|
||||
description: Comprehensive guide to configuring and using your PiKVM
|
||||
---
|
||||
|
||||
**Welcome to the [PiKVM](https://pikvm.org) Handbook** - a complete documentation of the Open Source KVM over IP on Raspberry Pi!
|
||||
|
||||
Here you will find comprehensive information about all aspects of the operation of PiKVM, get answers to your most difficult questions
|
||||
and be able to solve the problems that have arisen.
|
||||
**Welcome to the [PiKVM](https://pikvm.org) Handbook**—a complete
|
||||
documentation of the Open-Source KVM-over-IP on Raspberry Pi!
|
||||
|
||||
Here you will find comprehensive information about all aspects of the
|
||||
operation of PiKVM, get answers to your most difficult questions and be
|
||||
able to solve the problems that have arisen.
|
||||
|
||||
## Where to start?
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,7 @@
|
|||
# IPMI & Redfish
|
||||
---
|
||||
title: IPMI & Redfish
|
||||
description: How to use IPMI and Redfish for remote PiKVM management
|
||||
---
|
||||
|
||||
!!! info
|
||||
This page is about the server-side IPMI emulation if you want to manage PiKVM using `ipmitool` or something similar.
|
||||
|
|
|
|||
|
|
@ -1,9 +1,15 @@
|
|||
# Let's Encrypt certificates
|
||||
---
|
||||
title: Let's Encrypt certificates
|
||||
description: How to use Let's Encrypt certificates instead of the default self-signed SSL certificates on your PiKVM
|
||||
---
|
||||
|
||||
PiKVM uses self-signed SSL certificates out of the box. If you have a domain name, you can use Let's Encrypt certificates.
|
||||
PiKVM uses self-signed SSL certificates out of the box. If you have a
|
||||
domain name, you can use Let's Encrypt certificates.
|
||||
|
||||
Usually Let's Encrypt certificates are issued and updated automatically using Certbot, however, since PiKVM uses a read-only
|
||||
file system, special tools around Certbot are required to work with certificates. KVMD 3.117 provides them.
|
||||
Usually Let's Encrypt certificates are issued and updated automatically
|
||||
using Certbot, however, since PiKVM uses a read-only file system,
|
||||
special tools around Certbot are required to work with certificates.
|
||||
KVMD 3.117 provides them.
|
||||
|
||||
!!! note
|
||||
This feature is available on images as old as 2022.06.19 since it requires [PST storage partition on SD card](pst.md).
|
||||
|
|
|
|||
|
|
@ -1,16 +1,17 @@
|
|||
# Setting up 3G/4G/LTE modem
|
||||
|
||||
With PiKVM, you can create a portable device to work in a distant environment without
|
||||
a permanent wired internet connection. A cellular modem in combination with any VPN
|
||||
like [Tailscale](tailscale.md) is also an excellent backup for emergency access to the host.
|
||||
---
|
||||
title: Setting up 3G/4G/LTE modem
|
||||
description: How to configure a 3G/4G/LTE modem to connect to Internet without a permanent wired network access
|
||||
---
|
||||
|
||||
With PiKVM, you can create a portable device to work in a distant
|
||||
environment without a permanent wired internet connection. A cellular
|
||||
modem in combination with any VPN like [Tailscale](tailscale.md) is also
|
||||
an excellent backup for emergency access to the host.
|
||||
|
||||
-----
|
||||
## Choosing a modem
|
||||
|
||||
PiKVM supports a huge number of USB modems.
|
||||
If the modem works with a desktop Linux, it will work with PiKVM as well.
|
||||
|
||||
PiKVM supports a huge number of USB modems. If the modem works with a desktop Linux, it will work with PiKVM as well.
|
||||
|
||||
### Mini-PCI on PiKVM V4 Plus
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,7 @@
|
|||
# Big DVD images on old PiKVM
|
||||
---
|
||||
title: Big DVD images on old PiKVM
|
||||
description: If you need to emulate DVD images on an old PiKVM, here is how you can do it
|
||||
---
|
||||
|
||||
Since KVMD 4.49, PiKVM is able to emulate DVD images.
|
||||
|
||||
|
|
|
|||
14
docs/ocr.md
14
docs/ocr.md
|
|
@ -1,8 +1,14 @@
|
|||
# OCR
|
||||
---
|
||||
title: OCR
|
||||
description: How to install optical character recognition data for Tesseract
|
||||
---
|
||||
|
||||
This feature allows you to select a screen region, recognize it as text and copy this text to the clipboard.
|
||||
Recognition works locally on your PiKVM and does not use any cloud services. It uses the [Tesseract OCR library](https://github.com/tesseract-ocr/tesseract).
|
||||
Tesseract does not see your image until you explicitly give the recognition command. The evil AI is not watching your screen.
|
||||
This feature allows you to select a screen region, recognize it as text
|
||||
and copy this text to the clipboard. Recognition works locally on your
|
||||
PiKVM and does not use any cloud services. It uses the [Tesseract OCR
|
||||
library](https://github.com/tesseract-ocr/tesseract). Tesseract does not
|
||||
see your image until you explicitly give the recognition command. The
|
||||
evil AI is not watching your screen.
|
||||
|
||||
## Language support
|
||||
|
||||
|
|
|
|||
|
|
@ -1,14 +1,19 @@
|
|||
# On-boot configuration & production deployment
|
||||
---
|
||||
title: On-boot configuration & production deployment
|
||||
description: How to configure parameters that are applied the first time a PiKVM is booted
|
||||
---
|
||||
|
||||
At the first boot, PiKVM generates encryption keys and performs other actions necessary to configure the device.
|
||||
At the first boot, PiKVM generates encryption keys and performs other
|
||||
actions necessary to configure the device.
|
||||
|
||||
Some parameters, such as connecting to Wi-Fi, or configuring a static interface for wired Ethernet,
|
||||
can be easily changed by the user if there is physical access to the memory card.
|
||||
This is convenient for quick customization of your device before the first use.
|
||||
|
||||
All settings are made using a file `pikvm.txt` on the first section of the memory card.
|
||||
After applying the settings, the file is automatically deleted.
|
||||
Some parameters, such as connecting to Wi-Fi, or configuring a static
|
||||
interface for wired Ethernet, can be easily changed by the user if there
|
||||
is physical access to the memory card. This is convenient for quick
|
||||
customization of your device before the first use.
|
||||
|
||||
All settings are made using a file `pikvm.txt` on the first section of
|
||||
the memory card. After applying the settings, the file is automatically
|
||||
deleted.
|
||||
|
||||
-----
|
||||
## Setting up Wi-Fi
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
# The Pico HID
|
||||
|
||||
---
|
||||
title: The Pico HID
|
||||
description: How to perform keyboard and mouse emulation on DIY PiKVM V1 with Pico HID
|
||||
---
|
||||
|
||||
!!! tip "A fast way to get PS/2 on PiKVM V2+"
|
||||
If you need PS/2 keyboard & mouse on [PiKVM V2](v2.md), [V3](v3.md) and [V4 Plus](v4.md)
|
||||
|
|
@ -11,8 +13,10 @@
|
|||
(the first model) based on RP2040 microcontroller is required.
|
||||
Pico 2 is not supported right now.
|
||||
|
||||
The Pico HID is a part of [DIY PiKVM V1](v1.md) platform that performs keyboard and mouse emulation.
|
||||
It has excellent compatibility, and emulates USB by default, including two mouse modes: absolute and relative.
|
||||
The Pico HID is a part of [DIY PiKVM V1](v1.md) platform that performs
|
||||
keyboard and mouse emulation. It has excellent compatibility, and
|
||||
emulates USB by default, including two mouse modes: absolute and
|
||||
relative.
|
||||
|
||||
Full list of features:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,7 @@
|
|||
# The Pico HID - PS/2 Bridge
|
||||
---
|
||||
title: The Pico HID - PS/2 Bridge
|
||||
description: How to use a special version of the generic Pico HID to emulate a PS/2 keyboard and mouse emulator on DIY PiKVM V1
|
||||
---
|
||||
|
||||
!!! note "Pico requirements"
|
||||
[Raspberri Pi Pico](https://www.raspberrypi.com/products/raspberry-pi-pico/)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,19 @@
|
|||
# TESMART managed multiport KVM switch
|
||||
---
|
||||
title: TESMART managed multiport KVM switch
|
||||
description: How to control the TESMART managed switch with PiKVM to allow the switch to connect to multiple hosts
|
||||
---
|
||||
|
||||
The TESMART managed switch can be controlled by PiKVM to allow it to connect to multiple hosts. A typical scenario is a single PiKVM device which can control and switch between multiple hosts or servers using the TESMART switch. UI elements can be added to the [GPIO dropdown](gpio.md) to allow switching between hosts from the PiKVM webpage. The instructions here were tested with the [TESMART HKS1601A10 HDMI 16x1 switch](https://www.amazon.com/dp/B07D2ZMF5B ). This should work with any of the other TESMART variants which have a LAN port - there is both a 8x1 and 4x1 variant. This was tested with an RPI4, but as this is executed over a network protocol, this should with almost anything.
|
||||
The TESMART managed switch can be controlled by PiKVM to allow it to
|
||||
connect to multiple hosts. A typical scenario is a single PiKVM device
|
||||
which can control and switch between multiple hosts or servers using the
|
||||
TESMART switch. UI elements can be added to the [GPIO dropdown](gpio.md)
|
||||
to allow switching between hosts from the PiKVM webpage.
|
||||
|
||||
The instructions here were tested with the [TESMART HKS1601A10 HDMI 16x1
|
||||
switch](https://www.amazon.com/dp/B07D2ZMF5B ). This should work with
|
||||
any of the other TESMART variants which have a LAN port - there is both
|
||||
a 8x1 and 4x1 variant. This was tested with an RPI4, but as this is
|
||||
executed over a network protocol, this should with almost anything.
|
||||
|
||||
|
||||
## Connections
|
||||
|
|
|
|||
Loading…
Reference in New Issue