summaryrefslogtreecommitdiff
path: root/docs/novnc_proxy.1
blob: 11a003b3aa5c6313850590f27f18d7f02a36603d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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)