summaryrefslogtreecommitdiff
path: root/src/xdg/x11spice/x11spice.conf
blob: 8bb29962f1da7e5375eaf108ef3904eb28e96991 (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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
#-----------------------------------------------------------------------------
#  x11spice configuration file.  See also the x11spice man page.
#   Command line arguments will override settings in the users
#   configuration directory, which will override settings in a
#   system configuration directory.
#  RECOMMENDED USE:  copy this file to ~/.config/x11spice/x11spice.conf
#-----------------------------------------------------------------------------

[spice]
#-----------------------------------------------------------------------------
# listen    Specifies a host and port range to listen for connections
#           from spice clients.  Must take the form:
#             [host]:[port][-endport]
#           By default, host is 'localhost' and port is 5900.  If a range
#           is given (e.g. 5900-5910), then x11spice will attempt to find the
#           first open port in that range
#-----------------------------------------------------------------------------
#listen=5900

#-----------------------------------------------------------------------------
# Password support - only one may be specified
#   password            The password a spice client must give in order to connect
#   generate-password   If given, it represents the length of password to
#                       auto generate.
#   password-file       If given, is the name of a file to read the password from.
#                       The character '-' represents stdin.
#   disable-ticketing   If true, no password is required at all.
# There are no defaults for these options.
#-----------------------------------------------------------------------------
#password=spicey
#generate-password=8
#password-file=-
#disable-ticketing=false

#-----------------------------------------------------------------------------
# VDAgent support
#   virtio-path   Path to a virtual io Unix domain socket.  Should match
#               the path that is given by the '-s' option to spice-vdagent
#   uinput-path   Path to a Unix fifo.  Should match the path given to spice-vdagentd
#               with the '-u' option.
#  If both are not provided, then the VD Agent is not used. 
#-----------------------------------------------------------------------------
#virtio-path=/tmp/xspice-virtio
#uinput-path=/tmp/xspice-uinput

#-----------------------------------------------------------------------------
# Connection callback support
#   on_connect    Path to an program to be invoked upon connection
#                 The address information of the connecotr is passed as the first arg.
#   on_disconnect Path to a program to be invoked upon disconnect.  No args.
#
# *IMPORTANT* - these callbacks can hang up the main spice server process.
#               Make sure that they are atomic, process quickly, and cannot linger.
#
#-----------------------------------------------------------------------------
#on-connect=/usr/bin/x11spice_connected_gnome
#on-disconnect=/usr/bin/x11spice_disconnected_gnome

#-----------------------------------------------------------------------------
# allow-control If set to true, indicates that a remote client is permitted to
#               move the mouse or enter keystrokes.  Default false.
#-----------------------------------------------------------------------------
#allow-control=false

#-----------------------------------------------------------------------------
# timeout   Specifies a time, in seconds, when x11spice exits if no connection
#           has been made.  A time of 0 seconds indicates no timeout.
#-----------------------------------------------------------------------------
#timeout=0

#-----------------------------------------------------------------------------
# audit     Specify whether or not to audit events.  Default false.
#           Note: this requires permission to connect to the audit
#           system, which on most systems is limited to the root user.
#           If true, and you do not have permission, x11spice will exit.
#-----------------------------------------------------------------------------
#audit=false

#-----------------------------------------------------------------------------
# audit-message-type
#           If audit is on, specifies the message type to provide.
#           Refer to audit_log_user_message and 'ausearch --message'
#           for more information.
#           Default: 1196
#-----------------------------------------------------------------------------
#audit-message-type=1196

#-----------------------------------------------------------------------------
# trust-damage
#           By default, x11spice will distrust repeated fullscreen
#           damage reports.  This configuration option allows you to
#           change that behavior.  Allowed values are:
#             auto      Do not trust the 3rd to nth repeated full screen
#                       damage report.  Instead, increase scan frequency.
#             always    Trust each and every damage report.
#             never     Never trust damage.  This mode is not useful in
#                       production, but is useful for testing the scanning
#                       algorithm
#           Default auto.
#-----------------------------------------------------------------------------
#trust-damage=auto

#-----------------------------------------------------------------------------
# full-screen-fps
#           There are use cases where the most effective thing we can
#           do is simply transmit the whole screen periodically, and
#           trust the spice server and the video codecs to optimize.
#           0 disables; otherwise the number indicates how often to
#           transmit the full screen
#           Default 0.
#-----------------------------------------------------------------------------
#full-screen-fps=0

#-----------------------------------------------------------------------------
# minimize  Starts the x11spice gui minimized.  Default false.
#-----------------------------------------------------------------------------
#minimize=false

#-----------------------------------------------------------------------------
# hide      Do not show the x11spice gui at all. Default false.
#-----------------------------------------------------------------------------
#hide=false

#-----------------------------------------------------------------------------
# display   Specify the X display to connect to.  The default is to
#           use the X display given by DISPLAY, or :0 if none.
#-----------------------------------------------------------------------------
#display=:0

#-----------------------------------------------------------------------------
# exit-on-disconnect    If true, then exit x11spice after the first client
#                       disconnects.  Default false.
#-----------------------------------------------------------------------------
#exit-on-disconnect=false

#-----------------------------------------------------------------------------
# ssl                   The ssl section governs spice SSL parameters
#-----------------------------------------------------------------------------
[ssl]
#-----------------------------------------------------------------------------
# enabled               Boolean to turn it on or off.  Default false.
#-----------------------------------------------------------------------------
#enabled=false

#-----------------------------------------------------------------------------
# ca-cert-file          File with CA certificate; e.g. ca-cert.pem
#                       No default; required if enabled=true
#-----------------------------------------------------------------------------
#ca-cert-file=ca-cert.pem

#-----------------------------------------------------------------------------
# certs-file            File with server certificate; e.g. server-cert.pem
#                       No default; required if enabled=true
#-----------------------------------------------------------------------------
#certs-file=server-cert.pem

#-----------------------------------------------------------------------------
# private-key-file      File with key for server cert; e.g. private-key-file
#                       No default; required if enabled=true
#-----------------------------------------------------------------------------
#private-key-file=server-key.pem

#-----------------------------------------------------------------------------
# dh-key-file           A file with Diffie-Hullman parameters.
#                       No default; optional
#-----------------------------------------------------------------------------
#dh-key-file=

#-----------------------------------------------------------------------------
# ciphersuite           Gives the list of ciphers passed in to
#                       SSL_CTX_set_cipher_list.  No default, optional.
#-----------------------------------------------------------------------------
#ciphersuite=HIGH