Using the GUI configuration image

You can use the GUI configuration image contained in the package (see Package overview) to run the GUI configuration tools for OneSpan Authentication Server and Message Delivery Component (MDC). This allows for easier configuration of the OneSpan Authentication Server and MDC containers.

Unlike the other images included in the package, the GUI configuration image can be used on Linux and Windows.

You can mount any OneSpan Authentication Server or MDC configuration file or configuration file template to edit it with the respective configuration tool.

By default, the container will run the OneSpan Authentication Server Configuration Utility (ikconfigutilgui) if one of the following mount points are provided:

• /mnt/identikeyconfig.xml
• /mnt/identikeyconfig.tmpl
• /mnt/templates/identikeyconfig.xml
• /mnt/templates/identikeyconfig.tmpl

By default, the container will run the MDC Configuration Utility (mdcconfiggui) if one of the following mount points are provided:

• /mnt/mdcconfig.xml
• /mnt/mdcconfig.tmpl
• /mnt/templates/mdcconfig.xml
• /mnt/templates/mdcconfig.tmpl

The mount points for each configuration application are evaluated in no particular order, but only one must be provided. If multiple instances of the same file are mounted, you will receive a respective error message.

Using the GUI configuration image on Linux

The GUI applications require X11 access. If you haven't done yet, allow local connections to the X server:

sudo xhost +local:docker

To run the GUI configuration image with default mount points mapped from the config folder, run the following command:

docker run --rm --user $(id -u) \
  -v $(pwd)/config:/mnt \
  -e DISPLAY=$DISPLAY \
  -v /tmp/.X11-unix/:/tmp/.X11-unix/ \
  onespan_config:<release_version>

To run the GUI configuration image with a specific configuration file for the OneSpan Authentication Server Configuration Utility, e.g. file.xml, run the following command:

docker run --rm --user $(id -u) \
  -v $(pwd)/file.xml:/mnt/file.xml \
  -e DISPLAY=$DISPLAY \
  -v /tmp/.X11-unix/:/tmp/.X11-unix/ \
  onespan_config:<release_version> \
  ikconfigutilgui -e -c /mnt/file.xml

To run the GUI configuration image with a specific configuration file for the MDC Configuration Utility, e.g. file.xml, run the following command:

docker run --rm --user $(id -u) \
  -v $(pwd)/file.xml:/mnt/file.xml \
  -e DISPLAY=$DISPLAY \
  -v /tmp/.X11-unix/:/tmp/.X11-unix/ \
  onespan_config:<release_version> \
  mdcconfiggui -e -c /mnt/file.xml

Replace the following:

• release_version. The specific version of the images distributed in the package, e.g. 3.27.0.1234.

Using the GUI configuration image on Windows

Before running the GUI container, make sure that the XServer (or any other X11 Desktop application) is running and accepting connections from the Docker machine. The DISPLAY environment variable is required to use the xhostname:display_number.screen_number format, e.g. localhost:0:0.

Replace the following:

• xhostname. The name or IP address of the computer that runs the X server (basically the X11 application that runs in the container), e.g. localhost.
• display_number. The display number of the X server to connect, e.g. 0.
• screen_number. The sequence number of the screen of the respective display (X server), e.g. 0. A display can have multiple screens (monitors).

To run the GUI configuration image with default mount points mapped from the config folder, run the following command:

docker run --rm \
  -v ./config:/mnt \
  -e DISPLAY=xhostname:0.0 \
  onespan_config:<release_version>

To run the GUI configuration image with a specific configuration file for the OneSpan Authentication Server Configuration Utility, e.g. file.xml, run the following command:

docker run ‑‑rm ‑‑user $(id ‑u) \
  ‑v ./file.xml:/mnt/file.xml \
‑e DISPLAY=xhostname:0.0 \
  onespan_config:<release_version> \
ikconfigutilgui ‑e ‑c /mnt/file.xml

To run the GUI configuration image with a specific configuration file for the MDC Configuration Utility, e.g. file.xml, run the following command:

docker run ‑‑rm \
  ‑v ./file.xml:/mnt/file.xml \
‑e DISPLAY=xhostname:0.0 \
  onespan_config:<release_version> \
mdcconfiggui ‑e ‑c /mnt/file.xml

Replace the following:

• release_version. The specific version of the images distributed in the package, e.g. 3.27.0.1234.

Additional considerations

• The GUI configuration image is supposed to run separately from a regular OneSpan Authentication Server deployment.

• The configuration applications that run in the GUI configuration image have the following limitations:

  • File path and database connection validation are disabled.
  • Advanced ODBC storage configuration is disabled.
  • Testing MDC gateway is disabled.
  • Testing ODBC connections is disabled.
  • The OneSpan Authentication Server and MDC daemons cannot be restarted.