1WESTON-RDP(7)          Miscellaneous Information Manual          WESTON-RDP(7)
2
3
4

NAME

6       weston-vnc - the VNC backend for Weston
7

SYNOPSIS

9       weston --backend=vnc
10

DESCRIPTION

12       The  VNC backend allows to run a weston environment without the need of
13       specific graphic hardware, or input devices. Users  can  interact  with
14       weston only by connecting using the remote framebuffer protocol (RFB).
15
16       The  VNC  backend uses Neat VNC to implement the VNC part, it acts as a
17       VNC server listening for incoming connections.  It  supports  different
18       encodings for encoding the graphical content, depending on what is sup‐
19       ported by the VNC client.
20
21       The VNC backend is not multi-seat aware, so if a second client connects
22       to the backend, the first client will be disconnected.
23
24       The VNC client has to authenticate as the user running weston. This re‐
25       quires a PAM configuration file /etc/pam.d/weston-remote-access.
26
27

CONFIGURATION

29       The VNC backend uses the following entries from weston.ini.
30
31   Section vnc
32       refresh-rate=rate
33              Specifies the desktop redraw rate in Hz. If unspecified, the de‐
34              fault  is 60Hz. Changing this may be useful if you have a faster
35              than 60Hz display, or if you want to reduce  updates  to  reduce
36              network traffic.
37
38

OPTIONS

40       When  the  VNC  backend is loaded, weston will understand the following
41       additional command line options.
42
43       --width=width
44              The width of the framebuffer. It defaults to 640.
45
46       --height=height
47              The height of the framebuffer. It defaults to 480.
48
49       --port=port
50              The TCP port to listen on for connections. It defaults to 5900.
51
52       --vnc-tls-key=file
53              The file containing the key for doing TLS security. To have  TLS
54              security you also need to ship a file containing a certificate.
55
56       --vnc-tls-cert=file
57              The  file  containing the certificate for doing TLS security. To
58              have TLS security you also need to ship a key file.
59
60
61

Generating cryptographic material for the VNC backend

63       You can generate a key and certificate file to use  with  TLS  security
64       using typical openssl invocations:
65
66       $ openssl genrsa -out tls.key 2048
67       Generating RSA private key, 2048 bit long modulus
68       [...]
69       $ openssl req -new -key tls.key -out tls.csr
70       [...]
71       $ openssl x509 -req -days 365 -signkey tls.key -in tls.csr -out tls.crt
72       [...]
73
74       You will get the tls.key and tls.crt files to use with the VNC backend.
75

SEE ALSO

77       weston(1)
78
79
80
81Weston 12.0.2                     2017-12-14                     WESTON-RDP(7)