mirror of https://github.com/pikvm/pikvm.git
				
				
				
			Separate OS update and ATX into a dedicated section
This commit is contained in:
		
							parent
							
								
									a437acc617
								
							
						
					
					
						commit
						16a7a6d8f4
					
				
							
								
								
									
										22
									
								
								docs/v1.md
								
								
								
								
							
							
						
						
									
										22
									
								
								docs/v1.md
								
								
								
								
							| 
						 | 
					@ -170,7 +170,11 @@ You will see the initial dashboard screen of the PiKVM where you can access the
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Change the default passwords
 | 
					### 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:
 | 
					For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					!!! danger "Please ensure that you change both passwords: for web UI access and for the superuser (root)"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					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:
 | 
					1. On the initial dashboard screen, click the **Terminal** button to open the web terminal. You will see this command line interface:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -228,21 +232,25 @@ For security's sake, it's best to change the default passwords immediately after
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    { width="450" }
 | 
					    { width="450" }
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Further steps
 | 
					## Important next steps
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- We strongly recommend to update the PiKVM OS after the first launch:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    {!_update_os.md!}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- Set up [ATX connection](atx_board.md) if you need to control the power of the remote system.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Further recommendations
 | 
				
			||||||
 | 
					
 | 
				
			||||||
1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
 | 
					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**:
 | 
					2. **Customize the system**:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    - [Update](_update_os.md) the PiKVM operating system.
 | 
					    - [Update](_update_os.md) the PiKVM operating system.
 | 
				
			||||||
    - [Harden the remote access](auth.md) by enabling 2FA and setting session expiration time.
 | 
					    - [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).
 | 
					    - Configure access to PiKVM from the Internet using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md).
 | 
				
			||||||
    - [Learn](config.md) how configuration files are structured.
 | 
					    - [Learn](config.md) how configuration files are structured.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
3. **Configure hardware**:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    - Set up [ATX connection](atx_board.md).
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Known issues and limitations
 | 
					## 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).
 | 
					**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).
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
							
								
								
									
										22
									
								
								docs/v2.md
								
								
								
								
							
							
						
						
									
										22
									
								
								docs/v2.md
								
								
								
								
							| 
						 | 
					@ -201,7 +201,11 @@ You will see the initial dashboard screen of the PiKVM where you can access the
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Change the default passwords
 | 
					### 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:
 | 
					For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					!!! danger "Please ensure that you change both passwords: for web UI access and for the superuser (root)"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					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:
 | 
					1. On the initial dashboard screen, click the **Terminal** button to open the web terminal. You will see this command line interface:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -259,21 +263,25 @@ For security's sake, it's best to change the default passwords immediately after
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    { width="450" }
 | 
					    { width="450" }
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Further steps
 | 
					## Important next steps
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- We strongly recommend to update the PiKVM OS after the first launch:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    {!_update_os.md!}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- Set up [ATX connection](atx_board.md) if you need to control the power of the remote system.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Further recommendations
 | 
				
			||||||
 | 
					
 | 
				
			||||||
1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
 | 
					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**:
 | 
					2. **Customize the system**:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    - [Update](_update_os.md) the PiKVM operating system.
 | 
					    - [Update](_update_os.md) the PiKVM operating system.
 | 
				
			||||||
    - [Harden the remote access](auth.md) by enabling 2FA and setting session expiration time.
 | 
					    - [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).
 | 
					    - Configure access to PiKVM from the Internet using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md).
 | 
				
			||||||
    - [Learn](config.md) how configuration files are structured.
 | 
					    - [Learn](config.md) how configuration files are structured.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
3. **Configure hardware**:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    - Set up [ATX connection](atx_board.md).
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## Known issues and limitations
 | 
					## Known issues and limitations
 | 
				
			||||||
 | 
					
 | 
				
			||||||
