mirror of https://github.com/pikvm/pikvm.git
				
				
				
			Front matter, what's in the box, config update for material, placeholders
This commit is contained in:
		
							parent
							
								
									74d118c394
								
							
						
					
					
						commit
						12f6cb5a2d
					
				
							
								
								
									
										69
									
								
								docs/v4.md
								
								
								
								
							
							
						
						
									
										69
									
								
								docs/v4.md
								
								
								
								
							| 
						 | 
					@ -98,28 +98,79 @@ TBD
 | 
				
			||||||
 | 
					
 | 
				
			||||||

 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Use the power supply and turn on PiKVM. The Mini comes with USB-C 5V power supply, and Plus with Barrel 12V. Use the appropriate connector on the **front** side. Please note that Plus can also work from 5V, in this case, do not connect a 12V power supply and don't create a significant power load on USB (external flash sticks, cameras, and so on).
 | 
					V4 Mini and V4 Plus have different power supplies:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
**Do not** block the ventilation holes on the sides of the device. This is especially important for the V4 Plus, which has an active cooling.
 | 
					- The Mini comes with USB-C 5V power supply
 | 
				
			||||||
 | 
					- The Plus comes with with Barrel 12V
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Wait until PiKVM starts and shows a greeting on the built-in display. **Do not** turn off the device until it's fully booted for the first time.
 | 
					The Plus can also work from 5V. In that case, avoid creating a significant power load on USB (external flash sticks, cameras, and so on).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Update the OS
 | 
					Attach the appropriate connector on the **front** side. Do **not** block the ventilation holes on the sides of the device.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					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. Once it's done, the PiKVM will show a greeting on the built-in display.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Connect and set up
 | 
					## Connect and set up
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Obtain IP address
 | 
					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`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Connect via SSH
 | 
					Type the URL in the browser's address bar and press Enter: https://192.168.0.100/ or https://pikvm/.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Change the default passwords
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Submit the default credentials: use `admin` for both the user name and the password.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Open the web UI
 | 
					### Open the web UI
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Connect to the target system
 | 
					TODO
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### 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
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					2. Gain superuser privileges, use `root` for password:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    ```console
 | 
				
			||||||
 | 
					    $ su -
 | 
				
			||||||
 | 
					    ```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					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
 | 
				
			||||||
 | 
					    ```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					5. Change the password for web access:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    ```console
 | 
				
			||||||
 | 
					    [root@pikvm ~]# kvmd-htpasswd set admin
 | 
				
			||||||
 | 
					    ```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					6. Run `ro` to change the access to the SD card to the read-only mode:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Open a remote session
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					TODO
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Further steps
 | 
					## Further steps
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Update the OS
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					You can immediately [update](_update_os.md) to the latest version of the PiKVM operating system or skip to the next step.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Get to know the interface
 | 
					### Get to know the interface
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Read [this help section](webui.md) to better understand all the possibilities of the web user interface.
 | 
					Read [this help section](webui.md) to better understand all the possibilities of the web user interface.
 | 
				
			||||||
| 
						 | 
					@ -173,7 +224,7 @@ The V4 Plus has an internal USB port. It supports USB 3.0, but only works with U
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### HDMI pass-through
 | 
					### HDMI pass-through
 | 
				
			||||||
 | 
					
 | 
				
			||||||
You can pass the signal from the host device to its physical display through V4 Plus. Only resolutions of up to 1080p are supported. [See here](pass.md) for the guide.
 | 
					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
 | 
					### DIP switches
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -46,6 +46,8 @@ markdown_extensions:
 | 
				
			||||||
    - pymdownx.details
 | 
					    - pymdownx.details
 | 
				
			||||||
    - pymdownx.superfences
 | 
					    - pymdownx.superfences
 | 
				
			||||||
    - pymdownx.magiclink
 | 
					    - pymdownx.magiclink
 | 
				
			||||||
 | 
					    - pymdownx.tabbed:
 | 
				
			||||||
 | 
					        alternate_style: true
 | 
				
			||||||
    - toc:
 | 
					    - toc:
 | 
				
			||||||
        permalink: true
 | 
					        permalink: true
 | 
				
			||||||
    - codehilite:
 | 
					    - codehilite:
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue