README

------------------------------------------------------------
 About this README
------------------------------------------------------------

This README is intended to provide quick and to-the-point documentation for
technical users intending to compile parts of Guacamole themselves.

Distribution-specific packages are available from the files section of the main
project page:
 
    http://sourceforge.net/projects/guacamole/files/

Distribution-specific documentation is provided on the Guacamole wiki:

    http://guac-dev.org/


------------------------------------------------------------
 What is guacamole-printing ?
------------------------------------------------------------

Guacamole-printing contains all the required for printing 
support inside guacamole. Not that it requires a patched guacd 
and a patched freeRDP in order to work. It aims to provide several printing
backends. Supported backends are :
 * PDF Download of print result (Ulteo TS Printer Driver)

------------------------------------------------------------
 Compiling and installing guacamole-printing
------------------------------------------------------------

guacamole-printing is built using Maven. Building guacamole-printing
compiles all classes and packages them into a redistributable .jar file. This
.jar file can be installed in the library directory configured in
guacamole.properties such that the authentication provider is available.

1) Run mvn package

    $ mvn package

    Maven will download any needed dependencies for building the .jar file.
    Once all dependencies have been downloaded, the .jar file will be
    created in the target/ subdirectory of the current directory.

2) Copy the .jar file into the library directory specified in your
   guacamole.properties

    You will likely need to do this as root.

    If you do not have a library directory configured in your
    guacamole.properties, you will need to specify one. The directory
    is specified using the "lib-directory" property.

3) Check that the web.xml references the Servlet for the /printing/ URL. Sample web.xml : 

   <!-- OVD PDF Printing Servlet -->
    <servlet>
        <description>Ulteo PDF printer</description>
        <servlet-name>GuacamolePrinterServlet</servlet-name>
        <servlet-class>net.sourceforge.guacamole.printing.GuacamolePrinterServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>GuacamolePrinterServlet</servlet-name>
        <url-pattern>/printer/*</url-pattern>
    </servlet-mapping>

Note that the Ulteo version of guacamole includes that entry in its web.xml.

------------------------------------------------------------
 Reporting problems
------------------------------------------------------------

Please report any bugs encountered by opening a new ticket at the Trac system
hosted at:
    
    http://guac-dev.org/trac/