From 0cff16954ae51b4709afc2027f5b155e60c620b6 Mon Sep 17 00:00:00 2001 From: Maxim Devaev Date: Tue, 29 Apr 2025 20:41:20 +0300 Subject: [PATCH] update --- docs/_fahrenheit.md | 2 +- docs/v3.md | 42 +++++++++++++++++++++++------------------- docs/v4.md | 13 ++++++++----- 3 files changed, 32 insertions(+), 25 deletions(-) diff --git a/docs/_fahrenheit.md b/docs/_fahrenheit.md index dc7665d9..b33a9d0a 100644 --- a/docs/_fahrenheit.md +++ b/docs/_fahrenheit.md @@ -1,4 +1,4 @@ -??? note "Choose Fahrenheit over Celsius to display on the OLED" +??? note "How to set up Fahrenheit on the OLED" Create a directory for a configuration file: diff --git a/docs/v3.md b/docs/v3.md index eb82eaf4..a72e53ab 100644 --- a/docs/v3.md +++ b/docs/v3.md @@ -214,29 +214,17 @@ For security's sake, it's best to change the default passwords immediately after ![Work remotely](../v4/remote-screen.png) -## Additional setting up - -??? note "If your kit includes the OLED display and/or the fan, you'll need to turn them on (this is only needed for the older V3 image for the HAT, in the box image everything is enabled by default)" - - Log in to PiKVM and run these commands: - - ```console - [root@pikvm ~]# rw - [root@pikvm ~]# systemctl enable --now kvmd-oled kvmd-oled-reboot kvmd-oled-shutdown - [root@pikvm ~]# systemctl enable --now kvmd-fan - [root@pikvm ~]# ro - ``` - -{!_fahrenheit.md!} - ## Further steps 1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface. 2. **Update and 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. + - We strongly recommend to update the PiKVM OS after the first launch: + + {!_update_os.md!} + + - [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. @@ -245,6 +233,24 @@ For security's sake, it's best to change the default passwords immediately after - Set up [ATX connection](atx_board.md). + - 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: + + ??? note "Enabling the OLED and the fan" + + Log in to PiKVM and run these commands: + + ```console + [root@pikvm ~]# rw + [root@pikvm ~]# systemctl enable --now kvmd-oled kvmd-oled-reboot kvmd-oled-shutdown + [root@pikvm ~]# systemctl enable --now kvmd-fan + [root@pikvm ~]# ro + ``` + + + - Choose Fahrenheit over Celsius to display on the OLED: + + {!_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). @@ -314,8 +320,6 @@ 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` - Note that this is not a hotplug device, and you must first turn off the power. - ## 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). diff --git a/docs/v4.md b/docs/v4.md index 0b457e0e..23ed1839 100644 --- a/docs/v4.md +++ b/docs/v4.md @@ -207,8 +207,11 @@ For security's sake, it's best to change the default passwords immediately after 2. **Update and 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. + - We strongly recommend to update the PiKVM OS after the first launch: + + {!_update_os.md!} + + - [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). - Enable [HDMI pass-through](pass.md). @@ -221,7 +224,9 @@ For security's sake, it's best to change the default passwords immediately after - 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). - - {!_fahrenheit.md!} + - Choose Fahrenheit over Celsius to display on the OLED: + + {!_fahrenheit.md!} ## Known issues and limitations @@ -238,8 +243,6 @@ For security's sake, it's best to change the default passwords immediately after * `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 If something doesn't work, check out our [FAQ](faq.md). Otherwise, head straight to our [Discord chat](https://discord.gg/bpmXfz5).