Merge pull request #71 from tryallthethings/documentation

Documentation

README.md

@@ -168,7 +168,17 @@ We are also currently developing our own HAT for the Raspberry Pi 4. It will hav
 # Setting up the hardware
 ## Connecting the video capture
 #### For the HDMI-CSI bridge
-Insert the flexible flat cable of the HDMI bridge into the narrow white connector on the Raspberry Pi (the closest one to big USB sockets). Make sure that the cable is inserted on the correct side and until it stops, and then snap the black latch. Never connect or disconnect the flat cable from a powered device. This is not Plug-and-Play, and you can damage it. Also use only the cable that was included with the device package, or make sure that the third-party cable has the correct pinout.
+Insert the flexible flat cable of the HDMI bridge into the narrow white connector on the Raspberry Pi (the closest one to big USB sockets). It is labeled CAMERA. To insert you need to open the connector first. On the Raspberry Pi side you can gently lift the black part up and a little bit sideways:
+
+| Opening the MIPI CSI-2 slot on the Raspberry Pi |
+|------------------------------------------------------|
+| <img src="img/open-MIPI-CSI2-Slot.png" alt="detailed picture of the MIPI-CSI2 slot" width="350"> |
+
+For the HDMI-CSI bridge it depends on the version you bought. Either pull it gently up as on the Raspberry or push it sideways. Make sure that the cable is inserted on the correct side and until it stops, and then push the black latch back. Never connect or disconnect the flat cable from a powered device. This is not Plug-and-Play, and you can damage it. Also use only the cable that was included with the device package, or make sure that the third-party cable has the correct pinout.
+
+| HDMI-CSI-2 bridge connected to Raspberry Pi 4 |
+|------------------------------------------------------|
+| <img src="img/rpi4-hdmi-csi-connection.png" alt="HDMI-CSI-2 bridge connected to Raspberry Pi 4" width="350">|
 
 #### For the HDMI-USB dongle
 Connect USB dongle to exactly this port. It is bound in the software so the OS does not confuse the video device with something else.

pages/cookbook.md

@@ -0,0 +1,50 @@
+# This Pi-KVM cookbook has some undocumented recipes for your Pi-KVM
+## Take a HDMI screenshot via console
+``` shell
+curl --unix-socket /run/kvmd/ustreamer.sock http://localhost/snapshot -o screen.jpg
+```
+
+## Get installed KVMD version via console
+``` shell
+pacman -Q | grep kvmd
+```
+
+## Upload .ISO images manually
+1. Remount internal storage to rw (read-write)
+``` shell
+kvmd-helper-otgmsd-remount rw
+```
+2. Upload the .ISO image(s) to `/var/lib/kvmd/msd/images` via scp or similar
+3. Create an empty file in `/var/lib/kvmd/msd/meta/` with the exact name (case sensitive!) of the uploaded image. This will indicate Pi-KVM that the uploaded image is okay and can be used. For example:
+``` shell
+var/lib/kvmd/msd/meta/ubuntu-18.04.4-desktop-amd64.iso.complete
+```
+4. Remount internal storage back to ro (read-only)
+``` shell
+kvmd-helper-otgmsd-remount ro
+```
+
+## Enable serial console on Pi-KVM
+1. Edit `/etc/kvmd/override.yaml` (Remove `{}` if this your first configuration entry) and add these lines:
+``` yaml
+otg:
+    acm:
+        enabled: true
+```
+2. Run the following command
+``` shell
+echo ttyGS0 >> /etc/securetty
+```
+3. Create the directory `/etc/systemd/system/getty@ttyGS0.service.d` and add a file file named `ttyGS0.override` into it. Afterwards edit the file and copy this into it:
+```
+[Service]
+TTYReset=no
+TTYVHangup=no
+TTYVTDisallocate=no
+```
+4. Run these comands
+``` shell
+systemctl enable getty@ttyGS0.service
+reboot
+```
+5. Once Pi-KVM is rebooted you will have access to a virtual serial port on the server that the USB is connected to. Use mingetty, screen, putty, or something like this to access the kvm from the server. The port is called `/dev/ttyAMA0`.

pages/troubleshooting.md

@@ -0,0 +1,26 @@
+# Troubleshooting Pi-KVM / FAQ
+As a first step we recommend carefully reading our documentation on [GitHub](https://github.com/pikvm/pikvm). Most steps to successfully set up your Pi-KVM are already described there. If you run into any issues you can check this Troubleshooting guide which will list common errors. If that still doesn't help you you're welcome to raise an [issue ticket](https://github.com/pikvm/pikvm/issues) or [join our Discord](https://discord.gg/bpmXfz5) for further help
+
+## Hardware
+### LEDs / Switches do not work in ATX control.
+- Double check your wiring as per [the documentation](https://github.com/tryallthethings/pikvm/tree/documentation#setting-up-the-v2). Make sure you placed the relays (G3VM-61A1) in the correct orientation. The relays for switches (Power, Reset) have a different orientation than the ones for LEDs.
+
+### Pi-KVM does not show any image from the connected computer.
+- Double check if you connected the HDMI-CSI-2 bridge cable correctly. [Check the documentation for details](https://github.com/tryallthethings/pikvm/tree/documentation#for-the-hdmi-csi-bridge) A red LED will light up on the bridge if it is connected properly. 
+- Some laptops do not output any signal until you switched the ouput (usually via the FN + and an F5 key on the keyboard). 
+
+## Software
+### How do I update Pi-KVM with the latest software?
+- Connect to your Pi-KVM via ssh and run 
+```
+rw
+pacman -Syu
+reboot
+```
+
+### The Pi-KVM web interface does not work correctly in Mozilla Firefox while it works fine in Google Chrome.
+- This might be related to your specific hardware combination or browser hardware acceleration. Try [disabling hardware acceleration in Firefox](https://support.mozilla.org/en-US/kb/hardware-acceleration-and-windowblinds-crash) or updating your GPU and chipset drivers.
+
+### I can't copy clipboard contents from the server (the machine controlled via Pi-KVM) to the client.
+- The clipboard only works from the client to the server not vice versa. There is currently no way to do it.
+