[pve-xtermjs.git] / README

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
Commit	Line	Data
dcf3d43b DC	1	xterm.js webclient and helper utility
	2	=====================================
	3
	4	This repository contains the client and helper utility to use
	5	xterm.js (https://xtermjs.org) for Proxmox VE.
	6
	7	To be able to relay between the gui and a shell program/console,
	8	we need a tool (called termproxy) to open a port (where our websocketproxy
	9	connects to) and to open a pty and execute a program
	10
	11	From Client to Server it implements a simple packet-based protocol:
	12	(everything is a string)
	13
	14	* Normal Message
	15	0:LENGTH:MSG
	16	where LENGTH is the bytelength of the msg
	17
	18	* Resize Message
	19	1:COLS:ROWS:
	20	where COLS is the number of columns the client wants to resize to,
	21	and ROWS the number of rows, respectively
	22
	23	* Ping Message
	24	2
	25	used to keep the connection between client and server alive
	26	(we have a timeout of 5 minutes)
	27
	28	every other input from the client will be ignored
	29
	30	From server to client, the data will simply sent, without any
	31	format
	32