diff --git a/docs/webui.md b/docs/webui.md index bef16b38..dd485035 100644 --- a/docs/webui.md +++ b/docs/webui.md @@ -1,74 +1,87 @@ -** GETTING TO KNOW THE INTERFACE ** +## GETTING TO KNOW THE INTERFACE After following the first steps document on setup, you will be presented with the following pages (Chrome is being used in the following examples) -1. Click Advanced +Click Advanced - + -1. Click Proceed +Click Proceed - Log into you PiKVM using the credentials from the frst_steps document +!!! note "Credentials are found in the first steps document that is located to the left" - + -1. This is where you fill in the login credentials, please be sure to review the first_steps document first. - This is also where you configure the 2FA token +This is where you fill in the login credentials, please be sure to review the first steps document first. +This is also where you configure the 2FA token - + -1. This is where your PiKVM name will go -2. This is where you can access the display from the Target system -3. You can open a web terminal and put in commands -4. By default this will not show up till its activated, this will tell you the VNC address you need to use -5. This is so you can logout of your PiKVM -6. Please read carefully -7. These are links to the PiKVM project, current documentation and support (Discord) -8. NOT SHOWN, in the lower left of the KVM screen is some information that when you mouse over, will let you know what they are +??? note "Please expand to see what each number represents" - + 1. This is where your PiKVM name will go - Please reference the first steps document on how to change this + 2. This is where you can access the display for the Target system + 3. You can open a web terminal and put in commands that you will find within these documents + 4. By default this will not show up till its activated, this will tell you the VNC address you need to use + 5. This is so you can logout of your PiKVM + 6. Please read carefully + 7. These are links to the PiKVM project, current documentation and support (Discord) + 8. **NOT SHOWN**, in the lower left of the KVM screen is some information that when you mouse over, will let you know what they are for -1. This is the system setting, more details will be shown below -2. This is the interface to controlling the ATX, will ONLY work if wired up correctly -3. This is part of the MSD and will show you what images/iso's are available -4. This is where you can program in a Macro (Ex. Hitting F2 to get into the bios, setting Infinite loop playback to on and doing other tasks) -5. This is where you can SEND text to the Target or using OCR, you can copy FROM the target, be mindful that OCR can make mistakes, please review before finalizing -6. This is where you can find most Shortcuts (Windows only, for now) (Not editable) -7. This is placed here to give you an idea what you can achieve if you make your own menu item + - +??? note "Please expand to see what each number represents" -!!! note - The following is self explanatory but will highlight the important parts + 1. This is the system setting, more details will be shown below + 2. This is the interface to controlling the ATX, will ONLY work if wired up correctly + 3. This is part of the MSD and will show you what images/iso's are available + 4. This is where you can program in a Macro (Ex. Hitting F2 to get into the bios, setting Infinite loop playback to on and doing other tasks) + 5. This is where you can SEND text to the Target or using OCR, you can copy FROM the target, be mindful that OCR can make mistakes, please review before finalizing + 6. This is where you can find most Shortcuts (Windows only, for now) (Not editable) + 7. This is placed here to give you an idea what you can achieve if you make your own menu item -1. System Icons - ETH Icon = PiKVM network connectivity - Monitor Icon = Shows if the target is sending an active signal - KeyBoard Icon = Shows if data for the KB is active, will likely show Orange/Green as data is passed and goes idle - Mouse Icon = Same as above -2. These are additional buttons for important acitivies - Term = Can launch a quick Web Terminal along with the active KVM - About = Shows everything About your PiKVM, including PiKVM Hardware and version - Log = Shows the current log from your PiKVM -3. ONLY for MJPEG mode -4. ONLY for H.264 (WebRTC) mode + - +!!! note "The following is self explanatory but will highlight the important parts" + + +??? note "Please expand to see what each number represents" + 1. System Icons + + ETH Icon = PiKVM network connectivity + + Monitor Icon = Shows if the target is sending an active signal + + KeyBoard Icon = Shows if data for the KB is active, will likely show Orange/Green as data is passed and goes idle + + Mouse Icon = Same as above + 2. These are additional buttons for important acitivies + + Term = Can launch a quick Web Terminal along with the active KVM + + About = Shows everything About your PiKVM, including PiKVM Hardware and version + + Log = Shows the current log from your PiKVM + + 3. ONLY for MJPEG mode + 4. ONLY for H.264 (WebRTC) mode + + 1. This ONLY works if you have the hardware connected to the MB, otherwise will not work - + 1. This is where you can select the IMG or ISO's that are stored - + 1. Please read and understand this section 2. This is where you can upload or Download your scripts - + !!! note This is not like VNC/AnyDesk/TeamViewer as these are software solutions, this is a hardware solution therefor cannot change the behavior of the target system. @@ -77,7 +90,7 @@ After following the first steps document on setup, you will be presented with th 1. This will allow you to paste text to the target system - Be mindful whats being pasted to the target and how 2. This will allow you to ONLY copy text from the target - Be mindful that OCR will do its best to recognize text but may fail at it - + -1. This shows the shortcuts for mostly Windows +1. This is an expanded view and shows the shortcuts for mostly Windows