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 guacd?
  21 ------------------------------------------------------------
  22
  23 guacd is the Guacamole proxy daemon used by the Guacamole web application and
  24 framework. As JavaScript cannot handle binary protocols (like VNC and remote
  25 desktop) efficiently, a new test-based protocol was developed which would
  26 contain a common superset of the operations needed for efficient remote
  27 desktop access, but would be easy for JavaScript programs to process. guacd
  28 is the proxy which translates between arbitrary protocols and the Guacamole
  29 protocol.
  30
  31
  32 ------------------------------------------------------------
  33  Compiling and installing guacd
  34 ------------------------------------------------------------
  35
  36 Please note that distribution-specific pre-compiled packages are available from
  37 the files section of the main project site:
  38
  39     http://sourceforge.net/projects/guacamole/files/
  40
  41 guacd is built using the popular GNU Automake, and thus provides the standard
  42 configure script. Before compiling, you need to have compiled and installed
  43 libguac, the core Guacamole library. This is available from the main Guacamole
  44 site at http://guac-dev.org/.
  45
  46 1) Run configure
  47
  48     $ ./configure
  49
  50     Assuming all dependencies have been installed, this should succeed without
  51     errors. If you wish to install the init script as well, you need to specify
  52     the location where your system init scripts are located (typically
  53     /etc/init.d):
  54
  55     $ ./configure --with-init-dir=/etc/init.d
  56
  57     Running configure in this manner will cause the "make install" step to
  58     install an init script to the specified directory, which you can then
  59     activate using the service management mechanism provided by your
  60     distribution).
  61
  62 2) Run make
  63
  64     $ make
  65
  66     guacd will now compile.
  67
  68 3) Install (as root)
  69
  70     # make install
  71
  72     guacd will install to your /usr/local/sbin directory by default. You can
  73     change the install location by using the --prefix option for configure.
  74
  75
  76 ------------------------------------------------------------
  77  Running guacd
  78 ------------------------------------------------------------
  79
  80 If you installed the init script during compile and install, you should be
  81 able to start guacd through the service management utilities provided by
  82 your distribution (if any) or by running the init script directly (as root):
  83
  84     # /etc/init.d/guacd start
  85
  86 Root access is needed to write the pidfile /var/run/guacd.pid. You can also run
  87 guacd itself directly without the init script (as any user):
  88
  89     $ guacd
  90
  91 guacd currently takes four command-line options:
  92
  93     -b HOST
  94
  95         Changes the host or address that guacd listens on.
  96
  97     -l PORT
  98
  99         Changes the port that guacd listens on (the default is port 4822).
 100
 101     -p PIDFILE
 102
 103         Causes guacd to write the PID of the daemon process to the specified
 104         file. This is useful for init scripts and is used by the provided init
 105         script.
 106
 107     -f
 108         Causes guacd to run in the foreground, rather than automatically
 109         forking into the background.
 110
 111
 112 ------------------------------------------------------------
 113  Reporting problems
 114 ------------------------------------------------------------
 115
 116 Please report any bugs encountered by opening a new ticket at the Trac system
 117 hosted at:
 118
 119     http://guac-dev.rg/trac/
 120