[jira] [Created] (GUACAMOLE-328) Documentation omits that libssl is required for ssh support

["Anna Winters (JIRA)" <ji...@apache.org>]

Anna Winters created GUACAMOLE-328:
--------------------------------------

             Summary: Documentation omits that libssl is required for ssh support
                 Key: GUACAMOLE-328
                 URL: https://issues.apache.org/jira/browse/GUACAMOLE-328
             Project: Guacamole
          Issue Type: Bug
          Components: Documentation
    Affects Versions: 0.9.12-incubating
         Environment: A minimal Ubuntu 16.04 image running in Docker
            Reporter: Anna Winters
            Priority: Trivial


Chapter 2 of the documentation, "Installing Guacamole natively", says the following with respect to building guacamole-server:
{quote}SSH support depends on libssh2 and Pango (a font rendering and text layout library, used by Guacamole's built-in terminal emulator).{quote}

However, running the ./configure script with libssh2 and pango installed gives the following output i.e. there will be no SSH support:

{noformat}
   Library status:

     freerdp ............. no
     pango ............... yes
     libavcodec .......... no
     libavutil ........... yes
     libssh2 ............. yes
     libssl .............. no
     libswscale .......... no
     libtelnet ........... no
     libVNCServer ........ yes
     libvorbis ........... no
     libpulse ............ no
     libwebp ............. yes

   Protocol support:

      RDP ....... no
      SSH ....... no
      Telnet .... no
      VNC ....... yes
{noformat}

The README file does say that openssl is also required:
{quote}
------------------------------------------------------------
 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/){quote}

And the documentation itself says further down the page (in the libssl section)
{quote}Without SSL support, there will be no option to encrypt communication to guacd, and support for SSH cannot be built.{quote}

And it is correct, SSH support starts working with libssl installed:

{noformat}
   Library status:

     freerdp ............. no
     pango ............... yes
     libavcodec .......... no
     libavutil ........... yes
     libssh2 ............. yes
     libssl .............. yes
     libswscale .......... no
     libtelnet ........... no
     libVNCServer ........ yes
     libvorbis ........... no
     libpulse ............ no
     libwebp ............. yes

   Protocol support:

      RDP ....... no
      SSH ....... yes
      Telnet .... no
      VNC ....... yes
{noformat}

The original text, which appears at the highest point in the page and in a bigger font, could be updated to also mention openssl, so others don't end up in the situation that I did (installing pango and libssh and wondering why SSH support wasn't being built).



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)