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

update

This commit is contained in:
Maxim Devaev 2025-04-29 22:50:29 +03:00
parent c84b682ff4
commit a437acc617
11 changed files with 65 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/conf_files_structure.md → docs/config.md
View File

25
docs/dip_switches.md
View File

@ -1,25 +0,0 @@
---
title: Configure DIP switches
description: How to configure DIP switches on PiKVM V4 Mini and Plus
---
# Configure DIP switches
PiKVM V4 Mini and Plus have a pair of dual in-line package (DIP) switches on the right side to control low-level settings of the Pi board.
![DIP switches on V4 Plus](v4_dip_switches.png "DIP switches on V4 Plus")
The left switch **[1]**:
: When pulled down (**ON** state), the advanced backpower protection is used. On the default state is **OFF** (up), "diode protection" is used. This is required for debugging at the request of technical support. Under normal conditions, it is not necessary to change the mode.
The right switch **[2]**:
: When pulled down (**ON** state), the Power Delivery chip is activated on the USB OTG port. The default state is **OFF** (up).
To change the position of switches:
1. Turn the PiKVM off.
2. Change the position of the switched.
3. Turn the PiKVM on.
!!! warning
Do not do that change the state of the DIP switched while the device is turned on. **This may cause irreparable damage.**

BIN
docs/dip_switches/v4_dip_switches.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 62 KiB

6
docs/first_steps.md
View File

@ -71,7 +71,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 over SSH, or log out:
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:
![Initial UI](../v4/initial-ui.png)
@ -177,10 +177,8 @@ There are two alternative ways to connect to the PiKVM:
3. **Configure hardware**:
- Set up [ATX connection](atx_board.md).
- Configure [DIP switches](dip_switches.md)
- Install and set up [Wi-Fi antenna](wifi.md).
- Install and set up [LTE/5G modem](modem.md) (**only for PiKVM V4 Plus**).
- Set up [USB 3.0](usb3v4.md) (**only for PiKVM V4 Plus**).
- Choose Fahrenheit over Celsius to display on the OLED:
??? note "How to set up Fahrenheit"
@ -208,4 +206,4 @@ There are two alternative ways to connect to the PiKVM:
## 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).

34
docs/usb3v4.md
View File

@ -1,34 +0,0 @@
---
title: Configure USB 3.0 support
description: How to configure USB 3.0 support on PiKVM V4 Plus
---
# USB 3.0 support
PiKVM V4 Plus has an internal USB port. It supports USB 3.0, but only works with USB 2.0 devices by default to minimize the power consumption. You need to flash the USB controller to enable USB 3.0. To do so, follow these steps:
1. Open a terminal window and log into the PiKVM via SSH:
```console
$ ssh user@host
```
2. Flash the USB controller using the built-in `flashrom` utility. Choose `usb3` for USB 3.0 support:
```console
[root@pikvm ~]# flashrom-vl805 usb3
```
If you need to disable USB 3.0 support at any time later, run the same command, but use `default` instead:
```console
[root@pikvm ~]# flashrom-vl805 default
```
3. Perform the soft reboot:
```console
[root@pikvm ~]# reboot
```
4. After the soft reboot, perform the **reboot by power**: unplug and plug again the power cable.

7
docs/v1.md
View File

@ -164,7 +164,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 over SSH, or log out:
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:
![Initial UI](../v4/initial-ui.png){ width="450" }
@ -237,12 +237,11 @@ For security's sake, it's best to change the default passwords immediately after
- [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](conf_files_structure.md) how configuration files are structured.
- [Learn](config.md) how configuration files are structured.
3. **Configure hardware**:
- Set up [ATX connection](atx_board.md).
- Set up [USB 3.0](usb3v4.md)
## Known issues and limitations
@ -254,4 +253,4 @@ For security's sake, it's best to change the default passwords immediately after
## 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).

7
docs/v2.md
View File

@ -195,7 +195,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 over SSH, or log out:
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:
![Initial UI](../v4/initial-ui.png){ width="450" }
@ -268,12 +268,11 @@ For security's sake, it's best to change the default passwords immediately after
- [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](conf_files_structure.md) how configuration files are structured.
- [Learn](config.md) how configuration files are structured.
3. **Configure hardware**:
- Set up [ATX connection](atx_board.md).
- Set up [USB 3.0](usb3v4.md)
## Known issues and limitations
@ -285,4 +284,4 @@ For security's sake, it's best to change the default passwords immediately after
## 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).

