From 8acab7c358956d05ccd040d76f0adbb52ff571d9 Mon Sep 17 00:00:00 2001 From: Thomas Lamprecht Date: Fri, 29 Sep 2023 10:07:17 +0200 Subject: [PATCH] readme: update and reword slightly Signed-off-by: Thomas Lamprecht --- README | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/README b/README index 61063ca..1efdc52 100644 --- a/README +++ b/README @@ -1,15 +1,19 @@ xterm.js webclient and helper utility ===================================== -This repository contains the client and helper utility to use -xterm.js (https://xtermjs.org) for Proxmox VE. +This repository contains the client and helper utility to use xterm.js [0] in +the web UI of Proxmox projects like Proxmox VE, Proxmox Mail Gateway or Proxmox +Backup Server. -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 +[0]: https://xtermjs.org -From Client to Server it implements a simple packet-based protocol: -(everything is a string) +To be able to relay between the frontend and a shell program/console running in +the backend, we provide a tool called termproxy to open a port (where our +websocketproxy connects to) and to open a PTY and execute a program. + +For communication originating from the client towards the server, it implements +a simple packet-based protocol where everything is a string. The protocol +consists of the following messages: * Normal Message 0:LENGTH:MSG @@ -17,16 +21,15 @@ From Client to Server it implements a simple packet-based protocol: * 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 + 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 +Every other input from the client will be ignored. +Communication from server to the client uses no protocol, the raw data coming +from the terminal/program will be forwarded 1:1, without any wrapping format. -- 2.39.2