sciapp/nojava-ipmi-kvm-server repository overview

⁠NoJava-IPMI-KVM-Server

⁠Introduction

NoJava-IPMI-KVM-Server is a python-based server designed to centrally provide instances of sciapp/nojava-ipmi-kvm⁠ via the browser. This means that no installation of either Java or nojava-ipmi-kvm is required on the administrator's machine. A typical usage might be:

1. Optional login using oauth, optionally secured by ldap group membership
2. Selection of desired target machine, resolution and prompt for required kvm password
3. Start of a docker container using nojava-ipmi-kvm to provide console access via novnc's web interface/the kvm's html5 interface
4. The docker container is stopped and deleted after the administrator closes the tab/window.

⁠Installation

NoJava-IPMI-KVM-Server can either be installed using Git or installed as a docker container.

⁠Standalone using git:

• Install Python3 and pip
• Install Docker⁠ on the server if not done already.
• Ensure the user that shall run nojava-ipmi-kvm-server has permissions to access docker (usually being in the docker group suffices)
• Clone the repository, f.e. git clone https://github.com/sciapp/nojava-ipmi-kvm-server.git into a directory of your choice
• Install the dependencies, f.e. pip install -r requirements.txt
• Write a configuration file for nojava-ipmi-kvm (in this⁠ format) and place it somewhere accessible
• Start the service using python3 main.py with the required env variables set.

⁠As a container:

• Write a configuration file for nojava-ipmi-kvm (in this⁠ format) and place it somewhere accessible
• Start a docker container based on the sciapp/nojava-ipmi-kvm-server image with the required env variables set and the configuration file mounted into the container. Make sure to mount the docker socket into the container.

Example:

docker run -d \
           --restart always \
           --name nojava-ipmi-kvm-server \
           --env-file ~/nojava-ipmi-kvm.envfile \
           -v /var/run/docker.sock:/var/run/docker.sock \
           -v ~/nojava-ipmi-kvmrc.yaml:/nojava-ipmi-kvmrc.yaml \
           sciapp/nojava-ipmi-kvm-server:latest

⁠Configuration

⁠Authentication

Three authentication options are available:

1. No authentication. This requires that no OAUTH_* or LDAP_* option is set
2. OAUTH-only authentication. This requires that all OAUTH_* options are set while no LDAP_* option is set
3. OAUTH authentication + LDAP authorization. This requires that all OAUTH_* and all LDAP_* (except LDAP_FALLBACK_SERVER) options are set. This requires that signed in users are in a specific LDAP group.

LDAP-Identification is performed using the email.

⁠Environment variables

⁠IFRAME_PATH_FORMAT

You can use the following placeholders within the format string:

Some examples:

• {url}: No special network configuration, EXTERNAL_WEB_DNS is set to the external address of the docker host
• https://outside-address/{port}/vnc.html?host={outside-address}&autoconnect=true&password={password}&path={port}/websockify: Java Example using a reverse proxy proxying WebVNC Ports
• https://{external_web_dns}/{subdir}{html5_endpoint}: HTML5 Example using a reverse proxy