Skip to content

Commit

Permalink
GUACAMOLE-1026: Update documentation for freerdp3 support.
Browse files Browse the repository at this point in the history
  • Loading branch information
aleitner committed Aug 26, 2024
1 parent 98abf72 commit 96d121c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
8 changes: 7 additions & 1 deletion src/installing-guacamole.md
Original file line number Diff line number Diff line change
Expand Up @@ -460,6 +460,13 @@ fail outright, and you will need to install the missing dependency. If, after
running `configure`, you find support for something you wanted is missing,
simply install the corresponding dependencies and run `configure` again.

During the configure process, the script will attempt to detect the version of
FreeRDP installed on your system. It will first look for FreeRDP version 3,
indicated as freerdp3 ............ yes. If FreeRDP version 3 is not found, it will
then check for FreeRDP version 2, which would be shown as
freerdp2 ............ yes. The output will reflect the specific version found,
ensuring that the build process aligns with the available FreeRDP library.

:::{important}
All protocols that require a terminal (Kubernetes, SSH, and telnet) require
that fonts are installed on the Guacamole server in order to function, as
Expand Down Expand Up @@ -767,4 +774,3 @@ it will immediately and transparently fall back to using HTTP.
WebSocket is supported in Guacamole for Tomcat 7.0.37 or higher, Jetty 8 or
higher, and any servlet container supporting JSR 356, the standardized Java API
for WebSocket.

9 changes: 5 additions & 4 deletions src/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -364,9 +364,11 @@ If libguac-client-rdp cannot load this plugin, support for any features which
leverage static virtual channels will not work, and the reason will be logged.
A likely explanation is that libguac-client-rdp was built from source, and the
directory specified for FreeRDP's installation location was incorrect. For
FreeRDP to be able to find plugins, those plugins must be placed in the
`freerdp2/` subdirectory of whichever directory contains the `libfreerdp2.so`
library.
FreeRDP to be able to find plugins, those plugins must be placed in the correct
subdirectory relative to the version of FreeRDP installed. For FreeRDP 2, plugins
should be placed within the `freerdp2/` subdirectory of whichever directory
contains `libfreerdp2.so`, and similarly, for FreeRDP 3, plugins should be placed
in the `freerdp3/` subdirectory of whichever directory contains `libfreerdp3.so`.

#### Server requested unsupported clipboard data type

Expand Down Expand Up @@ -539,4 +541,3 @@ an instruction to have a length prefix, which must be composed entirely of
numeric characters (digits 0 through 9). If a non-numeric character is read,
then something has gone wrong during transmission. This usually indicates a bug
in the client plugin in use, guacd, or libguac.

0 comments on commit 96d121c

Please sign in to comment.