Skip to content

Commit 213453d

Browse files
committed
GUACAMOLE-2038: Document configuring outbound IPv6 connections from guacamole
1 parent e2ef925 commit 213453d

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

src/guacamole-docker.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,31 @@ detail in the sections below. If the required configuration options for at
176176
least one authentication mechanism are not provided, the Guacamole image will
177177
not be able to start up, and you will see an error.
178178

179+
(guacamole-docker-ipv6)=
180+
181+
### Configure Guacamole to prefer IPv6 for outbound connections
182+
183+
By default, Guacamole will use IPv4 for all outbound connections, where an
184+
A record is present in DNS. IPv6 will be used only if there are only AAAA
185+
records in DNS, or if an IPv6 address is hard-coded.
186+
187+
Additionally, Guacamole will only attempt to make one connection to a single
188+
IP address, so if the IPv4 connection fails, it will not fall back to IPv6.
189+
This can be problematic for IPv6-only deployments, where such connections may
190+
fail with a "Network is unreachable" error.
191+
192+
To override this, set the `JAVA_OPTS` environment variable to
193+
`-Djava.net.preferIPv6Addresses=true`.
194+
195+
This does not affect which protocol guacd uses to connect to servers.
196+
197+
This will however affect the protocol used by guacamole to connect to guacd, to
198+
use IPv6 if available. By default, guacd listens to IPv4 connections only. You'll
199+
also need to [configure guacd to listen to IPv6 connections](#guacd-docker-ipv6).
200+
201+
This will also affect other outbound connections from guacamole-server, such as
202+
connections to connect to a JWKS endpoint, as used by the OIDC extension.
203+
179204
(guacamole-docker-mysql)=
180205

181206
### MySQL authentication

0 commit comments

Comments
 (0)