Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sterlingbutters/ip-kvm-interface
DIY IP-KVM for Remote Desktop Access
https://github.com/sterlingbutters/ip-kvm-interface
browser css html5 interface ipmi javascript kvm raspberry-pi remote remote-control vnc
Last synced: 8 days ago
JSON representation
DIY IP-KVM for Remote Desktop Access
- Host: GitHub
- URL: https://github.com/sterlingbutters/ip-kvm-interface
- Owner: SterlingButters
- License: mit
- Created: 2018-09-16T16:02:16.000Z (about 6 years ago)
- Default Branch: dev
- Last Pushed: 2024-06-19T17:09:42.000Z (5 months ago)
- Last Synced: 2024-11-01T10:35:18.400Z (13 days ago)
- Topics: browser, css, html5, interface, ipmi, javascript, kvm, raspberry-pi, remote, remote-control, vnc
- Language: JavaScript
- Homepage:
- Size: 14.6 MB
- Stars: 75
- Watchers: 12
- Forks: 15
- Open Issues: 25
-
Metadata Files:
- Readme: README.markdown
- License: LICENSE.md
Awesome Lists containing this project
README
# IP-KVM-InterFace 
# About
This project creates a web-accessable IPMI / IP KVM system utilizing any OTG enabled
Raspberry Pi device (theoretically - testing only done on RPi4) that provides full keyboard and mouse control,
monitor view, and the ability to reboot computers with standard motherboards
remotely (WOL & GPIO-Relay). This projects intends to also create an interface with consistent
and minimal programmatic requirements (i.e. use of web stack languages only) with modularity and organization.
This project is EXTREMELY light weight and easy to install and configure. Additionally, this allows further
development with minimal orientation overhead.
The project's working features (with caveats):
#### 1) Keyboard
- Future Work: Send shortcuts via HTML button interface
#### 2) Mouse
- Future Work: Scroll wheel support
#### 3) Video Source (selection/refresh) (e.g. `/dev/video0`, etc)
- Future Work: Try HLS stream
#### 4) Mass Storage Emulation
- Future Work: Verify detachability
- Future Work: Perform `.img` test
- Future Work: Support `licomposite` "stall"
- Future Work: Add a `dd` file converter and/or alter `accept` attribute of file `input` tag
#### 5) GPIO Interface (must initialize pins manually in `app.js`)
- Future Work: Identification of GPIO pin configuration for support of the following:
- Relay Channel [IOT](https://www.amazon.com/gp/product/B00WV7GMA2/ref=ppx_yo_dt_b_asin_title_o00_s00?ie=UTF8&psc=1)
- Upstream USB Switch [YKUP](https://www.yepkit.com/product/300114/YKUP)
- USB Switchable Hub [YKUSH3](https://www.yepkit.com/product/300110/YKUSH3)
- LIRC Transmitter/Receiver [ENER314-IR](https://www.amazon.co.uk/dp/B00T9JPA4O/ref=pe_3187911_185740111_TE_item)
#### 6) WOL
- Future Work: Configure `/network/interfaces` for user
- Future Work: Detect MAC addresses with button
#### 7) Terminal
- Future Work: Add "Copy Command" button to fork process output
#### 8) Authentication
- Future Work: Twilio-based multi-factor authentication
- Future Work: PAM authentication || equivalent
#### 9) Remote Access
- Future Work: Link/iFrame to gateway address (for port forwarding configuration)
- Future Work: no-ip2 API DDNS support in interface
- Future Work: VPN configuration information
- Future Work: Embedded VNC Client using noVNC
- ~~Future Work: Dataplicity "Wormhole" Instruction~~ video stream is "insecure" content
#### 10) ~~Installation Script~~ (`/configuration/install.sh`
- Future Work: Configure as `systemd` service
- Future Work: Add `dtoverlay=dwc2` to `/boot/config.txt`
## Configuration
#### Setup
**Image needs updating to show possible GPIO configurations
#### Installation
1) Enable the dwc2 dtoverlay in `/boot/config.txt` on your Pi4
2) Install node/npm/pip in
3) Run `npm install`
4) Run `sudo bash < project-directory >/configuration/composit-gadget-setup_v1.sh`
5) Run `sudo node app.js`
6) Navigate to `http://localhost:3000` in your browser
7) See below for remote access instruction
**Post issue for installation guidance (or look at `/configuration/install.sh`)
#### DDNS and Port Forwarding:
1) Log into router
2) Set up up port forwarding to :port that is chosen for the Interface during install
[3000 recommended]
3) Sign up for DDNS: [](https://www.noip.com)
4) Create a hostname (no-ip client to be set up in install)
## Shopping List:
- Raspberry Pi4 (Starter Kit)[$89.99]:
[](https://www.amazon.com/CanaKit-Raspberry-4GB-Basic-Starter/dp/B07VYC6S56/ref=sr_1_1?keywords=rpi+4+starter+kit&qid=1574491331&s=electronics&sr=1-1)
- Capture Card Options:
- LinkStable (verified)[$99.99]:
[](https://www.amazon.com/LinkStable-Streaming-Recorder-Gameplayer-Compatible/dp/B073PXDKFR/ref=sr_1_3?s=electronics&ie=UTF8&qid=1539175400&sr=1-3&keywords=linkstable+capture+card)
- PenGo [4K] (experimental)[$149.99]:
[](https://www.amazon.com/gp/product/B07BGXVGLS/ref=ox_sc_act_title_1?smid=A39P3WP927BTL5&psc=1)
- Cables:
- USB to USB-C [comes in Pi4 starter kit]
- HDMI x2 [~$5.99]
- Ribbon Cables [~$7.50]:
[](https://www.amazon.com/Kuman-Breadboard-Arduino-Raspberry-Multicolored/dp/B01BV3Z342/ref=sr_1_8_sspa?s=electronics&ie=UTF8&qid=1539227097&sr=1-8-spons&keywords=rpi+ribbon+cable+variety+pack&psc=1)
## Troubleshooting
- Ensure all cables are data-transfer capable
## Cost-Cutting
- Cheaper capture cards exist; the one chosen allows for throughput of video to a display
- The complete RPi4 starter kit might be a bit overkill but easy one-stop-shop for beginner
## Collaboration & Support
Donate with PayPal:
[](https://paypal.me/sterlingbutters)
Join me on Discord:
[](https://discord.gg/uSTr7DZ)
## Note to developers
This project hosts a node-generated server on an OTG-capable Raspberry Pi device. The install script creates the libcomposite device on the Pi. The code then transcribes the information that is fed through the browser and relays it to the target computer using socket.io. Video is achieved using JSMPEG (would like to find something even faster like WebRTC maybe). There are likely many approaches to current solutions. For instance, the mouse report descriptor is that for a generic mouse with basic functions. It might be possible to create a report descriptor that generates output reports from the mouse to provide absolute position on the screen. Additionally, it might be possible to detect the display resolution and calibrate the mouse movement. Currently, it doesn't seem that that level of rigor is worth it. Other improvements like this could likely be made as well.
I do plan on going back and cleaning up this code to be more readable but we will see if that happens anytime soon.