**Max resolution**. 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. If you have any problems with video on CSI bridge, follow [this guide](edid.md).
 | 
					**Max resolution**. 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. If you have any problems with video on CSI bridge, follow [this guide](edid.md).
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
							
								
								
									
										22
									
								
								docs/v3.md
								
								
								
								
							
							
						
						
									
										22
									
								
								docs/v3.md
								
								
								
								
							| 
						 | 
					@ -156,7 +156,11 @@ You will see the initial dashboard screen of the PiKVM where you can access the
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Change the default passwords
 | 
					### 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:
 | 
					For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					!!! danger "Please ensure that you change both passwords: for web UI access and for the superuser (root)"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					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:
 | 
					1. On the initial dashboard screen, click the **Terminal** button to open the web terminal. You will see this command line interface:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -214,16 +218,20 @@ For security's sake, it's best to change the default passwords immediately after
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    { width="450" }
 | 
					    { width="450" }
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Further steps
 | 
					## Important next 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**:
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
- We strongly recommend to update the PiKVM OS after the first launch:
 | 
					- We strongly recommend to update the PiKVM OS after the first launch:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    {!_update_os.md!}
 | 
					    {!_update_os.md!}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- Set up [ATX connection](atx_board.md) if you need to control the power of the remote system.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Further recommendations
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					2. **Customize the system**:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    - [Harden the remote access](auth.md) by enabling 2FA.
 | 
					    - [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).
 | 
					    - 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 a microphone for [two-way audio](audio.md).
 | 
				
			||||||
| 
						 | 
					@ -231,8 +239,6 @@ For security's sake, it's best to change the default passwords immediately after
 | 
				
			||||||
 | 
					
 | 
				
			||||||
3. **Configure hardware**:
 | 
					3. **Configure hardware**:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    - 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:
 | 
					    - 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"
 | 
					        ??? note "Enabling the OLED and the fan"
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
							
								
								
									
										21
									
								
								docs/v4.md
								
								
								
								
							
							
						
						
									
										21
									
								
								docs/v4.md
								
								
								
								
							| 
						 | 
					@ -143,7 +143,11 @@ You will see the initial dashboard screen of the PiKVM where you can access the
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Change the default passwords
 | 
					### 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:
 | 
					For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time. 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					!!! danger "Please ensure that you change both passwords: for web UI access and for the superuser (root)"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					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:
 | 
					1. On the initial dashboard screen, click the **Terminal** button to open the web terminal. You will see this command line interface:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -201,16 +205,20 @@ For security's sake, it's best to change the default passwords immediately after
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    { width="450" }
 | 
					    { width="450" }
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Further steps
 | 
					## Important next 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**:
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
- We strongly recommend to update the PiKVM OS after the first launch:
 | 
					- We strongly recommend to update the PiKVM OS after the first launch:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    {!_update_os.md!}
 | 
					    {!_update_os.md!}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- Set up [ATX connection](atx_board.md) if you need to control the power of the remote system.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Further recommendations
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					2. **Customize the system**:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    - [Harden the remote access](auth.md) by enabling 2FA.
 | 
					    - [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).
 | 
					    - 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 a microphone for [two-way audio](audio.md).
 | 
				
			||||||
| 
						 | 
					@ -219,7 +227,6 @@ For security's sake, it's best to change the default passwords immediately after
 | 
				
			||||||
 | 
					
 | 
				
			||||||
3. **Configure hardware**:
 | 
					3. **Configure hardware**:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    - Set up [ATX connection](atx_board.md).
 | 
					 | 
				
			||||||
    - Install and set up [Wi-Fi antenna](wifi.md).
 | 
					    - Install and set up [Wi-Fi antenna](wifi.md).
 | 
				
			||||||
    - Install and set up [LTE/5G modem](modem.md) (**only for PiKVM V4 Plus**).
 | 
					    - Install and set up [LTE/5G modem](modem.md) (**only for PiKVM V4 Plus**).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue