Skip to main content

Hypervnc User Guide

Install Hypervnc#

Before we can use the Hypervnc remote desktop service, we need to install few things. Please refer to the Hypervnc Install Guide.

Using the service#

Requesting magic key#

If you have not done so yet, Please refer to the service request guide.

Establishing a remote session#

  • Use your key to establish a remote session to the requested rig.
  • Open a new terminal window and type:
magic vnc --key <magic key>

For example:

note

Sub-commands order do not matter.

  • First time using Hypervnc we will have to wait for Docker to download the Hypervnc image from the internet.
  • Once the download finish the startup process is very quick.
  • Once you see the message "Initialization Sequence Completed” your session is ready.
  • You can use any VNC client to login using localhost:5901 as the VNC.
  • I highly recommend using noVNC:
Tips for enhancing noVNC experience:
  • Once connected using noVNC, click the gear icon on the left and set Scaling Mode to Remote Resizing.
    • you have to do this once, your browser will save the settings.
  • When done you can shutdown the session by pressing Ctrl+C to terminate the session.
  • You can still go back to your session using the same magic key. Keys are valid for 8 hours. :::

For More Hypervnc CLI Details#

Refer to the Hypervnc CLI Docs

Edit this page