Access backend GUI

When using Docker or WSL to run backends, there is no visible graphical user interface (GUI). COMPAS FAB aims at making this unnecessary, but if desired, there are two possibilities to open the graphical user interface of a backend.

Visualization over web browser

This is the easiest option, and it is normally only available for backends based on Docker. The display of the backend is forwarded to a container that serves it over a web connection, making it available from your browser.

Not all Docker setups will include this ability, but if they do, it can be accessed easily. Start your browser and go to the following address:

http://localhost:8080/vnc.html?resize=scale&autoconnect=true

This feature is possible thanks to NoVNC.

Visualization forwarding display

Note

🐉 HERE BE DRAGONS!

Be aware that the following can be time-consuming and frustrating to configure. We recommend using the web browser visualization in the general case, and only use X11 forwarding if you know what you are getting yourself into.

This option allows to forward a display directly to your operating system. It is especially useful when used in combination with WSL.

However, it is important to note this is not entirely supported in all platforms.

First install an X11 server:

Configure X11 security:

  • On Windows, add your IP address to the file %ProgramFiles(x86)%\XMing\X0.hosts. It needs to be opened as administrator.

  • On Mac, run xhost +local:root. Remember to disable later with xhost -local:root.

Finally, set the DISPLAY variable to point to your X11 server as follows replacing YOUR_IP_ADDRESS with your current IP:

export DISPLAY=YOUR_IP_ADDRESS:0.0