mirror of https://github.com/pikvm/pikvm.git
Reorganize V4 quick start page a little
This commit is contained in:
Aleksandr Prokudin
parent
9c9d66e198
commit
2a649f64fd
128
docs/v4.md
128
docs/v4.md
|
|
@ -38,7 +38,7 @@ You can use your remote keyboard and mouse or PiKVM can simulate a keyboard, mou
|
|||
1. Activity LED (Red)
|
||||
2. Power LED (Green)
|
||||
3. Power Input 5.1V 3A
|
||||
4. Power Input 12V 2A
|
||||
4. Power Input 12V 2A **(V4 Plus only)**
|
||||
5. Micro SD card slot
|
||||
6. USB 3.0 port 1
|
||||
7. RJ45 Serial console port
|
||||
|
|
@ -50,17 +50,17 @@ You can use your remote keyboard and mouse or PiKVM can simulate a keyboard, mou
|
|||
|
||||
|
||||
|
||||
11. Beacon LED
|
||||
12. USB 2.0 OTG connector
|
||||
13. RJ45 ATX control port
|
||||
14. USB 3.0 port 2
|
||||
15. HDMI video output port 1
|
||||
16. HDMI video output port 2
|
||||
17. Optional antenna’s mounting holes
|
||||
18. Video source ready status LED
|
||||
19. HDMI video input port
|
||||
20. Video capture ready status LED
|
||||
21. Ventilation holes
|
||||
1. Beacon LED
|
||||
2. USB 2.0 OTG connector
|
||||
3. RJ45 ATX control port
|
||||
4. USB 3.0 port 2
|
||||
5. HDMI video output port 1
|
||||
6. HDMI video output port 2
|
||||
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"
|
||||
|
||||
|
|
@ -113,6 +113,8 @@ After turning on the power, PiKVM OS generates unique SSH keys and certificates
|
|||
|
||||
## Connect and set up
|
||||
|
||||
### 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.100` and has also been assigned a hostname `pikvm`.
|
||||
|
||||
Type the URL in the browser's address bar and press Enter: https://192.168.0.100/ or https://pikvm/.
|
||||
|
|
@ -123,9 +125,9 @@ Submit the default credentials: use `admin` for both the user name and the passw
|
|||
|
||||
|
||||
|
||||
### Open the web UI
|
||||
You will see PiKVM's web user interface:
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
### Change the default passwords
|
||||
|
||||
|
|
@ -133,7 +135,7 @@ For security's sake, it's best to change the default passwords immediately after
|
|||
|
||||
1. Open the web terminal
|
||||
|
||||
|
||||
|
||||
|
||||
2. Gain superuser privileges, use `root` for password:
|
||||
|
||||
|
|
@ -161,85 +163,39 @@ For security's sake, it's best to change the default passwords immediately after
|
|||
|
||||
6. Run `ro` to change the access to the SD card to the read-only mode:
|
||||
|
||||
### Open a remote session
|
||||
### Access the remote system
|
||||
|
||||
TODO
|
||||
1. Open your browser, go to https://<your-remote-access-url>, and log in using your credentials.
|
||||
|
||||
|
||||
|
||||
2. Go to the "Video" tab.
|
||||
|
||||
|
||||
|
||||
3. You should now see the host system's display and interact with it remotely using a keyboard and a mouse.
|
||||
|
||||
|
||||
|
||||
## Further steps
|
||||
|
||||
### Update the OS
|
||||
1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
|
||||
You can immediately [update](_update_os.md) to the latest version of the PiKVM operating system or skip to the next step.
|
||||
2. **Update and customize the system**:
|
||||
|
||||
### Get to know the interface
|
||||
- [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).
|
||||
- Enable a microphone for [two-way audio](audio.md).
|
||||
- Enable [HDMI pass-through](pass.md).
|
||||
|
||||
Read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
3. **Configure hardware**:
|
||||
|
||||
### Set up Internet access
|
||||
|
||||
Configure access to PiKVM from the Internet using [port forwarding](https://docs.pikvm.org/port_forwarding) or [Tailscale VPN](https://docs.pikvm.org/tailscale).
|
||||
|
||||
### Set up ATX connection
|
||||
|
||||
[See here](atx_board.md).
|
||||
|
||||
### Configure audio
|
||||
|
||||
You can enable a microphone for two-way audio if you like. [See here](audio.md) for the guide.
|
||||
|
||||
### Networking options
|
||||
|
||||
- **Wi-Fi antenna**. The PiKVM V4 has a robust metal case that protects your device from physical damage and electromagnetic interference. Install an an external antenna to be able to use Wi-Fi. Follow [this guide](wifi.md).
|
||||
- **LTE/5G modem**. With PiKVM V4 **Plus**, you can use the internal Mini-PCI and built-in SIM card slot to install a modem and thus create a portable solution or ensure the availability of the device for emergency access to the host. [See here](modem.md) for a detailed guide.
|
||||
|
||||
### USB 3.0 support
|
||||
|
||||
The V4 Plus has an internal USB port. It supports USB 3.0, but only works with USB 2.0 devices by default to minimize the power consumption. You need to flash the USB controller to enable USB 3.0. Follow these steps:
|
||||
|
||||
1. Open a terminal window and log into the PiKVM via SSH:
|
||||
|
||||
```console
|
||||
$ ssh user@host
|
||||
```
|
||||
|
||||
2. Flash the USB controller using the built-in `flashrom` utility. Choose `usb3` for USB 3.0 support:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# flashrom-vl805 usb3
|
||||
```
|
||||
|
||||
If you need to disable USB 3.0 support at any time later, run the same command, but use `default` instead:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# flashrom-vl805 default
|
||||
```
|
||||
|
||||
3. Perform the soft reboot:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# reboot
|
||||
```
|
||||
|
||||
4. After the soft reboot, perform the **reboot by power**: unplug and plug again the power cable.
|
||||
|
||||
### HDMI pass-through
|
||||
|
||||
You can pass the signal from the host device to its physical display through V4 Plus. Only resolutions of up to 1920x1200 pixels are supported. [See here](pass.md) for the guide.
|
||||
|
||||
### DIP switches
|
||||
|
||||
There is a pair of DIP switches on the V4 right side. It is not recommended to change their state while the device is turned on.
|
||||
|
||||
| Right side |
|
||||
|------------|
|
||||
| <img src="plus_right.jpg" width="450" /> |
|
||||
|
||||
* The left switch **[1]**. When pulled down (**ON** state), the advanced backpower protection is used.
|
||||
On the default state is **OFF** (up), "diode protection" is used.
|
||||
This is required for debugging at the request of technical support. Under normal conditions, it is not necessary to change the mode.
|
||||
|
||||
* The right switch **[2]**. When pulled down (**ON** state), the Power Delivery chip is activated on the USB OTG port.
|
||||
The default state is **OFF** (up).
|
||||
- Set up [ATX connection](atx_board.md).
|
||||
- Configure [DIP switches](dip_switches.md)
|
||||
- Install and set up [Wi-Fi antenna](wifi.md).
|
||||
- Install and set up [LTE/5G modem](modem.md) (**only for PiKVM V4 Plus**).
|
||||
- Set up [USB 3.0](usb3v4.md) (**only for PiKVM V4 Plus**).
|
||||
|
||||
-----
|
||||
## Known issues and limitations
|
||||
|
|
|
|||
Loading…
Reference in New Issue