diff --git a/docs/v4.md b/docs/v4.md index 3ae9a326..b4a12977 100644 --- a/docs/v4.md +++ b/docs/v4.md @@ -33,38 +33,39 @@ You can use your remote keyboard and mouse or PiKVM can simulate a keyboard, mou === "Front view" - ![MISSING FRONT VIEW IMAGE](v4-plus-front-view.jpg) + ![MISSING FRONT VIEW IMAGE](v4-plus-front-view.svg){ width="300" } 1. Activity LED (Red) 2. Power LED (Green) 3. Power Input 5.1V 3A 4. Power Input 12V 2A **(V4 Plus only)** 5. Micro SD card slot - 6. USB 3.0 port 1 - 7. RJ45 Serial console port + 6. USB 3.0 port 1 **(V4 Plus only)** + 7. RJ45 Serial console port **(V4 Plus only)** 8. RJ45 1Gb Ethernet port 9. Serial console active LED / Beacon LED (Green) 10. USB 2.0 Serial console port === "Rear view" - ![MISSING REAR VIEW IMAGE](v4-plus-rear-view.jpg) + ![MISSING REAR VIEW IMAGE](v4-plus-front-view.svg){ width="300" } 1. Beacon LED 2. USB 2.0 OTG connector + 3. Mount holes for WiFi SMA antenna connector **(only one in V4 Mini)** 3. RJ45 ATX control port - 4. USB 3.0 port 2 - 5. HDMI video output port 1 - 6. HDMI video output port 2 + 4. USB 3.0 port 2 **(V4 Plus only)** + 5. HDMI video output port 1 **(V4 Plus only)** + 6. HDMI video output port 2 **(V4 Plus only)** 7. Optional antenna’s mounting holes 8. Video source ready status LED 9. HDMI video input port 10. Video capture ready status LED 11. Ventilation holes -=== "Side view" +=== "Right view" - ![MISSING SIDE VIEW IMAGE](v4-plus-side-view.jpg) + ![MISSING SIDE VIEW IMAGE](v4-plus-front-view.svg){ width="300" } 1. Ventilation holes 2. Service switches @@ -72,12 +73,14 @@ You can use your remote keyboard and mouse or PiKVM can simulate a keyboard, mou === "Top view" - ![MISSING TOP VIEW IMAGE](v4-plus-top-view.jpg) + ![MISSING TOP VIEW IMAGE](v4-plus-front-view.svg){ width="300" } 1. Display ## Wiring +Let's connect all the wires before you power up the device. + ### Network ![MISSING ETHERNET IMAGE](ethernet-connection.jpg) @@ -121,34 +124,46 @@ To avoid that, go to the display settings in your remote computer's operating sy ### Access PiKVM -By default, PiKVM receives a dynamic IP address via DHCP and shows it on the OLED display. Let's assume that PiKVM has received the address `192.168.0.26` and has also been assigned a hostname `pikvm`. +By default, PiKVM receives a dynamic IP address via DHCP and shows it in the top row of the OLED display: -Type the URL in the browser's address bar and press Enter: https://192.168.0.26/ or https://pikvm/. +```console +192.168.0.26 +(|) iface: eth0 +cpu: 1% mem: 13% +``` -![MISSING LOGIN SCREEN](log-in-form.png) +Let's assume that PiKVM has received the address `192.168.0.26` and has also been assigned a hostname `pikvm`. -Submit the default credentials: use `admin` for both the user name and the password. +Type the URL in the browser's address bar and press **Enter**: https://192.168.0.26/ or https://pikvm/. -![MISSING LOGIN SCREEN](log-in-form.png) +![Login screen](login-prompt.png) -You will see PiKVM's web user interface: +Submit the default credentials and click **Login**: -![MISSING WEBUI SCREEN](log-in-form.png) +- 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](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. Open the web terminal +1. On the initial dashboard screen, click the **Terminal** button to open the web terminal. You will see this command line interface: - ![MISSING SCREENSHOT](web-terminal.png) + ![MISSING SCREENSHOT](pikvm-web-terminal-start.png) -2. Gain superuser privileges, use `root` for password: +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 @@ -161,7 +176,7 @@ For security's sake, it's best to change the default passwords immediately after [root@pikvm ~]# passwd root ``` - Submit the new password, retype it the second time to confirm, press Enter, and you should see this: + Submit the new password, retype it the second time to confirm, press **Enter**, and you should see this: ```console passwd: password updated successfully @@ -173,7 +188,7 @@ For security's sake, it's best to change the default passwords immediately after [root@pikvm ~]# kvmd-htpasswd set admin ``` - Submit the new password, retype it the second time to confirm, and press Enter. + 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: @@ -181,19 +196,17 @@ For security's sake, it's best to change the default passwords immediately after [root@pikvm ~]# ro ``` -7. Press **Ctrl+D** to drop the root priveleges. +7. Press **Ctrl+D** to drop the root privileges. -8. Go back one page in the browser. You should be back to the initial screen. +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 PiKVM screen, click the KVM button to access the remote computer. - - ![Log into PiKVM remotely](logging-in.png) +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](work-remotely.png) + ![Work remotely](remote-screen.png) ## Further steps @@ -224,4 +237,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) (it's really useful). If nothing helped, you can get support in our [Discord chat](https://discord.gg/bpmXfz5). \ No newline at end of file +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/v4/initial-ui.png b/docs/v4/initial-ui.png new file mode 100644 index 00000000..d32ef931 Binary files /dev/null and b/docs/v4/initial-ui.png differ diff --git a/docs/v4/login-prompt.png b/docs/v4/login-prompt.png new file mode 100644 index 00000000..d8de4c19 Binary files /dev/null and b/docs/v4/login-prompt.png differ diff --git a/docs/v4/pikvm-web-terminal-start.png b/docs/v4/pikvm-web-terminal-start.png new file mode 100644 index 00000000..5af392b6 Binary files /dev/null and b/docs/v4/pikvm-web-terminal-start.png differ diff --git a/docs/v4/remote-screen.png b/docs/v4/remote-screen.png new file mode 100644 index 00000000..1842f368 Binary files /dev/null and b/docs/v4/remote-screen.png differ