Copy page

Guides

noVNC

This guide explains how to create and deploy a noVNC app, allowing you to access remote desktops through a web interface inside a modern browser.

Note: Anthropic's Computer Use Demo inspired this example.

To run this example, follow these steps:

1. Install the CLI and a container runtime engine, for example Docker. Use the unikraft CLI or the legacy kraft CLI.

2. Clone the examples repository and cd into the examples/novnc-browser directory:

Code
git clone https://github.com/unikraft-cloud/examples
cd examples/novnc-browser/

Make sure to log into Unikraft Cloud and pick a metro close to you. This guide uses fra (Frankfurt, 🇩🇪):

When done, invoke the following command to deploy this app on Unikraft Cloud:

The output shows the instance address and other details:

Code
[●] Deployed successfully!
 │
 ├─────── name: vnc-browser
 ├─────── uuid: 90a59b05-0ae1-4ca6-8383-79c5115355ee
 ├────── metro: https://api.fra.unikraft.cloud/v1
 ├────── state: starting
 ├───── domain: https://weathered-fog-y5jjmwfd.fra.unikraft.app
 ├────── image: novnc-browser@sha256:fdb4887e84362ebbaf54c713e0d85f547e8ee173fe63a6ab39e94b7e612a9892
 ├───── memory: 4096 MiB
 ├──── service: weathered-fog-y5jjmwfd
 ├─ private ip: 10.0.0.49
 └─────── args: /wrapper.sh

In this case, the instance name is vnc-browser and the address is https://weathered-fog-y5jjmwfd.fra.unikraft.app. The name was preset, but the address is different for each run. Enter the provided address into your browser of choice to access the remote desktop interface.

Use curl to query the Unikraft Cloud instance:

Code
curl https://weathered-fog-y5jjmwfd.fra.unikraft.app

Code
Hello, World!

You can list information about the instance by running:

Code
NAME         FQDN                                     STATE    STATUS   IMAGE                                        MEMORY   VCPUS  ARGS         BOOT TIME
vnc-browser  weathered-fog-y5jjmwfd.fra.unikraft.app  standby  standby  novnc-browser@sha256:fdb4887e84362ebbaf5...  4.0 GiB  1      /wrapper.sh  7.17 ms

When done, you can remove the instance:

Learn more

Use the --help option for detailed information on using Unikraft Cloud:

Or visit the CLI Reference or the legacy CLI Reference.