4
docs/v3.md
View File

@ -150,7 +150,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 over SSH, or log out:
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:
![Initial UI](../v4/initial-ui.png){ width="450" }
@ -227,7 +227,7 @@ For security's sake, it's best to change the default passwords immediately after
- [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](conf_files_structure.md) how configuration files are structured.
- [Learn](config.md) how configuration files are structured.
3. **Configure hardware**:

58
docs/v4.md
View File

@ -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 over SSH, or log out:
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:
![Initial UI](initial-ui.png){ width="450" }
@ -215,15 +215,65 @@ For security's sake, it's best to change the default passwords immediately after
- 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).
- Enable [HDMI pass-through](pass.md).
- [Learn](conf_files_structure.md) how configuration files are structured.
- [Learn](config.md) how configuration files are structured.
3. **Configure hardware**:
- Set up [ATX connection](atx_board.md).
- Install and set up [Wi-Fi antenna](wifi.md).
- Install and set up [LTE/5G modem](modem.md) (**only for PiKVM V4 Plus**).
- Set up internal [USB 3.0](usb3v4.md) port if you need (**only for PiKVM V4 Plus**).
- Learn about [DIP switches](dip_switches.md).
- Set up internal USB port for USB 3.0 (**only for PiKVM V4 Plus**):
??? note "Enable USB 3.0 on the internal port"
PiKVM V4 Plus has an internal USB port. It supports USB 3.0, but only works with USB 2.0 devices by default to minimize the power consumption. You need to flash the USB controller to enable USB 3.0. To do so, follow these steps:
1. Open a terminal window and log into the PiKVM via SSH:
```console
$ ssh user@host
```
2. Flash the USB controller using the built-in `flashrom` utility. Choose `usb3` for USB 3.0 support:
```console
[root@pikvm ~]# flashrom-vl805 usb3
```
If you need to disable USB 3.0 support at any time later, run the same command, but use `default` instead:
```console
[root@pikvm ~]# flashrom-vl805 default
```
3. Perform the soft reboot:
```console
[root@pikvm ~]# reboot
```
4. After the soft reboot, perform the **reboot by power**: unplug and plug again the power cable.
- Learn about DIP switches:
??? note "DIP switches purpose"
The left switch **[1]**:
: When pulled down (**ON** state), the advanced backpower protection is used. On the default state is **OFF** (up), "diode protection" is used. This is required for debugging at the request of technical support. Under normal conditions, it is not necessary to change the mode.
The right switch **[2]**:
: When pulled down (**ON** state), the Power Delivery chip is activated on the USB OTG port. The default state is **OFF** (up).
To change the position of switches:
1. Turn the PiKVM off.
2. Change the position of the switched.
3. Turn the PiKVM on.
!!! warning
Do not do that change the state of the DIP switched while the device is turned on. **This may cause irreparable damage.**
- Choose Fahrenheit over Celsius to display on the OLED:
{!_fahrenheit.md!}

0
docs/dip_switches/v4_dip_switches.png → docs/v4/v4_dip_switches.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 246 KiB

After

Width:  |  Height:  |  Size: 246 KiB

4
mkdocs.yml
View File

@ -94,6 +94,7 @@ nav:
- "Getting started":
- "First steps": first_steps.md
- "Web UI Overview": webui.md
- "Configure PiKVM OS": config.md
- "Authentication & 2FA": auth.md
- "FAQ & Troubleshooting": faq.md
- "Flashing OS": flashing_os.md
@ -124,7 +125,6 @@ nav:
- "Serial-over-USB": usb_serial.md
- "GPIO (pins, relays, lamps, etc)": gpio.md
- "Advanced usage":
- "Structure of configuration files": conf_files_structure.md
- "On-boot configuration": on_boot_config.md
- "Using VNC": vnc.md
- "Multiport KVM-over-IP": multiport.md
@ -132,8 +132,6 @@ nav:
- "IPMI & Redfish integration": ipmi.md
- "Persistent storage": pst.md
- "Prometheus monitoring": prometheus.md
- "DIP switches": dip_switches.md
- "USB 3.0 support": usb3v4.md
- "Development":
- "HTTP API reference": api.md
- "Building PiKVM OS": building_os.md