README

   1
   2 ------------------------------------------------------------
   3  About this README
   4 ------------------------------------------------------------
   5
   6 This README is intended to provide quick and to-the-point documentation for
   7 technical users intending to compile parts of Guacamole themselves.
   8
   9 Distribution-specific packages are available from the files section of the main
  10 project page:
  11
  12     http://sourceforge.net/projects/guacamole/files/
  13
  14 Distribution-specific documentation is provided on the Guacamole wiki:
  15
  16     http://guac-dev.org/
  17
  18
  19 ------------------------------------------------------------
  20  What is Guacamole?
  21 ------------------------------------------------------------
  22
  23 Guacamole is an HTML5 web application that provides access to your desktop using
  24 remote desktop protocols. A centralized server acts as a tunnel and proxy,
  25 allowing access to multiple desktops through a web browser; no plugins needed.
  26 The client requires nothing more than a web browser supporting HTML5 and AJAX.
  27
  28 The Guacamole project maintains this web application and the Java and C
  29 libraries and programs it depends on. These libraries and programs are
  30 separate in order to enable others to implement other applications using the
  31 same underlying technology.
  32
  33 All components and dependencies of Guacamole are free and open source.
  34
  35
  36 ------------------------------------------------------------
  37  Compiling and installing Guacamole
  38 ------------------------------------------------------------
  39
  40 Guacamole is built using Maven. Building Guacamole compiles all classes and
  41 packages them into a deployable .war file. This .war file can be installed
  42 and deployed under servlet containers like Apache Tomcat or Jetty.
  43
  44 1) Run mvn package
  45
  46     $ mvn package
  47
  48     Maven will download any needed dependencies for building the .jar file.
  49     Once all dependencies have been downloaded, the .war file will be
  50     created in the target/ subdirectory of the current directory.
  51
  52 2) Copy the .war file as directed in the instructions provided with
  53    your servlet container.
  54
  55    Apache Tomcat, Jetty, and other servlet containers have specific and
  56    varying locations that .war files must be placed for the web
  57    application to be deployed.
  58
  59    You will likely need to do this as root.
  60
  61
  62 ------------------------------------------------------------
  63  Reporting problems
  64 ------------------------------------------------------------
  65
  66 Please report any bugs encountered by opening a new ticket at the Trac system
  67 hosted at:
  68
  69     http://guac-dev.org/trac/
  70