Ticket #269: Created some documentation and included generated MyBatis mappings.

extensions/guacamole-auth-mysql/README

@@ -0,0 +1,93 @@
+
+------------------------------------------------------------
+ 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-mysql?
+------------------------------------------------------------
+
+guacamole-auth-ldap is a Java library for use with the Guacamole web
+application to provide mysql based authentication.
+
+guacamole-auth-mysql provides an authentication provider which can be
+set in guacamole.properties to allow mysql authentication of Guacamole
+users. Additional properties are required to configure the mysql
+connection parameters.
+
+A schema file are provided to create the required tables in your
+mysql database.
+
+
+------------------------------------------------------------
+ Compiling and installing guacamole-auth-mysql
+------------------------------------------------------------
+
+guacamole-auth-mysql is built using Maven. Building guacamole-auth-mysql
+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 MySQL database to authenticate Guacamole users
+
+    A schema file is provided in the schema directory for creating
+    the guacamole authentication tables in your MySQL database.
+
+4) Configure guacamole.properties for MySQL
+
+    There are additional properties required by the MySQL JDBC driver
+    which must be added/changed in your guacamole.properties:
+
+    # Configuration for MySQL connection
+    mysql-hostname:           mysql.host.name
+    mysql-port:               3306
+    mysql-database:           guacamole.database.name
+    mysql-username:           user
+    mysql-password:           pass
+
+
+------------------------------------------------------------
+ Generating MyBatis ORM mappings
+------------------------------------------------------------
+
+See the README.mybatis file.
+
+------------------------------------------------------------
+ Reporting problems
+------------------------------------------------------------
+
+Please report any bugs encountered by opening a new ticket at the Trac system
+hosted at:
+    
+    http://guac-dev.org/trac/
+