mirror of https://github.com/pikvm/pikvm
Update README.md
parent
b05c61febd
commit
70eebd5c59
@ -1 +1,284 @@
|
||||
# demo-howto
|
||||
# DIY IP KVM System with WEB-interface using Raspberry Pi
|
||||
Stand-alone IP KVM device with web interface with various video capture options and bunch of features like keyboard/mouse control, ATX control (power/reset/ HDD load), Mass-Storage Device.
|
||||
|
||||
![Screenshot](https://github.com/Fmstrat/diy-ipmi/raw/master/Resources/Screenshot.png)
|
||||
|
||||
## Minimal hardware implementation
|
||||
- Raspberry Pi 2, 3 or 4(work in progress)
|
||||
- MicroSD card
|
||||
- Raspberry Pi power supply
|
||||
- Arduino Pro Micro with hardware USB for HID sub-system
|
||||
- GPIO cables
|
||||
|
||||
- Relay board (https://www.amazon.com/dp/B0057OC5WK)
|
||||
- Easycap UTV007 device (https://www.amazon.com/dp/B0126O0RDC)
|
||||
- HDMI to S-Video (not all options work, but these two have been tested) (https://www.amazon.com/dp/B012MDMWLM or https://www.amazon.com/gp/product/B01E56CV42)
|
||||
- USB TTL Serial cable (https://www.amazon.com/gp/product/B00QT7LQ88)
|
||||
|
||||
A full wishlist totaling under $120 at the time of this writing can be found at http://a.co/36FK9T8
|
||||
|
||||
## Before assembling
|
||||
|
||||
On the Pi3, flash http://downloads.raspberrypi.org/raspbian_lite/images/raspbian_lite-2017-09-08/. As of this writing you may use the latest Stretch version, however this was the version used successfully.
|
||||
|
||||
On the Pi0, flash http://downloads.raspberrypi.org/raspbian_lite/images/raspbian_lite-2017-03-03/. You must use this version for this to work. There aren't really security implications since the Pi0 can only be accessed from a serial session on the Pi3.
|
||||
|
||||
Before putting the SD into the Pi0, add this to the end of /boot/config.txt:
|
||||
```
|
||||
dtoverlay=dwc2
|
||||
enable_uart=1
|
||||
```
|
||||
|
||||
Before putting the SD into the Pi3, create a blank file called `SSH` on the boot drive to enable SSH.
|
||||
|
||||
Also, if you will be connecting via Wifi, create a file in boot called `wpa_supplicant.conf` that uses unix based line feeds. To ensure that is the case, use `Notepad++` or another editor that allows you to change line feed types (bottom right), or copy the `config.txt` file and rename it. Include the following:
|
||||
```
|
||||
ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev
|
||||
update_config=1
|
||||
country=US
|
||||
|
||||
network={
|
||||
ssid="NETWORKNAME"
|
||||
psk="PASSWORD"
|
||||
key_mgmt=WPA-PSK
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## Setting up the hardware
|
||||
Here is a diagram of how you connect all of the pieces:
|
||||
|
||||
![Diagram](https://github.com/Fmstrat/diy-ipmi/raw/master/Resources/Diagram-sm.png)
|
||||
|
||||
View the [high resolution version](https://raw.githubusercontent.com/Fmstrat/diy-ipmi/master/Resources/Diagram.png)
|
||||
|
||||
The detailed process is to:
|
||||
- Connect the Pi3 to the relay board using this method: http://youtu.be/oaf_zQcrg7g
|
||||
- Connect the Pi0 to the Pi3 using this method: https://www.thepolyglotdeveloper.com/2017/02/connect-raspberry-pi-pi-zero-usb-ttl-serial-cable/. You do not need to supply power to the Pi0, it will get power via the GPIO pins.
|
||||
- Plug the easycap device and the USB TTL device into the USB ports on the Pi3
|
||||
- Connect the HDMI out of your computer into the HDMI to S-Video box, and connect it to the EasyCap device via an S-Video cable
|
||||
- Connect the Pi0 to the server via a microUSB to USB male cable
|
||||
|
||||
|
||||
## Quick Install
|
||||
The quick method of installation is to simply run the install script on the Pi3 as the `pi` user:
|
||||
```
|
||||
wget https://raw.githubusercontent.com/Fmstrat/diy-ipmi/master/install.sh
|
||||
chmod +x install.sh
|
||||
./install.sh
|
||||
```
|
||||
Everything will be done on the Pi3 and Pi0 automatically with the video input defaulting to s-video.
|
||||
|
||||
If you would like to manage multiple servers with one IPMI system, please see the [Managing multiple servers](#managing-multiple-servers) section below.
|
||||
|
||||
Be sure to check the bottom of this README for [Tips](#tips) and [Troubleshooting](#troubleshooting)!
|
||||
|
||||
|
||||
## The long way
|
||||
If you would like to do things step by step to understand how things work, the following instructions can be used.
|
||||
|
||||
#### Setting up the Pi 3
|
||||
|
||||
First, let's get all the software we need:
|
||||
```
|
||||
sudo apt-get update
|
||||
sudo apt-get -y install libav-tools screen lighttpd php php-cgi git
|
||||
cd /opt
|
||||
sudo git clone https://github.com/Fmstrat/diy-ipmi
|
||||
sudo chown pi diy-ipmi -R
|
||||
chmod +x /opt/diy-ipmi/Pi3/*.py
|
||||
chmod +x /opt/diy-ipmi/Pi3/*.sh
|
||||
```
|
||||
|
||||
To test the ability to reboot the computer via the relay board, run:
|
||||
```
|
||||
/opt/diy-ipmi/Pi3/rebootServer.py
|
||||
```
|
||||
Test this script to see if it resets the computer. If you are interested, look in the python script to see the numbers associated with which of the 8 relays you could use for multiple computers.
|
||||
|
||||
Next, set up the HTTP server.
|
||||
```
|
||||
|
||||
read -s -p "Password for web IPMI console (user 'ipmi'): " IPMIPASS
|
||||
echo ""
|
||||
echo "ipmi:${IPMIPASS}" | sudo tee --append /var/www/ipmipasswd
|
||||
|
||||
sudo lighty-enable-mod fastcgi-php
|
||||
echo '' | sudo tee --append /etc/lighttpd/lighttpd.conf
|
||||
sudo adduser www-data gpio
|
||||
echo 'server.modules += ( "mod_auth" )' | sudo tee --append /etc/lighttpd/lighttpd.conf
|
||||
echo 'auth.debug = 2' | sudo tee --append /etc/lighttpd/lighttpd.conf
|
||||
echo 'auth.backend = "plain"' | sudo tee --append /etc/lighttpd/lighttpd.conf
|
||||
echo 'auth.backend.plain.userfile = "/var/www/ipmipasswd"' | sudo tee --append /etc/lighttpd/lighttpd.conf
|
||||
echo 'auth.require = ( "/" =>' | sudo tee --append /etc/lighttpd/lighttpd.conf
|
||||
echo ' (' | sudo tee --append /etc/lighttpd/lighttpd.conf
|
||||
echo ' "method" => "basic",' | sudo tee --append /etc/lighttpd/lighttpd.conf
|
||||
echo ' "realm" => "Password protected area",' | sudo tee --append /etc/lighttpd/lighttpd.conf
|
||||
echo ' "require" => "user=ipmi"' | sudo tee --append /etc/lighttpd/lighttpd.conf
|
||||
echo ' )' | sudo tee --append /etc/lighttpd/lighttpd.conf
|
||||
echo ')' | sudo tee --append /etc/lighttpd/lighttpd.conf
|
||||
|
||||
cd /var/www/
|
||||
sudo mv /var/www/html /var/www/html.orig
|
||||
sudo ln -s /opt/diy-ipmi/Pi3/html /var/www/html
|
||||
|
||||
echo '[Server 1]' | sudo tee --append /etc/ipmi.conf
|
||||
echo 'TTY=/dev/ttyUSB0' | sudo tee --append /etc/ipmi.conf
|
||||
echo 'VID=/dev/video0' | sudo tee --append /etc/ipmi.conf
|
||||
echo 'INP=1' | sudo tee --append /etc/ipmi.conf
|
||||
echo 'PIN=2' | sudo tee --append /etc/ipmi.conf
|
||||
|
||||
sudo service lighttpd force-reload
|
||||
sudo systemctl restart lighttpd
|
||||
sudo systemctl enable lighttpd
|
||||
```
|
||||
|
||||
Lastly, get everything running right by completing some tasks and updating `/etc/rc.local` to ensure they happen at boot:
|
||||
```
|
||||
sudo chmod a+rw /dev/video0
|
||||
sudo mkdir -p /mnt/ramdisk
|
||||
sudo mount -t tmpfs -o size=3m tmps /mnt/ramdisk
|
||||
sudo chown www-data /mnt/ramdisk
|
||||
sudo v4l2-ctl -d /dev/video0 --set-input=1
|
||||
sudo chmod a+rw /dev/ttyUSB0
|
||||
|
||||
sudo sed -i 's/exit 0//g' /etc/rc.local
|
||||
echo "chmod a+rw /dev/video0" | sudo tee --append /etc/rc.local
|
||||
echo "mkdir -p /mnt/ramdisk" | sudo tee --append /etc/rc.local
|
||||
echo "mount -t tmpfs -o size=3m tmps /mnt/ramdisk" | sudo tee --append /etc/rc.local
|
||||
echo "chown www-data /mnt/ramdisk" | sudo tee --append /etc/rc.local
|
||||
echo "v4l2-ctl -d /dev/video0 --set-input=1" | sudo tee --append /etc/rc.local
|
||||
echo "chmod a+rw /dev/ttyUSB0" | sudo tee --append /etc/rc.local
|
||||
echo "exit 0" | sudo tee --append /etc/rc.local
|
||||
```
|
||||
|
||||
#### Setting up the Pi 0
|
||||
|
||||
Make sure you can access the Pi0 from the Pi3 by running:
|
||||
```
|
||||
screen /dev/ttyUSB0 115200
|
||||
```
|
||||
Press enter until you see a login prompt. Do not login. Instead, exit the session by hitting `Control-A` then typing `:quit` and pressing enter.
|
||||
|
||||
On the Pi3, run:
|
||||
```
|
||||
/opt/diy-ipmi/Pi3/checkPi0Login.sh
|
||||
|
||||
echo "sudo systemctl enable serial-getty@ttyAMA0.service" >> /dev/ttyUSB0
|
||||
echo "sudo cp /lib/systemd/system/serial-getty@.service /etc/systemd/system/serial-getty@ttyAMA0.service" >> /dev/ttyUSB0
|
||||
echo "sudo sed -i 's/agetty --keep-baud 115200/agetty -a pi --keep-baud 115200/g' /etc/systemd/system/serial-getty@ttyAMA0.service" >> /dev/ttyUSB0
|
||||
echo "sudo systemctl daemon-reload" >> /dev/ttyUSB0
|
||||
|
||||
echo "sudo systemctl disable networking" >> /dev/ttyUSB0
|
||||
echo "sudo apt-get -y remove dhcpcd5 isc-dhcp-client isc-dhcp-common" >> /dev/ttyUSB0
|
||||
sleep 60
|
||||
|
||||
echo "rm -f /tmp/B64" >> /dev/ttyUSB0
|
||||
for LINE in $(base64 /opt/diy-ipmi/Pi0/enableHID.sh); do echo "echo $LINE >> /tmp/B64" >> /dev/ttyUSB0; done
|
||||
echo "base64 -d /tmp/B64 > /home/pi/enableHID.sh" >> /dev/ttyUSB0
|
||||
echo "chmod +x /home/pi/enableHID.sh" >> /dev/ttyUSB0
|
||||
|
||||
echo "rm -f /tmp/B64" >> /dev/ttyUSB0
|
||||
for LINE in $(base64 /opt/diy-ipmi/Pi0/sendkeys.c); do echo "echo $LINE >> /tmp/B64" >> /dev/ttyUSB0; done
|
||||
echo "base64 -d /tmp/B64 > /home/pi/sendkeys.c" >> /dev/ttyUSB0
|
||||
echo "gcc -o /home/pi/sendkeys /home/pi/sendkeys.c" >> /dev/ttyUSB0
|
||||
|
||||
sudo apt-get -y install libusb-dev
|
||||
cd /opt/diy-ipmi/Pi0/
|
||||
gcc -o hub-ctrl hub-ctrl.c -lusb
|
||||
for LINE in $(base64 hub-ctrl); do echo "echo $LINE >> /tmp/B64" >> /dev/ttyUSB0; done
|
||||
echo "base64 -d /tmp/B64 > /home/pi/hub-ctrl" >> /dev/ttyUSB0
|
||||
echo "chmod +x /home/pi/hub-ctrl" >> /dev/ttyUSB0
|
||||
cd -
|
||||
|
||||
echo "sudo /home/pi/enableHID.sh" >> /dev/ttyUSB0
|
||||
echo "sudo sed -i 's/exit 0//g' /etc/rc.local" >> /dev/ttyUSB0
|
||||
echo "echo /home/pi/enableHID.sh | sudo tee --append /etc/rc.local" >> /dev/ttyUSB0
|
||||
echo "echo exit 0 | sudo tee --append /etc/rc.local" >> /dev/ttyUSB0
|
||||
```
|
||||
|
||||
#### Access the IPMI
|
||||
You should now be able to access the IPMI console at `http://<RaspberryPi3IP>/`. From here you can set up SSL and port forwarding to the device as your situation requires.
|
||||
|
||||
|
||||
## Managing multiple servers
|
||||
Multiple servers can be managed by using multile USB capture devices (one per server), multiple USB-to-Serial adapters each with their own Pi0 (one per server), and using one of the 8 relays on the relay board as the reset button. Once installed, edit `/etc/ipmi.conf`. The format should be:
|
||||
```
|
||||
[My first server]
|
||||
TTY=/dev/ttyUSB0
|
||||
VID=/dev/video0
|
||||
INP=1
|
||||
PIN=2
|
||||
|
||||
[My second server]
|
||||
TTY=/dev/ttyUSB1
|
||||
VID=/dev/video1
|
||||
INP=1
|
||||
PIN=3
|
||||
```
|
||||
- When hooking up multiple TV tuners and USB-to-Serial devices to Pi0s, it is recommended to use a powered USB hub.
|
||||
- The `INP` field is `1` for s-video or `0` for composite. You can actually use one capture device for two servers by using both inputs.
|
||||
- The `PIN` value is the pin on the relay board. The valid values are `2`, `3`, `4`, `17`, `27`, `22`, `10`, `9`.
|
||||
|
||||
|
||||
## Tips
|
||||
If you're using this on a Linux headless machine that's not running X11, it's easier to read the console if things are nice and big. Disabling the video driver is an easy way to accomplish this as it will just default to a generic NTSC or PAL signal. For instance, with an nVidia card, you could follow these directoins: https://askubuntu.com/questions/481414/install-nvidia-driver-instead-of-nouveau
|
||||
|
||||
To enable SSL, you need a combined PEM file which can be created by:
|
||||
```
|
||||
cat myserver.key mycert.crt myca.ca-bundle > mypem.pem
|
||||
```
|
||||
Then add this into the `/etc/lighttpd/lighttpd.conf` file (editing as required):
|
||||
```
|
||||
$SERVER["socket"] == ":443" {
|
||||
ssl.engine = "enable"
|
||||
ssl.pemfile = "/opt/certs/mypem.pem"
|
||||
server.name = "host.domain.com"
|
||||
server.document-root = "/var/www/html"
|
||||
ssl.use-sslv2 = "disable"
|
||||
ssl.use-sslv3 = "disable"
|
||||
ssl.use-compression = "disable"
|
||||
ssl.honor-cipher-order = "enable"
|
||||
ssl.cipher-list = "ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-RC4-SHA:ECDHE-RSA-RC4-SHA:ECDH-ECDSA-RC4-SHA:ECDH-RSA-RC4-SHA:ECDHE-RSA-AES256-SHA:RC4-SHA"
|
||||
server.errorlog = "/var/log/lighttpd/serror.log"
|
||||
accesslog.filename = "/var/log/lighttpd/saccess.log"
|
||||
}
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If you're not getting video, here are some troubleshooting methods:
|
||||
|
||||
First make sure the `INP` field in `/etc/ipmi.conf` is set to the right input. Input 0 is usually Composite, and Input 1 is usually S-Video.
|
||||
|
||||
Connect a source and test to see if it's working.
|
||||
```
|
||||
apt-get install mencoder
|
||||
mencoder tv:// -tv driver=v4l2:norm=NTSC:device=/dev/video0:input=1:fps=5 -nosound -ovc copy -o test.avi
|
||||
v4l2-ctl -d /dev/video0 --set-input=1
|
||||
avconv -f video4linux2 -i /dev/video0 -vframes 1 -s 720x480 test.jpg
|
||||
```
|
||||
Control-C that, and sftp the files to a host for viewing and playback:
|
||||
```
|
||||
sftp test.avi root@hostname:/folder/test.avi
|
||||
sftp test.avi root@hostname:/folder/test.jpg
|
||||
```
|
||||
|
||||
You can test keyboard control from the Pi0 with commands like:
|
||||
```
|
||||
/home/pi/sendkeys /dev/hidg0 keyboard
|
||||
```
|
||||
You will need to type things like "a" and press ENTER to send the "a." Other ways to send keys include things like:
|
||||
```
|
||||
echo 'a' | /home/pi/sendkeys /dev/hidg0 keyboard
|
||||
echo 'return' | /home/pi/sendkeys /dev/hidg0 keyboard
|
||||
echo 'shift a' | /home/pi/sendkeys /dev/hidg0 keyboard
|
||||
echo 'left-meta space' | /home/pi/sendkeys /dev/hidg0 keyboard
|
||||
```
|
||||
|
||||
To reset the keyboard controller run this on the Pi3:
|
||||
```
|
||||
/opt/diy-ipmi/Pi3/resetPi0HID.sh
|
||||
```
|
||||
|
||||
If you get wierd USB errors, make sure your power brick is strong enough and that you're not trying to power the HDMI to S-Video converter via the Pi3.
|
||||
|
Loading…
Reference in New Issue