@novnc/novnc
Advanced tools
noVNC is both a HTML VNC client JavaScript library and an application built on top of that library. noVNC runs well in any modern browser including mobile browsers (iOS and Android).
Many companies, projects and products have integrated noVNC including OpenStack, OpenNebula, LibVNCServer, and ThinLinc. See the Projects and Companies wiki page for a more complete list with additional info and links.
The project website is found at novnc.com. Notable commits, announcements and news are posted to @noVNC.
If you are a noVNC developer/integrator/user (or want to be) please join the noVNC discussion group.
Bugs and feature requests can be submitted via github issues. If you have questions about using noVNC then please first use the discussion group. We also have a wiki with lots of helpful information.
If you are looking for a place to start contributing to noVNC, a good place to start would be the issues that are marked as "patchwelcome". Please check our contribution guide though.
If you want to show appreciation for noVNC you could donate to a great non- profits such as: Compassion International, SIL, Habitat for Humanity, Electronic Frontier Foundation, Against Malaria Foundation, Nothing But Nets, etc. Please tweet @noVNC if you do.
Running in Firefox before and after connecting:
See more screenshots here.
noVNC uses many modern web technologies so a formal requirement list is not available. However these are the minimum versions we are currently aware of:
noVNC follows the standard VNC protocol, but unlike other VNC clients it does require WebSockets support. Many servers include support (e.g. x11vnc/libvncserver, QEMU, and MobileVNC), but for the others you need to use a WebSockets to TCP socket proxy. noVNC has a sister project websockify that provides a simple such proxy.
Use the launch script to automatically download and start websockify, which
includes a mini-webserver and the WebSockets proxy. The --vnc option is
used to specify the location of a running VNC server:
./utils/launch.sh --vnc localhost:5901
Point your browser to the cut-and-paste URL that is output by the launch script. Hit the Connect button, enter a password if the VNC server has one configured, and enjoy!
Please see our other documents for how to integrate noVNC in your own software, or deploying the noVNC application in production environments:
See AUTHORS for a (full-ish) list of authors. If you're not on that list and you think you should be, feel free to send a PR to fix that.
Core team:
Notable contributions:
Included libraries:
Do you want to be on this list? Check out our contribution guide and start hacking!
FAQs
An HTML5 VNC client
The npm package @novnc/novnc receives a total of 34,822 weekly downloads. As such, @novnc/novnc popularity was classified as popular.
We found that @novnc/novnc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
