diff --git a/README.md b/README.md new file mode 100644 index 0000000..e5137c2 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# PiKVM - Pi Zero 2 W + +The official PiKVM is expensive so I decided take the DIY approuch to save on costs & add some addition features: +- "USB dongle" form-factor with minimal connections +- Create access point when not connected to anything for easy access +- Optional ethernet connection since my servers don't have a wifi connection +- E-ink display for displaying network information +- Wireguard host to act as jumpbox +- Wireguard client to act as reverse VPN (Aviods network firewalls & can be remotely configured by DNS) + +## Hardware + - [Pi Zero 2 W](https://www.raspberrypi.com/products/raspberry-pi-zero-2-w/) + - [ENC28J60 Ethernet -> SPI Module](https://www.waveshare.com/enc28j60-ethernet-board.htm) (Slow but the only option) + - [HDMI to CSI-2 Module](https://www.waveshare.com/hdmi-to-csi-adapter.htm) + - [2.13" E-Ink Display](https://www.waveshare.com/2.13inch-e-paper-hat.htm) + +## Assembly +1. _Optional: Cut the head off a USB cable & solder it to the debug pads on the back of the Pi; extend to the right (Opposite the SD card) & glue with hot glue_ +2. Connect HDMI/CSI-2 module via short ribbon cable (~40 mm); fold over and glue to back of board alighting with the SD card +3. _Optional: Wire the Ethernet/SPI module onto SPI chanel 0_ +4. _Optional: Connect display via 8 pins on side to SPI channel 1_ + +## Install +1. Flash SD card with [latest PiKVM image](https://pikvm.org/download/) using the [Raspberry Pi Imager](https://www.raspberrypi.com/software/) +2. Edit `/boot/config.txt` to include: +``` +dtoverlay=spi=on +``` +3. Edit `/boot/pikvm.txt` to include your WiFi credentials: +``` +FIRST_BOOT=1 +WIFI_ESSID="wifi_name" +WIFI_PASSWD="wifi_pass" +``` +4. Insert SD card into Pi, connect an HDMI cable to the PI HDMI output (not the added module), connect the USB port to power +5. Open the IP address on screen & use `admin/admin` to login & open the console +6. Login as root, enable rw mode & run the install scrip: +``` +$ su - +**Enter password: root** +# rw +# curl https://git.zakscode.com/ztimson/PiKVM/install.sh | bash