
noVNC
Browser-based VNC access that runs well in modern desktop and mobile browsers
Overview
noVNC is both a VNC client JavaScript library and an application built on top of that library. It runs well in any modern browser, including mobile browsers on iOS and Android.
It is a browser-based VNC client, not a native desktop viewer—access happens through your web browser rather than a standalone app.
Key features
noVNC focuses on simple, browser-based VNC access with QuickBox-managed services and paths.
🧭 Browser-first VNC
VNC client JavaScript library that runs in modern browsers, including mobile
🧩 Per-user services
Systemd units vnc@username.service and novnc@username.service are created per user
🛤️ Reverse-proxied paths
nginx locations /username/vnc and /username/websockify map to /srv/novnc and 127.0.0.1:port
🔌 Base ports
Base ports are 6080 (web) and 5901 (VNC daemon) with auto-generated flags enabled
When to use it
Choose noVNC when you want browser-based VNC access that QuickBox exposes through user-scoped paths.
You want
- Need VNC access that works in modern desktop and mobile browsers
- Want user-scoped web paths like
/username/vncand/username/websockify - Prefer per-user systemd services for VNC and websockify
QuickBox provides
- QuickBox provisions
vnc@username.serviceandnovnc@username.serviceper user - nginx serves
/username/vncfrom/srv/novncand proxies/username/websockify - Dashboard Service Control surfaces live port and service state for noVNC
Installation
QuickBox installs noVNC through the CLI or from the dashboard Package Management tab.
Install from the QuickBox CLI
CLI Options
-u, --usernameRequiredTarget QuickBox username for install, reinstall, update, and remove actions
Install from the Dashboard
The Package Management tab shows noVNC with Install, Reinstall, and Remove actions. The Application Control view displays the live noVNC port and status for the selected user.
Access and authentication
URL / route
- Per-user access URL:
https://host/username/vnc/vnc.html?resize=remote&host=host&path=username/websockify - nginx serves
/username/vncfrom/srv/novncand proxies/username/websockifyto127.0.0.1:port. - When a system-level
novnc.serviceexists, the Dashboard link resolves tohttps://host/vnc.
Login / credentials / tokens
- QuickBox decrypts the QuickBox user password and applies it with
vncpasswdduring install. - HTTP Basic auth for
/username/vncuses/etc/htpasswd.d/htpasswd.username.
Security notes
VNC daemon port access
QuickBox adds iptables rules to accept only localhost traffic on the VNC daemon port and drop other traffic. Access is intended through the nginx paths instead of direct VNC port access.
Configuration and files
Common tasks
- Start services:
systemctl start vnc@username.servicethensystemctl start novnc@username.service - Stop services:
systemctl stop novnc@username.serviceandsystemctl stop vnc@username.service - Restart services:
systemctl restart novnc@username.serviceorsystemctl restart vnc@username.service - View live port and status: Dashboard Service Control shows the current noVNC port and status
- Update or remove: use
qb update novnc -u usernameorqb remove novnc -u username
FAQ
6080 and a base VNC daemon port of 5901, with auto-generated flags enabled. The Dashboard Service Control view shows the current assigned noVNC port./username/vnc/vnc.html?resize=remote&host=host&path=username/websockify and maps the nginx locations /username/vnc and /username/websockify to the noVNC client and websockify bridge.vncpasswd based on the stored QuickBox user password, and nginx protects /username/vnc using HTTP Basic auth from /etc/htpasswd.d/htpasswd.username.Best practices
Do
- Use the Dashboard Service Control view to confirm the active port and service state for noVNC.
- Keep
/home/username/.vnc/xstartupexecutable so Xfce launches with autocutsel and startxfce4. - Use the
/username/vncpath protected by HTTP Basic auth for browser access.
Don't
- Do not expect direct access to the VNC daemon port; iptables drops non-local traffic to that port.
- Do not delete
/etc/htpasswd.d/htpasswd.usernameif you rely on HTTP Basic auth for/username/vnc.
Troubleshooting
Symptom: browser loads but the desktop is blank
Checks: Confirm vnc@username.service is running and /home/username/.vnc/xstartup exists and is executable.
Symptom: connection refused on the websockify path
Checks: Confirm novnc@username.service is active and /etc/nginx/conf.d/username.vnc.conf points to the assigned web port.
Resources
Resources
Join the Community
Media server operators sharing configs, getting support, and shaping the future of QuickBox Pro.