Uploaded image for project: 'Guacamole'
  1. Guacamole
  2. GUACAMOLE-328

Documentation omits that libssl is required for ssh support

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: 0.9.12-incubating
    • Fix Version/s: 0.9.14
    • Component/s: Documentation
    • Labels:
    • Environment:
      A minimal Ubuntu 16.04 image running in Docker

      Description

      Chapter 2 of the documentation, "Installing Guacamole natively", says the following with respect to building guacamole-server:

      SSH support depends on libssh2 and Pango (a font rendering and text layout library, used by Guacamole's built-in terminal emulator).

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

         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
      

      The README file does say that openssl is also required:

      ------------------------------------------------------------
      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:

      SSH:

      And the documentation itself says further down the page (in the libssl section)

      Without SSL support, there will be no option to encrypt communication to guacd, and support for SSH cannot be built.

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

         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
      

      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).

        Attachments

          Activity

            People

            • Assignee:
              nick.couchman@yahoo.com Nick Couchman
              Reporter:
              Anewi Anna Winters
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: