diff --git a/docs/_interface.md b/docs/_interface.md new file mode 100644 index 00000000..bb949632 --- /dev/null +++ b/docs/_interface.md @@ -0,0 +1,83 @@ +** 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 + + + +1) Click Proceed + +Log into you PiKVM using the credentials from the frst_steps document + + + +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 + + + +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 + + + +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 + The following is self explanatory but will highlight the important parts + +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. + This does not act like a clipboard + +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 + diff --git a/docs/interface/ATX.jpg b/docs/interface/ATX.jpg new file mode 100644 index 00000000..3e781361 Binary files /dev/null and b/docs/interface/ATX.jpg differ diff --git a/docs/interface/Drive.jpg b/docs/interface/Drive.jpg new file mode 100644 index 00000000..bbbb8f33 Binary files /dev/null and b/docs/interface/Drive.jpg differ diff --git a/docs/interface/Login.jpg b/docs/interface/Login.jpg new file mode 100644 index 00000000..7a9340b9 Binary files /dev/null and b/docs/interface/Login.jpg differ diff --git a/docs/interface/Macro.jpg b/docs/interface/Macro.jpg new file mode 100644 index 00000000..dec998d7 Binary files /dev/null and b/docs/interface/Macro.jpg differ diff --git a/docs/interface/Page1.jpg b/docs/interface/Page1.jpg new file mode 100644 index 00000000..c571d99c Binary files /dev/null and b/docs/interface/Page1.jpg differ diff --git a/docs/interface/Page2.jpg b/docs/interface/Page2.jpg new file mode 100644 index 00000000..eec693f9 Binary files /dev/null and b/docs/interface/Page2.jpg differ diff --git a/docs/interface/Portal.jpg b/docs/interface/Portal.jpg new file mode 100644 index 00000000..4f5466f3 Binary files /dev/null and b/docs/interface/Portal.jpg differ diff --git a/docs/interface/Shortcuts.jpg b/docs/interface/Shortcuts.jpg new file mode 100644 index 00000000..247fcba0 Binary files /dev/null and b/docs/interface/Shortcuts.jpg differ diff --git a/docs/interface/System.jpg b/docs/interface/System.jpg new file mode 100644 index 00000000..ea8006d0 Binary files /dev/null and b/docs/interface/System.jpg differ diff --git a/docs/interface/Text.jpg b/docs/interface/Text.jpg new file mode 100644 index 00000000..d47b48fd Binary files /dev/null and b/docs/interface/Text.jpg differ diff --git a/docs/interface/Toolbar.jpg b/docs/interface/Toolbar.jpg new file mode 100644 index 00000000..91dd8e13 Binary files /dev/null and b/docs/interface/Toolbar.jpg differ diff --git a/docs/interface/kvm window.jpg b/docs/interface/kvm window.jpg new file mode 100644 index 00000000..55a446d1 Binary files /dev/null and b/docs/interface/kvm window.jpg differ