diff --git a/docs/v1.md b/docs/v1.md index e1b1d9f4..42cf355b 100644 --- a/docs/v1.md +++ b/docs/v1.md @@ -63,8 +63,6 @@ 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:** @@ -110,35 +108,144 @@ 4. **[Flash firmware to the Pico HID.](pico_hid.md)** +## Wiring ------ -## Wiring with the target host +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. 1. Connect the HDMI video capture device to the video output port on the target host. 2. Connect the Pico HID to the USB port on the target host. -3. ??? example "Connect the ATX controller if you built it" +3. **Raspberry Pi 2/3**: connect **Ethernet** to the network, e.g., to the WiFI router. + +4. ??? example "Connect the ATX controller if you built it" {!_diy_wiring_atx.md!} +## Power up ------ -## Video modes +[Flash the memory card with PiKVM OS](https://docs.pikvm.org/flashing_os){target=_blank} and insert it to Raspberry Pi. -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. +Next, attach the power supply to the Raspberry Pi. -If you have any problems with video on CSI bridge, follow [this guide](edid.md). +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. +## Access PiKVM ------ -## First launch and usage +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. -{!_diy_first_launch.md!} +* **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. +* **Linux, MacOS, Windows:** Download and run [Angry IP Scanner](https://angryip.org). +* **Windows PowerShell:** Use the `arp -a` command. +Let's assume that PiKVM has received the address `192.168.0.26` and has also been assigned a hostname `pikvm`. + +Type the URL in the browser's address bar and press **Enter**: https://192.168.0.26/ or https://pikvm/. + +![Login screen](../v4/login-prompt.png) + +Submit the default credentials and click **Login**: + +- Username: `admin` +- 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: + +![Initial UI](../v4/initial-ui.png) + +### Change the default passwords + +For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time. 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: + + ![MISSING SCREENSHOT](../v4/pikvm-web-terminal-start.png) + +2. Gain superuser privileges: + + ```console + $ su - + ``` + + When prompted for password, use `root`. + +3. Run `rw` to change the access to the SD card to the write mode: + + ```console + [root@pikvm ~]# rw + ``` + +4. Change the password for the superuser: + + ```console + [root@pikvm ~]# passwd root + ``` + + Submit the new password, retype it the second time to confirm, press **Enter**, and you should see this: + + ```console + passwd: password updated successfully + ``` + +5. Change the password for web access: + + ```console + [root@pikvm ~]# kvmd-htpasswd set admin + ``` + + Submit the new password, retype it the second time to confirm, and press **Enter**. + +6. Run `ro` to change the access to the SD card back to the read-only mode: + + ```console + [root@pikvm ~]# ro + ``` + +7. Press **Ctrl+D** or type "exit" and press **Enter** to drop the root privileges. + +8. Go back one page in the browser. You should be back to the initial dashboard screen. + +### Access the remote system + +1. On the initial dashboard screen, click the **KVM** button to access the remote desktop. + +2. You should now see the host system's display and interact with it remotely using a keyboard and a mouse. + + ![Work remotely](../v4/remote-screen.png) + +## 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. + - Configure access to PiKVM from the Internet using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md). + +3. **Configure hardware**: + + - Set up [ATX connection](atx_board.md). + - Set up [USB 3.0](usb3v4.md) + +## 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). ------ ## 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). \ No newline at end of file diff --git a/docs/v2.md b/docs/v2.md index 9de24580..48998000 100644 --- a/docs/v2.md +++ b/docs/v2.md @@ -168,7 +168,9 @@ Let's connect all the wires before you power up the device. ## Power up -Attach the USB-C 5V power supply to the Raspberry Pi. +[Flash the memory card with PiKVM OS](https://docs.pikvm.org/flashing_os){target=_blank} and insert it to 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. Do **not** turn off the device until it's fully booted for the first time.