mirror of
https://github.com/gyurix1968/guacamole-client.git
synced 2025-09-07 05:31:22 +00:00
GUACAMOLE-107: Remove horrendously out-of-date READMEs.
This commit is contained in:
Michael Jumper
@@ -1,113 +0,0 @@
|
||||
|
||||
------------------------------------------------------------
|
||||
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.
|
||||
|
||||
Source archives and pre-built .jar files are available from the downloads
|
||||
section of the project website:
|
||||
|
||||
http://guacamole.incubator.apache.org/
|
||||
|
||||
A full manual is available as well:
|
||||
|
||||
http://guacamole.incubator.apache.org/doc/gug/
|
||||
|
||||
|
||||
------------------------------------------------------------
|
||||
What is guacamole-auth-jdbc?
|
||||
------------------------------------------------------------
|
||||
|
||||
guacamole-auth-jdbc is a Java library for use with the Guacamole web
|
||||
application to provide database-driven authentication.
|
||||
|
||||
guacamole-auth-jdbc provides multiple authentication provider implementations
|
||||
which each provide a support for a different database. These authentication
|
||||
providers can be set in guacamole.properties to allow authentication of
|
||||
Guacamole users through that type of database.
|
||||
|
||||
Schema files are provided to create the required tables in your database of
|
||||
choice.
|
||||
|
||||
|
||||
------------------------------------------------------------
|
||||
Compiling and installing guacamole-auth-jdbc
|
||||
------------------------------------------------------------
|
||||
|
||||
guacamole-auth-jdbc is built using Maven. Building guacamole-auth-jdbc compiles
|
||||
all classes and packages them into a redistributable .tar.gz archive. This
|
||||
archive contains multiple .jar files, each of this corresponds to a
|
||||
database-specific authentication provider implementation that can be installed
|
||||
in the library directory configured in guacamole.properties.
|
||||
|
||||
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.
|
||||
|
||||
4) Extract the .tar.gz file now present in the target/ directory, and
|
||||
place the .jar files from the extracted database-specific 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.
|
||||
|
||||
5) Set up your database to authenticate Guacamole users
|
||||
|
||||
A schema file is provided in the schema directory for creating
|
||||
the guacamole authentication tables in your database of choice.
|
||||
|
||||
Additionally, a script is provided to create a default admin user
|
||||
with username 'guacadmin' and password 'guacadmin'. This user can
|
||||
be used to set up any other connections and users.
|
||||
|
||||
6) Configure guacamole.properties for your database
|
||||
|
||||
There are additional properties required by JDBC drivers which must
|
||||
be added/changed in your guacamole.properties. These parameters are
|
||||
specific to the database being used.
|
||||
|
||||
For MySQL, the following properties are available:
|
||||
|
||||
# Database connection configuration
|
||||
mysql-hostname: database.host.name
|
||||
mysql-port: 3306
|
||||
mysql-database: guacamole.database.name
|
||||
mysql-username: user
|
||||
mysql-password: pass
|
||||
|
||||
Optionally, the authentication provider can be configured
|
||||
not to allow multiple users to use the same connection
|
||||
at the same time:
|
||||
|
||||
mysql-disallow-simultaneous-connections: true
|
||||
|
||||
For PostgreSQL, the properties are the same, but have different prefixes:
|
||||
|
||||
# Database connection configuration
|
||||
postgresql-hostname: database.host.name
|
||||
postgresql-port: 5432
|
||||
postgresql-database: guacamole.database.name
|
||||
postgresql-username: user
|
||||
postgresql-password: pass
|
||||
|
||||
postgresql-disallow-simultaneous-connections: true
|
||||
|
||||
|
||||
------------------------------------------------------------
|
||||
Reporting problems
|
||||
------------------------------------------------------------
|
||||
|
||||
Please report any bugs encountered by opening a new issue in the JIRA system
|
||||
hosted at:
|
||||
|
||||
https://issues.apache.org/jira/browse/GUACAMOLE/
|
||||
|
||||
@@ -1,103 +0,0 @@
|
||||
|
||||
------------------------------------------------------------
|
||||
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.
|
||||
|
||||
Source archives and pre-built .jar files are available from the downloads
|
||||
section of the project website:
|
||||
|
||||
http://guacamole.incubator.apache.org/
|
||||
|
||||
A full manual is available as well:
|
||||
|
||||
http://guacamole.incubator.apache.org/doc/gug/
|
||||
|
||||
|
||||
------------------------------------------------------------
|
||||
What is guacamole-auth-ldap?
|
||||
------------------------------------------------------------
|
||||
|
||||
guacamole-auth-ldap is a Java library for use with the Guacamole web
|
||||
application to provide LDAP based authentication.
|
||||
|
||||
guacamole-auth-ldap provides an authentication provider which can be
|
||||
set in guacamole.properties to allow LDAP authentication of Guacamole
|
||||
users. Additional properties are required to configure the LDAP
|
||||
connection and search parameters.
|
||||
|
||||
Schema files are provided to create the required object classes in your
|
||||
LDAP directory.
|
||||
|
||||
|
||||
------------------------------------------------------------
|
||||
Compiling and installing guacamole-auth-ldap
|
||||
------------------------------------------------------------
|
||||
|
||||
guacamole-auth-ldap is built using Maven. Building guacamole-auth-ldap
|
||||
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) Set up your LDAP server to authenticate Guacamole users
|
||||
|
||||
Schema files are provided in the doc directory for creating
|
||||
the "guacConfig" object class required.
|
||||
|
||||
You must add guacConfig objects to your LDAP directory. Each
|
||||
guacConfig represents a connection configuration, which is made
|
||||
up of a protocol and any number of protocol-specific parameters.
|
||||
|
||||
4) Configure guacamole.properties for LDAP
|
||||
|
||||
There are additional properties required by the LDAP authentication
|
||||
provider which must be added/changed in your guacamole.properties:
|
||||
|
||||
# Use LDAP authentication
|
||||
auth-provider: net.sourceforge.guacamole.net.auth.ldap.LDAPAuthenticationProvider
|
||||
|
||||
# Configuration for LDAP connection
|
||||
ldap-hostname: LDAP_SERVER_HOSTNAME
|
||||
ldap-port: 389
|
||||
|
||||
# The attribute which uniquely identifies users
|
||||
ldap-username-attribute: uid
|
||||
|
||||
# The base DN which, when appended to the user identifier attribute,
|
||||
# produces the full DN of the user being authenticated.
|
||||
ldap-user-base-dn: ou=people,dc=example,dc=net
|
||||
|
||||
# The base DN within which all guacConfig objects can be found.
|
||||
ldap-config-base-dn: dc=example,dc=net
|
||||
|
||||
# The base DN within which all role based groups can be found.
|
||||
ldap-group-base-dn: ou=groups,dc=example,dc=net
|
||||
|
||||
------------------------------------------------------------
|
||||
Reporting problems
|
||||
------------------------------------------------------------
|
||||
|
||||
Please report any bugs encountered by opening a new issue in the JIRA system
|
||||
hosted at:
|
||||
|
||||
https://issues.apache.org/jira/browse/GUACAMOLE/
|
||||
|
||||
@@ -1,117 +0,0 @@
|
||||
|
||||
------------------------------------------------------------
|
||||
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/
|
||||
|
||||
Reference in New Issue
Block a user