Repository: incubator-guacamole-server Updated Branches: refs/heads/staging/0.9.10-incubating bb1310533 -> 68fdd4d29
GUACAMOLE-145: Update README to include (correct) required and optional dependencies. Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/commit/40cc1536 Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/tree/40cc1536 Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/diff/40cc1536 Branch: refs/heads/staging/0.9.10-incubating Commit: 40cc1536af5b186e1f1479a4ea2ea3bc17c5b66f Parents: 78e6215 Author: Michael Jumper <[email protected]> Authored: Sat Dec 17 22:00:55 2016 -0800 Committer: Michael Jumper <[email protected]> Committed: Sat Dec 17 22:00:55 2016 -0800 ---------------------------------------------------------------------- README | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 58 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/blob/40cc1536/README ---------------------------------------------------------------------- diff --git a/README b/README index f16ead9..ac017e7 100644 --- a/README +++ b/README @@ -32,13 +32,68 @@ proxy which translates between arbitrary protocols and the Guacamole protocol. ------------------------------------------------------------ + Required dependencies +------------------------------------------------------------ + +All software within guacamole-server is built using the popular GNU Automake, +and thus provides the standard configure script. Before compiling, at least +the following required dependencies must already be installed: + + 1) Cairo (http://cairographics.org/) + + 2) libjpeg-turbo (http://libjpeg-turbo.virtualgl.org/) + OR libjpeg (http://www.ijg.org/) + + 3) libpng (http://www.libpng.org/pub/png/libpng.html) + + 4) OSSP UUID (http://www.ossp.org/pkg/lib/uuid/) + + +------------------------------------------------------------ + Optional dependencies +------------------------------------------------------------ + +In addition, the following optional dependencies may be installed in order to +enable optional features of Guacamole. Note that while the various supported +protocols are technically optional, you will no doubt wish to install the +dependencies of at least ONE supported protocol, as Guacamole would be useless +otherwise. + + RDP: + * FreeRDP (http://www.freerdp.com/) + + SSH: + * libssh2 (http://www.libssh2.org/) + * OpenSSL (https://www.openssl.org/) + * Pango (http://www.pango.org/) + + Telnet: + * libtelnet (https://github.com/seanmiddleditch/libtelnet) + * Pango (http://www.pango.org/) + + VNC: + * libVNCserver (http://libvnc.github.io/) + + Support for audio within VNC: + * PulseAudio (http://www.freedesktop.org/wiki/Software/PulseAudio/) + + Support for SFTP file transfer for VNC or RDP: + * libssh2 (http://www.libssh2.org/) + * OpenSSL (https://www.openssl.org/) + + Support for WebP image compression: + * libwebp (https://developers.google.com/speed/webp/) + + "guacenc" video encoding utility: + * FFmpeg (https://ffmpeg.org/) + + +------------------------------------------------------------ Compiling and installing guacd, libguac, etc. ------------------------------------------------------------ All software within guacamole-server is built using the popular GNU Automake, -and thus provides the standard configure script. Before compiling, you need to -have compiled and installed libguac, the core Guacamole library. This is -available from the main Apache Guacamole site at http://guacamole.incubator.apache.org/. +and thus provides the standard configure script. 1) Run configure
