mirror of https://github.com/pikvm/pikvm.git
update
This commit is contained in:
parent
c815a21789
commit
c9b93ba95c
|
|
@ -134,6 +134,13 @@ ol li::marker {
|
|||
font-weight: bold;
|
||||
}
|
||||
|
||||
.md-typeset li details {
|
||||
.md-typeset details:not([open]) {
|
||||
border-left-width: 16px;
|
||||
}
|
||||
|
||||
.md-typeset li p + details,
|
||||
.md-typeset li p + .admonition,
|
||||
.md-typeset li details:only-child,
|
||||
.md-typeset li .admonition:only-child {
|
||||
margin: 0;
|
||||
}
|
||||
|
|
|
|||
65
docs/v1.md
65
docs/v1.md
|
|
@ -68,6 +68,8 @@ description: Getting started with PiKVM V1
|
|||
buy the [VGA-to-HDMI converter](https://aliexpress.com/item/3256801728005613.html).
|
||||
Some converters have issues with not supporting all resolutions and refresh rates.
|
||||
|
||||
|
||||
-----
|
||||
## Setting up the hardware
|
||||
|
||||
1. **Video capture device:**
|
||||
|
|
@ -109,19 +111,22 @@ description: Getting started with PiKVM V1
|
|||
??? example "Electrical schematic diagram for advanced users"
|
||||
<img src="../pico_hid/basic_scheme.png" />
|
||||
|
||||
3. !!! warning "Double check that the circuit is assembled correctly to avoid any damage of the hardware."
|
||||
3. **[Flash firmware to the Pico HID.](pico_hid.md){target=_blank}**
|
||||
|
||||
4. **[Flash firmware to the Pico HID.](pico_hid.md)**
|
||||
4. **[Flash the memory card with PiKVM OS](https://docs.pikvm.org/flashing_os){target=_blank}** and insert it to Raspberry Pi.
|
||||
|
||||
|
||||
-----
|
||||
## Wiring
|
||||
|
||||
!!! warning
|
||||
Double check that the circuit is assembled correctly to avoid any damage of the hardware.
|
||||
|
||||
PiKVM V1 requires several items available separately:
|
||||
|
||||
- Ethernet cable **(Raspberry Pi 2 and 3 only)**
|
||||
- RJ-45 cable for ATX (optional)
|
||||
- USB cable
|
||||
|
||||
- HDMI cable
|
||||
- USB-Micro Power Supply
|
||||
|
||||
Let's connect all the wires before you power up the device.
|
||||
|
||||
|
|
@ -129,23 +134,27 @@ Let's connect all the wires before you power up the device.
|
|||
|
||||
2. Connect the Pico HID to the USB port on the target host.
|
||||
|
||||
3. **Raspberry Pi 2/3**: connect **Ethernet** to the network, e.g., to the WiFI router.
|
||||
3. **Raspberry Pi 2/3**: connect **Ethernet** to the network, e.g., to the Wi-Fi router.
|
||||
|
||||
4. ??? example "Connect the ATX controller if you built it"
|
||||
|
||||
{!_diy_wiring_atx.md!}
|
||||
|
||||
|
||||
-----
|
||||
## Power up
|
||||
|
||||
[Flash the memory card with PiKVM OS](https://docs.pikvm.org/flashing_os){target=_blank} and insert it to Raspberry Pi.
|
||||
If everything is assembled correctly, attach the power supply to the Raspberry Pi.
|
||||
|
||||
Next, attach the power supply to the Raspberry Pi.
|
||||
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.
|
||||
|
||||
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.
|
||||
**Do not turn off the device until it's fully booted for the first time.**
|
||||
|
||||
|
||||
-----
|
||||
## Access PiKVM
|
||||
|
||||
You need to know PiKVM's IP address in the network to be able to access it. Unlike V3 and V4, PiKVM V2 doesn't have an OLED to display the IP address it receives automatically. You need to discover it manually. There are several ways to do that.
|
||||
You need to know PiKVM's IP address in the network to be able to access it. Unlike [PiKVM V3](v3.md) and [V4](v4.md), PiKVM V1 doesn't have an OLED to display the IP address it receives automatically. You need to discover it manually. There are several ways to do that.
|
||||
|
||||
* **Common way:** Open the web interface of your router and find the list of issued IP addresses there.
|
||||
* **Linux-only:** Use the `arp-scan --localnet` command.
|
||||
|
|
@ -164,7 +173,7 @@ Submit the default credentials and click **Login**:
|
|||
- Password: `admin`
|
||||
- 2FA Code: disabled by default, skip this field
|
||||
|
||||
You will see the initial dashboard screen of the PiKVM where you can access the remote desktop, connect to the PiKVM command line, or log out:
|
||||
You will see the initial dashboard screen of the PiKVM where you can access the remote host, connect to the PiKVM command line, or log out:
|
||||
|
||||
{ width="450" }
|
||||
|
||||
|
|
@ -172,15 +181,16 @@ You will see the initial dashboard screen of the PiKVM where you can access the
|
|||
|
||||
For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time.
|
||||
|
||||
!!! danger "Please ensure that you change both passwords: for web UI access and for the superuser (root)"
|
||||
!!! danger "Passwords are important!"
|
||||
Please ensure that you change **both** passwords: for Web UI access and for the Linux superuser (root).
|
||||
|
||||
To do that:
|
||||
|
||||
1. On the initial dashboard screen, click the **Terminal** button to open the web terminal. You will see this command line interface:
|
||||
|
||||
{ width="450" }
|
||||
{ width="450" }
|
||||
|
||||
2. Gain superuser privileges:
|
||||
2. Gain Linux superuser privileges:
|
||||
|
||||
```console
|
||||
$ su -
|
||||
|
|
@ -194,7 +204,7 @@ To do that:
|
|||
[root@pikvm ~]# rw
|
||||
```
|
||||
|
||||
4. Change the password for the superuser:
|
||||
4. Change the password for the Linux superuser:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# passwd root
|
||||
|
|
@ -226,39 +236,46 @@ To do that:
|
|||
|
||||
### Access the remote system
|
||||
|
||||
1. On the initial dashboard screen, click the **KVM** button to access the remote desktop.
|
||||
1. On the initial dashboard screen, click the **KVM** button to access the remote host.
|
||||
|
||||
2. You should now see the host system's display and interact with it remotely using a keyboard and a mouse.
|
||||
|
||||
{ width="450" }
|
||||
|
||||
|
||||
-----
|
||||
## Important next steps
|
||||
|
||||
- We strongly recommend to update the PiKVM OS after the first launch:
|
||||
|
||||
{!_update_os.md!}
|
||||
|
||||
- Get to know PiKVM OS: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
|
||||
- Set up [ATX connection](atx_board.md) if you need to control the power of the remote system.
|
||||
|
||||
|
||||
-----
|
||||
## Further recommendations
|
||||
|
||||
1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
- [Harden the remote access](auth.md) by enabling 2FA and setting session expiration time.
|
||||
- Configure access to PiKVM from the Internet using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md).
|
||||
- [Learn](config.md) how configuration files are structured.
|
||||
|
||||
2. **Customize the system**:
|
||||
|
||||
- [Update](_update_os.md) the PiKVM operating system.
|
||||
- [Harden the remote access](auth.md) by enabling 2FA and setting session expiration time.
|
||||
- Configure access to PiKVM from the Internet using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md).
|
||||
- [Learn](config.md) how configuration files are structured.
|
||||
|
||||
-----
|
||||
## Known issues and limitations
|
||||
|
||||
**Max resolution**. PiKVM V1 with CSI bridge can only handle the maximum resolution 1920x1080@50Hz, 60Hz is not supported due hardware limitation. You can use any other resolution less than the specified one, for example 1280x720@60Hz. If you have any problems with video on CSI bridge, follow [this guide](edid.md).
|
||||
* **Max resolution**.<br>PiKVM V1 with CSI bridge can only handle the maximum resolution 1920x1080@50Hz, 60Hz is not supported due hardware limitation. You can use any other resolution less than the specified one, for example 1280x720@60Hz. If you have any problems with video on CSI bridge, follow [this guide](edid.md).
|
||||
|
||||
|
||||
-----
|
||||
## Basic troubleshooting
|
||||
|
||||
{!_basic_troubleshooting.md!}
|
||||
|
||||
|
||||
-----
|
||||
## 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).
|
||||
|
|
|
|||
61
docs/v2.md
61
docs/v2.md
|
|
@ -9,6 +9,7 @@ description: Getting started with PiKVM V2
|
|||
There are many different options with sub-items, so you can choose what will suit you.<br>
|
||||
However, we marked the recommended way by sign **`✮ ✮ ✮`**
|
||||
|
||||
-----
|
||||
## Required parts
|
||||
|
||||
1. **MicroSD card minimum 16Gb class 10.**
|
||||
|
|
@ -79,6 +80,8 @@ description: Getting started with PiKVM V2
|
|||
|
||||
*Kit parts suitable for assembly are also on [sale in Poland](https://3mdeb.com/shop/open-source-hardware/pikvm/).*
|
||||
|
||||
|
||||
-----
|
||||
## Setting up the hardware
|
||||
|
||||
1. **Video capture device:**
|
||||
|
|
@ -142,17 +145,19 @@ description: Getting started with PiKVM V2
|
|||
??? example "Electrical schematic diagram for advanced users"
|
||||
<img src="../v2/v2_atx_scheme.png" />
|
||||
|
||||
4. !!! warning "Double check that the circuit is assembled correctly to avoid any damage of the hardware."
|
||||
4. **[Flash the memory card with PiKVM OS](https://docs.pikvm.org/flashing_os){target=_blank}** and insert it to Raspberry Pi.
|
||||
|
||||
|
||||
-----
|
||||
## Wiring
|
||||
|
||||
!!! warning
|
||||
Double check that the circuit is assembled correctly to avoid any damage of the hardware.
|
||||
|
||||
PiKVM V2 requires several items available separately:
|
||||
|
||||
- Ethernet cable **(Raspberry Pi 4 only)**
|
||||
- RJ-45 cable for ATX (optional)
|
||||
- USB-C cable
|
||||
- HDMI cable
|
||||
- 5V USB power adapter
|
||||
|
||||
Let's connect all the wires before you power up the device.
|
||||
|
||||
|
|
@ -166,14 +171,18 @@ Let's connect all the wires before you power up the device.
|
|||
|
||||
{!_diy_wiring_atx.md!}
|
||||
|
||||
|
||||
-----
|
||||
## Power up
|
||||
|
||||
[Flash the memory card with PiKVM OS](https://docs.pikvm.org/flashing_os){target=_blank} and insert it to Raspberry Pi.
|
||||
If everything is assembled correctly, attach the power supply to the Raspberry Pi.
|
||||
|
||||
Next, attach the USB-C 5V power supply to the Raspberry Pi.
|
||||
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.
|
||||
|
||||
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.
|
||||
**Do not turn off the device until it's fully booted for the first time.**
|
||||
|
||||
|
||||
-----
|
||||
## Access PiKVM
|
||||
|
||||
You need to know PiKVM's IP address in the network to be able to access it. Unlike V3 and V4, PiKVM V2 doesn't have an OLED to display the IP address it receives automatically. You need to discover it manually. There are several ways to do that.
|
||||
|
|
@ -195,7 +204,7 @@ Submit the default credentials and click **Login**:
|
|||
- Password: `admin`
|
||||
- 2FA Code: disabled by default, skip this field
|
||||
|
||||
You will see the initial dashboard screen of the PiKVM where you can access the remote desktop, connect to the PiKVM command line, or log out:
|
||||
You will see the initial dashboard screen of the PiKVM where you can access the remote host, connect to the PiKVM command line, or log out:
|
||||
|
||||
{ width="450" }
|
||||
|
||||
|
|
@ -203,15 +212,16 @@ You will see the initial dashboard screen of the PiKVM where you can access the
|
|||
|
||||
For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time.
|
||||
|
||||
!!! danger "Please ensure that you change both passwords: for web UI access and for the superuser (root)"
|
||||
!!! danger "Passwords are important!"
|
||||
Please ensure that you change **both** passwords: for Web UI access and for the Linux superuser (root).
|
||||
|
||||
To do that:
|
||||
|
||||
1. On the initial dashboard screen, click the **Terminal** button to open the web terminal. You will see this command line interface:
|
||||
|
||||
{ width="450" }
|
||||
{ width="450" }
|
||||
|
||||
2. Gain superuser privileges:
|
||||
2. Gain Linux superuser privileges:
|
||||
|
||||
```console
|
||||
$ su -
|
||||
|
|
@ -225,7 +235,7 @@ To do that:
|
|||
[root@pikvm ~]# rw
|
||||
```
|
||||
|
||||
4. Change the password for the superuser:
|
||||
4. Change the password for the Linux superuser:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# passwd root
|
||||
|
|
@ -257,39 +267,48 @@ To do that:
|
|||
|
||||
### Access the remote system
|
||||
|
||||
1. On the initial dashboard screen, click the **KVM** button to access the remote desktop.
|
||||
1. On the initial dashboard screen, click the **KVM** button to access the remote host.
|
||||
|
||||
2. You should now see the host system's display and interact with it remotely using a keyboard and a mouse.
|
||||
|
||||
{ width="450" }
|
||||
|
||||
|
||||
-----
|
||||
## Important next steps
|
||||
|
||||
- We strongly recommend to update the PiKVM OS after the first launch:
|
||||
|
||||
{!_update_os.md!}
|
||||
|
||||
- Get to know PiKVM OS: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
|
||||
- Set up [ATX connection](atx_board.md) if you need to control the power of the remote system.
|
||||
|
||||
|
||||
-----
|
||||
## Further recommendations
|
||||
|
||||
1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
- [Harden the remote access](auth.md) by enabling 2FA.
|
||||
- Configure access to PiKVM from the Internet using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md).
|
||||
- [Learn](config.md) how configuration files are structured.
|
||||
|
||||
2. **Customize the system**:
|
||||
|
||||
- [Update](_update_os.md) the PiKVM operating system.
|
||||
- [Harden the remote access](auth.md) by enabling 2FA and setting session expiration time.
|
||||
- Configure access to PiKVM from the Internet using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md).
|
||||
- [Learn](config.md) how configuration files are structured.
|
||||
|
||||
-----
|
||||
## Known issues and limitations
|
||||
|
||||
**Max resolution**. PiKVM V2 with CSI bridge can only handle the maximum resolution 1920x1080@50Hz, 60Hz is not supported due hardware limitation. You can use any other resolution less than the specified one, for example 1280x720@60Hz. If you have any problems with video on CSI bridge, follow [this guide](edid.md).
|
||||
* **Max resolution**.<br>PiKVM V2 with CSI bridge can only handle the maximum resolution 1920x1080@50Hz, 60Hz is not supported due hardware limitation. You can use any other resolution less than the specified one, for example 1280x720@60Hz. If you have any problems with video on CSI bridge, follow [this guide](edid.md).
|
||||
|
||||
* **Motherboards compatibility**.<br>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.
|
||||
|
||||
|
||||
-----
|
||||
## Basic troubleshooting
|
||||
|
||||
{!_basic_troubleshooting.md!}
|
||||
|
||||
|
||||
-----
|
||||
## 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).
|
||||
|
|
|
|||
54
docs/v3.md
54
docs/v3.md
|
|
@ -5,7 +5,7 @@ description: Getting started with PiKVM V3 & pre-assembled
|
|||
|
||||
# PiKVM V3 HAT & pre-assembled quick start
|
||||
|
||||

|
||||
{ width="450" }
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -18,6 +18,8 @@ PiKVM V3 is available in two version:
|
|||
|
||||
The two versions have the same ports and functionality.
|
||||
|
||||
|
||||
-----
|
||||
## What's in the box
|
||||
|
||||
=== "HAT"
|
||||
|
|
@ -36,6 +38,8 @@ The two versions have the same ports and functionality.
|
|||
- ATX adapter board with mounting brackets and motherboard interface wiring
|
||||
- A 32 GB MicroSD card pre-imaged with the PiKVM OS
|
||||
|
||||
|
||||
-----
|
||||
## HAT setup
|
||||
|
||||
If you have an assembly kit without a metal case, you can use our free 3D printing case drawing:
|
||||
|
|
@ -49,6 +53,8 @@ Once you have that, do the following:
|
|||
|
||||
2. **Build PiKVM** according to the [illustrated instructions](v3_illustrated_install_instructions.md).
|
||||
|
||||
|
||||
-----
|
||||
## Interface
|
||||
|
||||
=== "Front view"
|
||||
|
|
@ -86,6 +92,8 @@ Once you have that, do the following:
|
|||
|
||||
1. Display
|
||||
|
||||
|
||||
-----
|
||||
## Wiring
|
||||
|
||||
Both the HAT and the pre-assembled V3 require several items available separately:
|
||||
|
|
@ -112,6 +120,8 @@ Connect **Ethernet** (**bottom right** on the **front** side) to the network, e.
|
|||
|
||||
Optionally, the **[ATX port](atx_board.md)** can be connected to control the power. There should be no USB hub between PiKVM and the computer, as some UEFI/BIOS cannot detect them at the boot stage.
|
||||
|
||||
|
||||
-----
|
||||
## Power up
|
||||
|
||||

|
||||
|
|
@ -120,6 +130,8 @@ 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.
|
||||
|
||||
|
||||
-----
|
||||
## Connect and set up
|
||||
|
||||
### Configure the display
|
||||
|
|
@ -150,7 +162,7 @@ Submit the default credentials and click **Login**:
|
|||
- Password: `admin`
|
||||
- 2FA Code: disabled by default, skip this field
|
||||
|
||||
You will see the initial dashboard screen of the PiKVM where you can access the remote desktop, connect to the PiKVM command line, or log out:
|
||||
You will see the initial dashboard screen of the PiKVM where you can access the remote host, connect to the PiKVM command line, or log out:
|
||||
|
||||
{ width="450" }
|
||||
|
||||
|
|
@ -158,15 +170,15 @@ You will see the initial dashboard screen of the PiKVM where you can access the
|
|||
|
||||
For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time.
|
||||
|
||||
!!! danger "Please ensure that you change both passwords: for web UI access and for the superuser (root)"
|
||||
!!! danger "Please ensure that you change both passwords: for web UI access and for the Linux superuser (root)"
|
||||
|
||||
To do that:
|
||||
|
||||
1. On the initial dashboard screen, click the **Terminal** button to open the web terminal. You will see this command line interface:
|
||||
|
||||
{ width="450" }
|
||||
{ width="450" }
|
||||
|
||||
2. Gain superuser privileges:
|
||||
2. Gain Linux superuser privileges:
|
||||
|
||||
```console
|
||||
$ su -
|
||||
|
|
@ -180,7 +192,7 @@ To do that:
|
|||
[root@pikvm ~]# rw
|
||||
```
|
||||
|
||||
4. Change the password for the superuser:
|
||||
4. Change the password for the Linux superuser:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# passwd root
|
||||
|
|
@ -212,32 +224,36 @@ To do that:
|
|||
|
||||
### Access the remote system
|
||||
|
||||
1. On the initial dashboard screen, click the **KVM** button to access the remote desktop.
|
||||
1. On the initial dashboard screen, click the **KVM** button to access the remote host.
|
||||
|
||||
2. You should now see the host system's display and interact with it remotely using a keyboard and a mouse.
|
||||
|
||||
{ width="450" }
|
||||
|
||||
|
||||
-----
|
||||
## Important next steps
|
||||
|
||||
- We strongly recommend to update the PiKVM OS after the first launch:
|
||||
|
||||
{!_update_os.md!}
|
||||
|
||||
- Get to know PiKVM OS: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
|
||||
- Set up [ATX connection](atx_board.md) if you need to control the power of the remote system.
|
||||
|
||||
|
||||
-----
|
||||
## Further recommendations
|
||||
|
||||
1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
|
||||
2. **Customize the system**:
|
||||
1. **Customize the system**:
|
||||
|
||||
- [Harden the remote access](auth.md) by enabling 2FA.
|
||||
- Configure access to PiKVM from the Internet using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md).
|
||||
- Enable a microphone for [two-way audio](audio.md).
|
||||
- [Learn](config.md) how configuration files are structured.
|
||||
|
||||
3. **Configure hardware**:
|
||||
2. **Configure hardware**:
|
||||
|
||||
- If you bought V3 HAT Assembly Kit and it includes the OLED display and/or the fan, you'll need to turn them on. Note this is only needed for the older V3 image for the HAT, in the box image everything is enabled by default:
|
||||
|
||||
|
|
@ -257,13 +273,17 @@ To do that:
|
|||
|
||||
{!_fahrenheit.md!}
|
||||
|
||||
|
||||
-----
|
||||
## 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).
|
||||
* **Motherboards compatibility**. 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.
|
||||
* **HDMI backpowering**. Under specific circumstances, PiKVM may hang during the boot. Turn off the PiKVM, disconnect all cables from it, take a close look at the diagram of its ports and jumpers below, and **remove jumper #14** (it is to the right of the CSI connector, **not available on the V3.2 board**). Then you can connect and power up PiKVM again. (Technical background s described [here](https://www.kickstarter.com/projects/mdevaev/pikvm-v3-hat/posts/3296343).)
|
||||
* **IO ports**. **Before using GPIO** pins to control a relay, KVM switch, or anything else, be sure to check the HAT pinout below. Many ports are busy with internal functions. Before using them for your own use, you must disable them, otherwise you may damage the device.
|
||||
* **Max resolution**.<br>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).
|
||||
|
||||
* **Motherboards compatibility**.<br>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.
|
||||
|
||||
* **HDMI backpowering**.<br>Under specific circumstances, PiKVM may hang during the boot. Turn off the PiKVM, disconnect all cables from it, take a close look at the diagram of its ports and jumpers below, and **remove jumper #14** (it is to the right of the CSI connector, **not available on the V3.2 board**). Then you can connect and power up PiKVM again. (Technical background s described [here](https://www.kickstarter.com/projects/mdevaev/pikvm-v3-hat/posts/3296343).)
|
||||
|
||||
* **IO ports**.<br>Before using GPIO pins to control a relay, KVM switch, or anything else, be sure to check the HAT pinout below. Many ports are busy with internal functions. Before using them for your own use, you must disable them, otherwise you may damage the PiKVM WebTerm
|
||||
??? note "The ports and jumpers diagram"
|
||||
<img src="v3_features.jpg" />
|
||||
|
||||
|
|
@ -316,6 +336,8 @@ To do that:
|
|||
|
||||
The standard Raspberry Pi HDMI output (marked as `VIDEO OUT` on the PiKVM case) displays its own PiKVM OS console.
|
||||
|
||||
|
||||
-----
|
||||
## Basic troubleshooting
|
||||
|
||||
* Ensure that you are using the right [OS image](flashing_os.md) for your platform
|
||||
|
|
@ -326,6 +348,8 @@ The standard Raspberry Pi HDMI output (marked as `VIDEO OUT` on the PiKVM case)
|
|||
* `dmesg | egrep 'tc35|1-1.4|uvc'`
|
||||
* `systemctl status kvmd-tc358743`
|
||||
|
||||
|
||||
-----
|
||||
## 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).
|
||||
|
|
|
|||
25
docs/v4.md
25
docs/v4.md
|
|
@ -5,7 +5,7 @@ description: Getting started with PiKVM V4 Mini & Plus
|
|||
|
||||
# PiKVM V4 Mini & Plus quick start
|
||||
|
||||
 & Plus (right)")
|
||||
 & Plus (right)"){ width="450" }
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -137,7 +137,7 @@ Submit the default credentials and click **Login**:
|
|||
- Password: `admin`
|
||||
- 2FA Code: disabled by default, skip this field
|
||||
|
||||
You will see the initial dashboard screen of the PiKVM where you can access the remote desktop, connect to the PiKVM command line, or log out:
|
||||
You will see the initial dashboard screen of the PiKVM where you can access the remote host, connect to the PiKVM command line, or log out:
|
||||
|
||||
{ width="450" }
|
||||
|
||||
|
|
@ -199,25 +199,29 @@ To do that:
|
|||
|
||||
### Access the remote system
|
||||
|
||||
1. On the initial dashboard screen, click the **KVM** button to access the remote desktop.
|
||||
1. On the initial dashboard screen, click the **KVM** button to access the remote host.
|
||||
|
||||
2. You should now see the host system's display and interact with it remotely using a keyboard and a mouse.
|
||||
|
||||
{ width="450" }
|
||||
|
||||
|
||||
-----
|
||||
## Important next steps
|
||||
|
||||
- We strongly recommend to update the PiKVM OS after the first launch:
|
||||
|
||||
{!_update_os.md!}
|
||||
|
||||
- Get to know PiKVM OS: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
|
||||
- Set up [ATX connection](atx_board.md) if you need to control the power of the remote system.
|
||||
|
||||
|
||||
-----
|
||||
## Further recommendations
|
||||
|
||||
1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
|
||||
2. **Customize the system**:
|
||||
1. **Customize the system**:
|
||||
|
||||
- [Harden the remote access](auth.md) by enabling 2FA.
|
||||
- Configure access to PiKVM from the Internet using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md).
|
||||
|
|
@ -225,7 +229,7 @@ To do that:
|
|||
- Enable [HDMI pass-through](pass.md).
|
||||
- [Learn](config.md) how configuration files are structured.
|
||||
|
||||
3. **Configure hardware**:
|
||||
2. **Configure hardware**:
|
||||
|
||||
- Install and set up [Wi-Fi antenna](wifi.md).
|
||||
- Install and set up [LTE/5G modem](modem.md) (**only for PiKVM V4 Plus**).
|
||||
|
|
@ -285,11 +289,16 @@ To do that:
|
|||
|
||||
{!_fahrenheit.md!}
|
||||
|
||||
|
||||
-----
|
||||
## 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.
|
||||
|
||||
* 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
|
||||
|
||||
* Ensure that you are using the right [OS image](flashing_os.md) for your platform
|
||||
|
|
@ -300,6 +309,8 @@ To do that:
|
|||
* `dmesg | egrep 'tc35|1-1.4|uvc'`
|
||||
* `systemctl status kvmd-tc358743`
|
||||
|
||||
|
||||
-----
|
||||
## 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).
|
||||
|
|
|
|||
Loading…
Reference in New Issue