pluggemi/roon-web-controller repository overview

⁠Roon Web Controller 2.0.0 ALPHA

NOTE: This is alpha software. There is missing functionality.

See the Github page⁠ for the current status.

⁠Docker / Kubernetes support

Docker will be the preferred way to use Roon Web Controller. Images will be published to Docker Hub at pluggemi/roon-web-controller⁠.

⁠Environmental Options

The following environmental settings are available to configure the Roon Web Controller image:

• ROON_HOST: This is set to the ip address (or host name if you have a working DNS setup) of the Roon Core. If this is not set, Roon Web Controller will attempt to auto discover the Roon Core.
• ROON_PORT: This is used to set the port that the Roon Core is running on. The default port is 9100 and most likely will not need to be changed.

⁠Example run command

Here is an example command to run this docker container.

docker run -d \
  -p 8080:8080 \
  -e ROON_HOST="<YOUR ROON CORE IP>" \
  pluggemi/roon-web-controller:alpha

To also publish the live/ready/health endpoints (see below):

docker run -d \
  -p 8080:8080 \
  -p 9090:9090 \
  -e ROON_HOST="<YOUR ROON CORE IP>" \
  pluggemi/roon-web-controller:alpha

⁠Kubernetes Live and Ready endpoints

This docker image has Live, Ready, and Health endpoints for Kubernetes deployments. The health endpoints run on port 9090 within the docker container.

• /live: this returns an HTTP 200 status code (OK) when the software is running
• /ready: this returns an HTTP 200 status code (OK) when the software is running and is paired with a Roon core. Otherwise, this returns a HTTP 503 status code (Service Unavailable).
• /health: this returns a JSON payload showing detailed health status. This is an example of the output from /health:

{
  "app": {
    "name":"Roon Web Controller",
    "version":"2.0.0-alpha.0",
    "address":["172.17.0.2"]
  },
  "health":{
    "roon":"ready",
    "express":"ready",
    "socketio":"ready"
  }
}