Integration

noVNC is designed to be easily integrated into existing web sites with the existing structure and styling. For details about the modules that make up noVNC and their Javascript API see the ModulesAPI page.

noVNC integration notes

• All files necessary for integrating noVNC are in the include/ subdirectory of the project.

• The file util.js provides the Util.load_scripts() function which can be used to dynamically included other files required for basic noVNC functionality. The global variable INCLUDE_URI is used as the URL prefix for the other noVNC files. The value of INCLUDE_URI defaults to include/.

• The file ui.js has a load() routine UI that will call Util.load_scripts() to load all the other required scripts and will also initialize the basic noVNC UI and provide default callback handlers.

• The file base.css provides basic styling that is compatible with the UI in vnc.html. The files black.css and blue.css provide an alternate styling.

• See vnc.html for a fleshed out working example with a UI.

• See vnc_auto.html for a working example that does not use ui.js. It statically defines the UI and provides callback functions all on one page. vnc_auto.html takes host, port and password settings from the URL query string and automatically connects as soon as the page loads.