README
1
2------------------------------------------------------------
3 About this README
4------------------------------------------------------------
5
6This README is intended to provide quick and to-the-point documentation for
7technical users intending to compile parts of Apache Guacamole themselves.
8
9Source archives and pre-built .war files are available from the downloads
10section of the project website:
11
12 http://guacamole.apache.org/
13
14A full manual is available as well:
15
16 http://guacamole.apache.org/doc/gug/
17
18
19------------------------------------------------------------
20 What is guacamole-client?
21------------------------------------------------------------
22
23guacamole-client is the superproject containing all Maven-based projects that
24make Apache Guacamole, an HTML5 web application that provides access to your
25desktop using remote desktop protocols.
26
27guacamole-client is used to build the subprojects that make up Guacamole, and
28to provide a common central repository. Each project contained here is
29completely independent of guacamole-client and can be built separately, though
30the others may have to be built first. If all projects are built using
31guacamole-client, Maven will take care of the proper build order.
32
33
34------------------------------------------------------------
35 Compiling and installing Apache Guacamole
36------------------------------------------------------------
37
38Apache Guacamole is built using Maven. Building Guacamole compiles all classes
39and packages them into a deployable .war file. This .war file can be installed
40and deployed under servlet containers like Apache Tomcat or Jetty.
41
421) Run mvn package
43
44 $ mvn package
45
46 Maven will download any needed dependencies for building the .jar file.
47 Once all dependencies have been downloaded, the .war file will be
48 created in the guacamole/target/ subdirectory of the current directory.
49
502) Copy the .war file as directed in the instructions provided with
51 your servlet container.
52
53 Apache Tomcat, Jetty, and other servlet containers have specific and
54 varying locations that .war files must be placed for the web
55 application to be deployed.
56
57 You will likely need to do this as root.
58
59
60------------------------------------------------------------
61 Reporting problems
62------------------------------------------------------------
63
64Please report any bugs encountered by opening a new issue in the JIRA system
65hosted at:
66
67 https://issues.apache.org/jira/browse/GUACAMOLE/
68
69