5
0
mirror of git://git.proxmox.com/git/pve-xtermjs.git synced 2025-03-13 00:58:40 +03:00
pve-xtermjs/README
Dominik Csapak dcf3d43b8a initial commit
working version of xtermjs client and termproxy as
authentication proxy between a command/socket and a tcp socket

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2017-11-28 10:28:46 +01:00

33 lines
952 B
Plaintext

xterm.js webclient and helper utility
=====================================
This repository contains the client and helper utility to use
xterm.js (https://xtermjs.org) for Proxmox VE.
To be able to relay between the gui and a shell program/console,
we need a tool (called termproxy) to open a port (where our websocketproxy
connects to) and to open a pty and execute a program
From Client to Server it implements a simple packet-based protocol:
(everything is a string)
* Normal Message
0:LENGTH:MSG
where LENGTH is the bytelength of the msg
* Resize Message
1:COLS:ROWS:
where COLS is the number of columns the client wants to resize to,
and ROWS the number of rows, respectively
* Ping Message
2
used to keep the connection between client and server alive
(we have a timeout of 5 minutes)
every other input from the client will be ignored
From server to client, the data will simply sent, without any
format