Quickstart fixes (#1503)

* Fix the Fahrenheit section

* Fix V3 docs mentioning USB 3

* Fix the troubleshooting part

* Add the link to conf_files_structure.md
This commit is contained in:
Aleksandr Prokudin 2025-04-29 18:05:58 +02:00 committed by GitHub
parent 657db6c3f1
commit c97ee4c502
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 47 additions and 27 deletions

View File

@ -14,4 +14,4 @@ search:
If you see a failed message on that output, be sure verify the orientation of the CSI cable or try reseating it.
Not that this is not a hotplug device and you must first turn off the power.
Note that this is not a hotplug device, and you must first turn off the power.

View File

@ -237,6 +237,7 @@ 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.
3. **Configure hardware**:

View File

@ -268,6 +268,7 @@ 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.
3. **Configure hardware**:

View File

@ -227,21 +227,23 @@ For security's sake, it's best to change the default passwords immediately after
[root@pikvm ~]# ro
```
??? note "Using Fahrenheit instead of Celsius on the OLED"
??? note "How to set up Fahrenheit on the OLED"
```console
[root@pikvm ~]# mkdir -p /etc/systemd/system/kvmd-oled.service.d
```
Create a directory for a configuration file:
Create file `/etc/systemd/system/kvmd-oled.service.d/override.conf`:
```console
[root@pikvm ~]# mkdir -p /etc/systemd/system/kvmd-oled.service.d
```
```ini
[Service]
ExecStart=
ExecStart=/usr/bin/kvmd-oled --clear-on-exit --fahrenheit
```
Create file `/etc/systemd/system/kvmd-oled.service.d/override.conf`:
Then run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the device.
```ini
[Service]
ExecStart=
ExecStart=/usr/bin/kvmd-oled --clear-on-exit --fahrenheit
```
Then run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the device.
## Further steps
@ -253,11 +255,11 @@ For security's sake, it's best to change the default passwords immediately after
- [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).
- Enable a microphone for [two-way audio](audio.md).
- [Learn](conf_files_structure.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
@ -320,7 +322,15 @@ The standard Raspberry Pi HDMI output (marked as `VIDEO OUT` on the PiKVM case)
## Basic troubleshooting
{!_basic_troubleshooting.md!}
* Ensure that you are using the right [OS image](flashing_os.md) for your platform
by running the following command: `pacman -Q | grep kvmd-platform`.
* If you are not getting a display, run the two following commands:
* `dmesg | egrep 'tc35|1-1.4|uvc'`
* `systemctl status kvmd-tc358743`
Note that this is not a hotplug device, and you must first turn off the power.
## Getting user support

View File

@ -213,6 +213,7 @@ 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.
3. **Configure hardware**:
@ -223,23 +224,23 @@ For security's sake, it's best to change the default passwords immediately after
- 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"
??? note "How to set up Fahrenheit on the OLED"
Create a directory for a configuration file:
Create a directory for a configuration file:
```console
[root@pikvm ~]# mkdir -p /etc/systemd/system/kvmd-oled.service.d
```
```console
[root@pikvm ~]# mkdir -p /etc/systemd/system/kvmd-oled.service.d
```
Create file `/etc/systemd/system/kvmd-oled.service.d/override.conf`:
Create file `/etc/systemd/system/kvmd-oled.service.d/override.conf`:
```ini
[Service]
ExecStart=
ExecStart=/usr/bin/kvmd-oled --clear-on-exit --fahrenheit
```
```ini
[Service]
ExecStart=
ExecStart=/usr/bin/kvmd-oled --clear-on-exit --fahrenheit
```
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.
## Known issues and limitations
@ -248,8 +249,15 @@ For security's sake, it's best to change the default passwords immediately after
## Basic troubleshooting
{!_basic_troubleshooting.md!}
* Ensure that you are using the right [OS image](flashing_os.md) for your platform
by running the following command: `pacman -Q | grep kvmd-platform`.
* If you are not getting a display, run the two following commands:
* `dmesg | egrep 'tc35|1-1.4|uvc'`
* `systemctl status kvmd-tc358743`
Note that this is not a hotplug device, and you must first turn off the power.
## Getting user support