Add a quick configuration section, add TOC entry, update quickstart guides and cheatsheet

This commit is contained in:
Aleksandr Prokudin 2025-11-09 17:22:59 +01:00
parent 0355258e9c
commit 0013667108
10 changed files with 28 additions and 3 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.9 MiB

View File

@ -121,6 +121,8 @@ Here are **first steps guides** for each PiKVM device:
PiKVM V3 and V4 will automatically reboot after several minutes of being halted. DIY PiKVM will need a power cord reconnection to become available again.
??? note "Sending keyboard shortcuts to target host systems"
{!shortcuts.md!}
-----
## Getting User Support

View File

@ -1,5 +1,5 @@
---
title: Sending shortcuts
title: Sending Shortcuts
description: "How to send shortcuts to atarget host system with PiKVM"
---
@ -13,7 +13,7 @@ Operating systems deal with modifier keys differently, so it's difficult to get
When you press a magic key, the web UI starts accumulating a sequence of modifier keys you press, for example, `Ctrl L` and `Alt L` in `Ctrl+Alt+Del`, and displays a guiding overlay:
![screenshot](_shortcuts/shortcut-overlay.webp)
![Shortcuts overlay](shortcuts/shortcut-overlay.png)
As soon as you press one non-modifier key, the web UI stop accumulating keys and sends the entire sequence of the keys you pressed to the target host system.
@ -68,4 +68,18 @@ PiKVM will send `Win` to the target host system which open the Start menu.
## Setting up a magic key
TBD
You can define which key to use as the magic key. Follow these steps:
1. In the web UI, open the **System** menu.
2. Click on the drop-down list next to **Shortcuts magic**.
3. Select the key the you will use as the magic key.
![Selecting the magic key](shortcuts/web-ui-magic-key-selector.png)
PiKVM defaults to `Ctrl Right` on all major desltop systems, but the list of available keys is platform-specific:
- **Windows**: `Ctrl`, `Alt`, `Shift`, and `Meta`.
- **macOS**: `Ctrl`, `Option`, and `Shift`.
- **Linux**: `Ctrl`, `Alt`, `Shift`, and `Meta`.

Binary file not shown.

After

Width:  |  Height:  |  Size: 786 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

View File

@ -264,6 +264,8 @@ To do that:
- **Get to know PiKVM Web UI**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
- **Configure the magic key**: define which key to use to start [sending shortcuts](shortcuts.md) to the target host system.
- Tune the HDMI dongle capture device if you're using it:
??? note "Persistent HDMI cable connection with USB dongle"

View File

@ -295,6 +295,8 @@ To do that:
- **Get to know PiKVM Web UI**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
- **Configure the magic key**: define which key to use to start [sending shortcuts](shortcuts.md) to the target host system.
- Tune the HDMI dongle capture device if you're using it:
??? note "Persistent HDMI cable connection with USB dongle"

View File

@ -250,6 +250,8 @@ To do that:
- **Get to know PiKVM Web UI**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
- **Configure the magic key**: define which key to use to start [sending shortcuts](shortcuts.md) to the target host system.
- **Set up [ATX connection](atx_board.md)** if you need to control the power of the remote system.

View File

@ -234,6 +234,8 @@ To do that:
- **Get to know PiKVM Web UI**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
- **Configure the magic key**: define which key to use to start [sending shortcuts](shortcuts.md) to the target host system.
- **Set up an [ATX connection](atx_board.md)** if you need to control the power of the remote system.

View File

@ -109,6 +109,7 @@ nav:
- "Getting started":
- "Cheat Sheet": cheatsheet.md
- "Web UI Overview": webui.md
- "Sending Shortcuts": shortcuts.md
- "Configuring PiKVM": config.md
- "Authentication & 2FA": auth.md
- "FAQ & Troubleshooting": faq.md