1guacd.conf(5) Apache Guacamole guacd.conf(5)
2
3
4
6 /etc/guacamole/guacd.conf - Configuration file for guacd
7
9 /etc/guacamole/guacd.conf is the configuration file for the Guacamole
10 proxy daemon used by the Guacamole web application and framework,
11 guacd. Use of this file is entirely optional, and all of its options
12 can be specified from the command line when running guacd. If you pro‐
13 vide both the guacd.conf file and command line options, the command
14 line options will take precedence.
15
17 guacd.conf is made up of sections, where each section contains a set of
18 parameter/value pairs. The parameters available are dictated by the
19 section in use, and parameters may only be specified within a section.
20
21 The beginning of each section is denoted with a section name in brack‐
22 ets, and each section ends implicitly with the beginning of a new sec‐
23 tion, or at the end of the file.
24
25 [server]
26 Contains parameters which control how guacd behaves as a server,
27 from a network perspective.
28
29 [daemon]
30 Parameters which configure how guacd behaves as a daemon, such
31 as what file should contain the PID, if any.
32
33 [ssl] Parameters which control the SSL support of guacd, such as the
34 certificate and private key used for encryption of the Guacamole
35 protocol. This section and its parameters are only valid if
36 guacd was built with SSL support.
37
38 Parameters within sections are written as a parameter name, followed by
39 an equals sign, followed by the parameter value, all on one line. Com‐
40 ments may be placed anywhere, and consist of arbitrary text following a
41 # symbol until end-of-line:
42
43 name = value # Some arbitrary comment text
44
45 Beware that it is the combination of the section name with the parame‐
46 ter name that makes up the fully qualified name of a parameter. Each
47 parameter absolutely must be placed only within its proper section, or
48 guacd.conf will fail to be parsed, and guacd will not start.
49
50 If special characters need to be placed within a parameter value, such
51 as whitespace, #, ", or \, the entire value must be enclosed in double
52 quotes, and each occurrence of " or \ within the value must be escaped
53 with backslashes:
54
55 name = "quoted # value \\ with \" special characters"
56
58 bind_host = HOSTNAME
59 Requires guacd to bind to a specific host when listening for
60 connections. By default, guacd will bind to localhost only.
61
62 bind_port = PORT
63 Requires guacd to bind to a specific port when listening for
64 connections. By default, guacd will bind to port 4822.
65
67 log_level = LEVEL
68 Sets the maximum level at which guacd will log messages to sys‐
69 log and, if running in the foreground, the console. Legal val‐
70 ues are trace, debug, info, warning, and error. The default
71 value is info.
72
73 pid_file = FILE
74 Causes guacd to write its PID to the specified file upon
75 startup. Note that guacd must have sufficient privileges to cre‐
76 ate or write this file, or it will fail to start. This parameter
77 is typically needed for startup scripts, such that the script
78 can report on the status of guacd and kill it if necessary.
79
81 If guacd was built with SSL support, then connections between the web
82 application and guacd can be encrypted if an SSL certificate and key
83 file are given.
84
85 When using a chain of certificates, you must append the additional cer‐
86 tificates to your server certificate. This can be done easily with the
87 standard cat command. Beware that the certificate for guacd must be the
88 first certificate in the file.
89
90 server_certificate = CERTIFICATE FILE
91 Enables SSL/TLS using the given cerficiate file. Future connec‐
92 tions to guacd will require SSL/TLS enabled in the client (the
93 web application).
94
95 server_key = KEY FILE
96 Enables SSL/TLS using the given private key file. Future connec‐
97 tions to guacd will require SSL/TLS enabled in the client (the
98 web application).
99
101 #
102 # guacd.conf example
103 #
104
105 [daemon]
106
107 pid_file = /var/run/guacd.pid
108
109 [server]
110
111 bind_host = localhost
112 bind_port = 4822
113
114 [ssl]
115
116 server_certificate = /etc/ssl/certs/guacd.crt
117 server_key = /etc/ssl/private/guacd.key
118
119
120
121version 1.5.4 1 Jun 2017 guacd.conf(5)