From 12eba20917cda1f739a497ded53395ca8eff1eb1 Mon Sep 17 00:00:00 2001 From: Bill Church Date: Tue, 19 Oct 2021 10:07:03 -0400 Subject: [PATCH] docs: update docs for ssh.term and sshterm options (#265) --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 27c942d..0b0279e 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,8 @@ docker run --name webssh2 -d -p 2222:2222 -v `pwd`/app/config.json:/usr/src/conf * **header=** - _string_ - optional header to display on page +* **sshterm=** - _string_ - optional specify terminal emulation to use, defaults to `ssh.term` in `config.json` or `vt100` if that is null + * **headerBackground=** - _string_ - optional background color of header to display on page * **readyTimeout=** - _integer_ - How long (in milliseconds) to wait for the SSH handshake to complete. **Default:** 20000. **Enforced Values:** Min: 1, Max: 300000 @@ -115,7 +117,7 @@ docker run --name webssh2 -d -p 2222:2222 -v `pwd`/app/config.json:/usr/src/conf * **ssh.port** - _integer_ - Specify SSH port to connect to, defaults to `22` -* **ssh.term** - _string_ - Specify terminal emulation to use, defaults to `xterm-color` +* **ssh.term** - _string_ - Specify terminal emulation to use, defaults to `vt100` if null * **ssh.readyTimeout** - _integer_ - How long (in milliseconds) to wait for the SSH handshake to complete. **Default:** 20000.