mirror of
				https://github.com/gyurix1968/guacamole-client.git
				synced 2025-11-03 18:43:22 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			118 lines
		
	
	
		
			4.3 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
			
		
		
	
	
			118 lines
		
	
	
		
			4.3 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
 | 
						|
------------------------------------------------------------
 | 
						|
 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-auth-noauth?
 | 
						|
------------------------------------------------------------
 | 
						|
 | 
						|
guacamole-auth-noauth is a Java library for use with the Guacamole web
 | 
						|
application which removes all authentication. It provides a static set of
 | 
						|
connections to anyone using the web application.
 | 
						|
 | 
						|
Beware that with authentication disabled, any person with access to your
 | 
						|
Guacamole server will have access to any connections it provides. The login
 | 
						|
screen will not appear unless guacamole-auth-noauth was set up incorrectly or
 | 
						|
it is not compatible with your version of Guacamole.
 | 
						|
 | 
						|
 | 
						|
------------------------------------------------------------
 | 
						|
 Compiling and installing guacamole-auth-noauth
 | 
						|
------------------------------------------------------------
 | 
						|
 | 
						|
guacamole-auth-noauth is built using Maven. Building guacamole-auth-noauth
 | 
						|
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.
 | 
						|
 | 
						|
    If this process fails, check the build errors, and verify that the
 | 
						|
    contents of your settings.xml file is correct.
 | 
						|
 | 
						|
2) Extract the .tar.gz file now present in the target/ directory, and
 | 
						|
   place the .jar files in the extracted lib/ subdirectory in the library
 | 
						|
   directory specified in 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) Write a noauth-config.xml file containing all desired connections
 | 
						|
 | 
						|
    The guacamole-auth-noauth authentication provided is configured by a
 | 
						|
    static XML file which lists all available connections.
 | 
						|
 | 
						|
    The file consists of a single <configs> tag which contains any number of
 | 
						|
    <config> tags, each having a name and protocol. These <config> tags
 | 
						|
    correspond to connections.
 | 
						|
 | 
						|
    Each <config> can contain any number of <param> tags which correspond to
 | 
						|
    the parameters of the protocol chosen. Each <param> tag has a name and
 | 
						|
    value, where the name is defined by the documentation of the protocol
 | 
						|
    being used.
 | 
						|
 | 
						|
    For example, to define a single RDP connection to your RDP server with
 | 
						|
    the hostname "my-rdp-server-hostname", you could write:
 | 
						|
 | 
						|
    <configs>
 | 
						|
      <config name="my-rdp-server" protocol="rdp">
 | 
						|
        <param name="hostname" value="my-rdp-server-hostname" />
 | 
						|
        <param name="port" value="3389" />
 | 
						|
      </config>
 | 
						|
    </configs>
 | 
						|
 | 
						|
    When completed, this file should be placed in a common location such
 | 
						|
    that it can be referenced from guacamole.properties, like
 | 
						|
    /etc/guacamole/noauth-config.xml.
 | 
						|
 | 
						|
4) Configure guacamole.properties
 | 
						|
 | 
						|
    An additional property is required by guacamole-auth-noauth which defines
 | 
						|
    where the configuration file is found. It must be added to your
 | 
						|
    guacamole.properties:
 | 
						|
 | 
						|
    # Configuration for NoAuth
 | 
						|
    noauth-config: /etc/guacamole/noauth-config.xml
 | 
						|
 | 
						|
5) Restart Tomcat
 | 
						|
 | 
						|
    The guacamole.properties file as well as any authentication provider .jar
 | 
						|
    files are only read when Tomcat starts. This goes for any other servlet
 | 
						|
    container as well.
 | 
						|
 | 
						|
    You must restart Tomcat before any of the above changes can take effect.
 | 
						|
 | 
						|
 | 
						|
------------------------------------------------------------
 | 
						|
 Reporting problems
 | 
						|
------------------------------------------------------------
 | 
						|
 | 
						|
Please report any bugs encountered by opening a new ticket at the Trac system
 | 
						|
hosted at:
 | 
						|
 | 
						|
    http://guac-dev.org/trac/
 | 
						|
 |