https://github.com/mistercalvin/supermicro-java-ikvm
A container for connecting to Supermicro Java based iKVM viewers via a web browser
https://github.com/mistercalvin/supermicro-java-ikvm
docker ikvm ipmi ipmiview java kvm novnc remote servers supermicro vnc web
Last synced: about 2 months ago
JSON representation
A container for connecting to Supermicro Java based iKVM viewers via a web browser
- Host: GitHub
- URL: https://github.com/mistercalvin/supermicro-java-ikvm
- Owner: MisterCalvin
- License: mit
- Created: 2023-12-13T00:53:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-18T21:56:33.000Z (5 months ago)
- Last Synced: 2025-04-10T03:16:57.314Z (about 2 months ago)
- Topics: docker, ikvm, ipmi, ipmiview, java, kvm, novnc, remote, servers, supermicro, vnc, web
- Language: Shell
- Homepage:
- Size: 213 KB
- Stars: 42
- Watchers: 2
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Supermicro Java iKVM Viewer Docker
A Docker container for connecting to Supermicro Java based iKVM Viewers, built from [jlesage/docker-baseimage-gui](https://github.com/jlesage/docker-baseimage-gui). See [Disclaimers & Current Bugs](#disclaimers--current-bugs) before using.
### docker compose
```
version: '3.8'
services:
supermicro-java-ikvm:
image: ghcr.io/mistercalvin/supermicro-java-ikvm:latest
container_name: supermicro-java-ikvm
environment:
TZ: UTC
USER_ID: 1000
GROUP_ID: 1000
KVM_HOST: # IP or Hostname
KVM_USER: # Your IPMI Username
KVM_PASS: # Your IPMI Password
DISPLAY_WIDTH: 1024 # Display Width
DISPLAY_HEIGHT: 768 # Display Height
ports:
- 5800:5800 # Web UI Port
- 5900:5900 # VNC Port
volumes:
- ./vmedia:/app/vmedia/ # Virtual Media ISO's
- ./screenshots:/app/screenshots/ # Screenshots / Recordings
- supermicro-java-ikvm:/config/ # Persistent Configuration for user preferences
restart: no
volumes:
supermicro-java-ikvm:
name: supermicro-java-ikvm
```
### docker cli
Create a named volume before executing the command below: `docker volume create supermicro-java-ikvm` (this will persist user preferences and iKVM .jar files)
```
docker run -d \
--name=supermicro-java-ikvm \
-e TZ="UTC" \
-e USER_ID="1000" \
-e GROUP_ID="1000" \
-e KVM_HOST="" \
-e KVM_USER="" \
-e KVM_PASS="" \
-e DISPLAY_WIDTH="1024" \
-e DISPLAY_HEIGHT="768" \
-p 5800:5800 \
-p 5900:5900 \
-v ./vmedia:/app/vmedia/ \
-v ./screenshots:/app/screenshots/ \
-v supermicro-java-ikvm:/config/ \
--restart no \
ghcr.io/mistercalvin/supermicro-java-ikvm:latest
```
Once the container is online you can access the web interface via the default port of `5800`. If you wish to password protect this page take a look [here](https://github.com/jlesage/docker-baseimage-gui#vnc-password) for steps on how to do so.
## User / Group Identifiers
You can specify the UID & GID for the user (`app`) inside the container, see [this page](https://github.com/jlesage/docker-baseimage-gui#usergroup-ids) for more information.
## Disclaimers & Current Bugs
- The image has additional environment variables you can customize, take a look at [this page](https://github.com/jlesage/docker-baseimage-gui#environment-variables) for more information. I have not tested the container with any variables other than what is defined in this repo; use these at your own risk.
- This container has been tested with the following hardware and firmware revision: `Supermicro X9DR3-F Motherboard (Nuvoton WPCM450 BMC), BMC Firmware 3.62 [SMT_X9_362.bin]`
- Selecting Español or Korean from Options > Preference > Language Setting will cause a crash, and any attempts to reconnect to the Java viewer will fail. To fix this, login to your server's web interface, then navigate to Maintenance > iKVM Reset. If this does not work you can also reboot the IPMI unit by navigating to Maintenance > Unit Reset.
- If you are having issues with the UI upon boot, navigate to Options > Preference > Window and uncheck "Auto-resize window."
- Continuing on the previous point: not all user preferences are saved. Hotkeys, Mouse Settings, and Keyboard settings seem to persist, but all other customization options such as mounted Virtual Media or Video Settings will be lost and need to be changed again if the container is restarted.
- The container assumes your server's web interface is accessible via port 80 or port 443. If you are using a non-standard port and are having issues connecting you may need to modify the initialization script at `build/rootfs/etc/cont-init.d/50-setup-ikvm.sh`, specifically [line 28, `url="https://$KVM_HOST"`](./build/rootfs/etc/cont-init.d/50-setup-ikvm.sh#L28).
## Credits
[Walter Doekes](https://github.com/wdoekes) for their [ipmikvm-tls2020](https://www.osso.nl/blog/2020/supermicro-java-console-redirection-kvm/) script