Skip to Content

Web Console

The Web Console is a custom-built terminal module integrated directly into the QuickBox Pro dashboard. It provides a full terminal session in your browser using xterm.js and WebSocket — no SSH client, no external application, and no separate installation required. The terminal is embedded as a full-width, edge-to-edge interface within the dashboard.

Admin only

Web Console requires admin privileges (admin.system.console permission). Navigate to System > Web Console from the sidebar.

Feature flag required

The Web Console must be enabled in General Settings > Feature Flags. When disabled, the Web Console sidebar item is hidden entirely. Once enabled, it is immediately available — no installation step is needed.


Key features

💻 Built-In Module

Custom-built directly into the QuickBox Pro dashboard — not a third-party application or wrapper. Ready to use the moment you enable the feature flag

🌐 Browser-Based

No SSH client, PuTTY, or terminal app required — access your server from any device with a web browser

🔒 Session Authenticated

Secured by your dashboard login session over WebSocket — only authenticated admins can access the console

📐 Full-Width Layout

Edge-to-edge display gives you the maximum terminal space in your browser window

🎨 Theme-Aware

Terminal colors automatically match your selected dashboard theme for a consistent visual experience

📋 Clipboard Support

Copy and paste between your system clipboard and the terminal session


How it works

The Web Console spawns a secure login shell for the authenticated admin user directly from the dashboard backend. Your terminal session runs with the same permissions as your server user account.

Once the feature flag is enabled, simply navigate to System > Web Console in the sidebar. The terminal loads immediately and is ready for input.

You can:

  • Run any command available to your user account on the server
  • Navigate the file system, view logs, manage services, and run qb commands
  • Use standard terminal shortcuts (tab completion, Ctrl+C, command history)
  • Scroll back through previous output
  • Copy and paste between the terminal and your clipboard

The terminal session persists as long as your browser tab is open. Navigating away from the page or closing the tab ends the session.


Migrating from TTYD (legacy Web Console)

Legacy application deprecated

In previous versions of QuickBox Pro, the Web Console was powered by TTYD — a separate application that needed to be installed via qb install webconsole. This legacy application ran on its own port with a reverse proxy configuration.

The v4 dashboard replaces TTYD entirely with a custom-built terminal module. If you still have TTYD installed from a previous setup, you can safely remove it:

qb remove webconsole

The built-in Web Console does not use or depend on TTYD in any way.


Security considerations

Do

  • Use the Web Console for quick administrative tasks and troubleshooting when SSH is inconvenient
  • Close the console tab when you are done — leaving an active terminal session open is a security risk
  • Remember that the console runs with the permissions of your server user account — exercise the same caution as you would with SSH

Don't

  • Don't share your browser session or leave the console open on a shared computer
  • Don't use the Web Console as a replacement for proper SSH key-based access on production servers — it is a convenience tool, not a security hardening measure
  • Don't run long-duration background processes through the Web Console — they will terminate when the browser session ends. Use SSH with screen or tmux for persistent sessions

FAQ

The Web Console sidebar item only appears when the feature flag is enabled in General Settings > Feature Flags. Enable the Web Console feature flag, and the sidebar item will appear immediately — no installation or restart is needed.
No. The Web Console is built directly into the QuickBox Pro dashboard. Simply enable the feature flag in General Settings and it is ready to use. If you previously installed the legacy TTYD-based web console via qb install webconsole, you can safely remove it with qb remove webconsole — the built-in module does not depend on it.
Yes. The Web Console communicates over WebSocket, which is encrypted by your server's HTTPS certificate. As long as your dashboard is served over HTTPS (via SSL), all console traffic is encrypted in transit.
No. The Web Console requires the admin.system.console permission, which is only available to admin roles. Regular users cannot see or access the console.
The terminal session will end. You will need to log back into the dashboard and reopen the Web Console to start a new session.

Join the Community

Media server operators sharing configs, getting support, and shaping the future of QuickBox Pro.

Dedicated Support
Feature Previews
Community Configs
Active Discussions
Join Discord Server