File	Date	Author	Commit
doc	2012-09-12	caphalor40k	[2c471c] Initial commit
src	2012-09-12	caphalor40k	[2c471c] Initial commit
README	2012-09-12	caphalor40k	[2c471c] Initial commit
pom.xml	2012-09-12	caphalor40k	[2c471c] Initial commit

Read Me

------------------------------------------------------------
 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.

------------------------------------------------------------
 What is guacamole-auth-h2?
------------------------------------------------------------

guacamole-auth-h2 is a Java library for use with the Guacamole web
application to provide H2DB based authentication.

It is important to know that this version is only tested with guacamole 0.5.0.

guacamole-auth-h2 provides an authentication provider which can be
set in guacamole.properties to allow H2 authentication of Guacamole
users. Additional properties are required to configure the H2
connection and search parameters.

Schema file is provided (/doc) to create the required tables in your
h2 database.

------------------------------------------------------------
 Compiling and installing guacamole-auth-h2
------------------------------------------------------------

guacamole-auth-h2 is built using Maven. Building guacamole-auth-h2
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 files (guacamole-auth-h2*.jar and h2*.jar) 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 H2 database to authenticate Guacamole users

    SQL dump file are provided in the doc directory for creating
    the required tables.

    You must add users,guacamole configs and config params to your H2DB. Each
    entry represents a connection configuration, which is made
    up of a protocol and any number of protocol-specific parameters. You can find an
    example in the doc directory

4) Configure guacamole.properties for H2DB

    There are additional properties required by the H2 authentication
    provider which must be added/changed in your guacamole.properties:

# H2 authentication
auth-provider: de.ra.bad.guacamole.net.auth.h2.H2AuthenticationProvider
lib-directory: /var/lib/guacamole/lib

# Configuration for H2 connection
h2-hostname:           localhost
h2-port:               9092
h2-database:           /home/www/guacamole

------------------------------------------------------------
 Conclusion
------------------------------------------------------------

This plugin is ready and deprecated. Any changes can even be implemented.