summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJan Zerebecki <jzerebecki@suse.com>2021-06-25 13:38:15 +0200
committerJan Zerebecki <jzerebecki@suse.com>2021-06-25 13:54:04 +0200
commit89e206c14601712cc713ce6f64e2f27f292bc3c5 (patch)
treefb4188bf0c0781bf4244f11a85ce0f2e529d6553 /docs
parentdd20b17d49a2394b586175f870e00b4b64c2817d (diff)
downloadnovnc-89e206c14601712cc713ce6f64e2f27f292bc3c5.tar.gz
add Man page and rename launch.sh to novnc_proxy.
Co-Authored-By: Adam Young <ayoung@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/novnc_proxy.137
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/novnc_proxy.1 b/docs/novnc_proxy.1
new file mode 100644
index 0000000..11a003b
--- /dev/null
+++ b/docs/novnc_proxy.1
@@ -0,0 +1,37 @@
+.TH novnc_proxy 1 "June 25, 2020" "version 1.2.0" "USER COMMANDS"
+
+.SH NAME
+novnc_proxy - noVNC proxy server
+.SH SYNOPSIS
+.B novnc_proxy [--listen PORT] [--vnc VNC_HOST:PORT] [--cert CERT] [--ssl-only]
+
+Starts the WebSockets proxy and a mini-webserver and
+provides a cut-and-paste URL to go to.
+
+ --listen PORT Port for proxy/webserver to listen on
+ Default: 6080
+ --vnc VNC_HOST:PORT VNC server host:port proxy target
+ Default: localhost:5900
+ --cert CERT Path to combined cert/key file, or just
+ the cert file if used with --key
+ Default: self.pem
+ --key KEY Path to key file, when not combined with cert
+ --web WEB Path to web files (e.g. vnc.html)
+ Default: ./
+ --ssl-only Disable non-https connections.
+
+ --record FILE Record traffic to FILE.session.js
+
+ --syslog SERVER Can be local socket such as /dev/log, or a UDP host:port pair.
+
+ --heartbeat SEC send a ping to the client every SEC seconds
+ --timeout SEC after SEC seconds exit when not connected
+ --idle-timeout SEC server exits after SEC seconds if there are no
+ active connections
+
+.SH AUTHOR
+The noVNC Authors
+https://github.com/novnc/noVNC
+
+.SH SEE ALSO
+websockify(1), nova-novncproxy(1)