What is Guacamole?
Guacamole is an HTML5 remote desktop gateway.
Guacamole provides access to desktop environments
using remote desktop protocols like VNC and RDP. A
centralized server acts as a tunnel and proxy, allowing
access to multiple desktops through a web browser.
No browser plugins are needed, and no client
software needs to be installed. The client requires
nothing more than a web browser supporting HTML5 and
The latest release of Guacamole is
Pre-built bundles of packages and installation
instructions are available for Debian, Ubuntu, and
Fedora. If we don't provide builds for your distribution or
UNIX variant, or the packages provided by your distribution are
too out of date or do not exist, you can also build
Guacamole and all its components from source.
As of release 0.8.0, Guacamole now has officially supported
extensions. Currently, a MySQL authentication module is the
only official extension available. The LDAP authentication that
has existed in unstable form for some time is next on the list
to be documented and added below.
The MySQL authentication module provides features not
present with the default authentication mechanism, like the
ability to manage users and connections from within the web
Guacamole is supported entirely through donations and out of
the pockets of the developers. If you appreciate Guacamole and
would like to donate, thank you! We accept donations
Another way to send money to the project is to buy the print
version of the manual. The Guacamole User's Guide is updated
with every release and as necessary. The contents are available for free here as the
official documentation, but having a physical reference is
always nice, and proceeds from book sales enter the project
directly as donations.
Code contributions are also always welcome. If you have
patches you think would benefit the project, feel free to
contact us via IRC or email, or open a new ticket on Trac with your patch attached.
Public discussion of development efforts is done over IRC at
freenode.net on the #guacamole-dev channel. If you wish to
develop a Guacamole-based web application, or to develop new
protocol support plugins for guacd, please consult the API documentation.
If you need help getting started, the manual contains
If you need (or wish to provide) help with Guacamole, there
on the SourceForge
project page. You will need to register a username with
SourceForge to use the forums. There
is also an IRC channel on freenode.net dedicated to
Guacamole support: #guacamole-help.
If you think you've encountered a bug in Guacamole or any of
its components, or you wish to request a feature, please create
a new ticket at the Trac system hosted here. New tickets and
comments are moderated to prevent spam. Be sure to provide
your email address if you wish to be kept updated regarding