PiKVM/README.md

42 lines
1.9 KiB
Markdown
Raw Normal View History

2024-07-26 22:53:59 -04:00
# PiKVM - Pi Zero 2 W
2024-07-26 23:01:22 -04:00
The official PiKVM is expensive so I decided take build my own & add some features in the process:
- Static MAC addresses to fix IP changes on reboot while using DHCP
2024-07-26 23:35:52 -04:00
- Small "USB dongle" form-factor with minimal connections
- Creates access point when network connection is lost for easy configuration
2024-07-27 08:07:58 -04:00
- Ethernet connection for wired networks
2024-07-26 23:01:22 -04:00
- E-ink display for showing network information
- Setup wireguard by adding a `wg0.conf` file to the boot partion to create a jumpbox
2024-07-26 22:53:59 -04:00
## Hardware
2024-07-26 23:33:55 -04:00
- [Pi Zero 2 W + SD Card](https://www.raspberrypi.com/products/raspberry-pi-zero-2-w/)
- [Ethernet to SPI](https://www.waveshare.com/enc28j60-ethernet-board.htm)
- [HDMI to CSI-2](https://www.waveshare.com/hdmi-to-csi-adapter.htm)
2024-07-26 22:53:59 -04:00
- [2.13" E-Ink Display](https://www.waveshare.com/2.13inch-e-paper-hat.htm)
## Assembly
2024-07-26 23:35:52 -04:00
1. 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)
2024-07-26 22:53:59 -04:00
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
2024-07-26 23:35:52 -04:00
3. Wire the Ethernet/SPI module onto SPI chanel 0
4. Connect E-Ink display via side pins to SPI channel 1
2024-07-26 22:53:59 -04:00
## 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
```
2024-07-26 23:01:22 -04:00
3. Edit `/boot/pikvm.txt` to include your WiFi credentials for initial configuration:
2024-07-26 22:53:59 -04:00
```
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
2024-07-26 23:31:17 -04:00
5. After statup, open the IP address displayed in your browser & use `admin/admin` to login
6. Open the console, login as root & run the install script:
2024-07-26 22:53:59 -04:00
```
$ su -
**Enter password: root**
2024-07-26 23:20:09 -04:00
# curl https://git.zakscode.com/ztimson/PiKVM/raw/branch/master/install.sh | bash