Skip to main content
Version: Enterprise (1.1.0)

WebXTerm (Web Dashboard)

WebXTerm is the web-based dashboard — the primary interface for managing your machines, connecting via browser terminal, monitoring server health, and collaborating with your team.

Overview​

The web dashboard provides:

  • Machines dashboard — see all registered machines with online/offline status and real-time health metrics
  • Web Terminal — browser-based terminal sessions powered by xterm.js, no local tools required
  • Team management — invite members, assign roles, and control per-machine access
  • Audit logs — full command and session history across all machines
  • Community — built-in issue tracker for your infrastructure team
  • Profile & API key — manage your account and generate agent registration keys

Accessing the Dashboard​

Navigate to your WebXTerm instance in any modern browser:

http://your-webxterm-instance.com

Login​

Enter your email and password on the login page. Enterprise editions use Keycloak for credential management — vsay-auth verifies credentials and issues a signed JWT for all API calls.

Next Enterprise

OIDC/OAuth2 login with external providers (Microsoft, GitHub, Okta, Azure AD) is available in the next Enterprise Edition — handled directly by vsay-auth.

Dashboard Pages​

Machines​

The Machines page lists all registered agents:

ColumnDescription
NameMachine display name
StatusOnline / Offline (based on agent heartbeat)
CPU / Memory / DiskLive stats from the last agent heartbeat
ConnectOpens a Web Terminal session

Click "Connect" on any online machine to open a full terminal session in the browser.

Web Terminal​

The browser terminal is powered by xterm.js and connects over WebSocket to the vsay-agent running on the machine:

Browser → WebSocket (wss://) → WebXTerm Backend → gRPC stream → vsay-agent → PTY shell
  • Full color and Unicode support
  • Copy/paste works natively
  • All commands are logged to the audit log with user, timestamp, and exit code

Add Machine​

Register a new machine to your dashboard:

  1. Go to Machines → Add Machine
  2. Copy the displayed install command
  3. Run it on your server to install and configure vsay-agent
  4. The machine appears in your dashboard within seconds

Profile​

The Profile page shows your account details and your API Key — used to register vsay-agent on machines.

tip

If your API key is compromised, regenerate it from the Profile page. All agents using the old key will disconnect and need to be reconfigured.

Community​

The Community page is the built-in issue tracker for your team — create tickets, post solutions, and track infrastructure problems collaboratively. Learn more →

Supported Browsers​

BrowserSupport
Chrome / Chromium✅
Firefox✅
Safari✅
Edge✅
ResourceURL
Websitewebxterm.me
Community & Supportcommunity.webxterm.me
Documentationdocs.webxterm.me

Community vs Enterprise​

FeatureCommunityEnterprise
Machines dashboard✅✅
Web Terminal✅✅
Team management (RBAC)✅✅
Audit logs✅✅
Community (Issue Tracker)✅✅
Real-time monitoring✅✅
OIDC/OAuth2 Login❌✅ (next Enterprise)
Multi-tenancy (Organizations)❌✅