diff --git a/extensions/guacamole-auth-mysql/README b/extensions/guacamole-auth-mysql/README index bf1e3b1fb..5543c124f 100644 --- a/extensions/guacamole-auth-mysql/README +++ b/extensions/guacamole-auth-mysql/README @@ -41,7 +41,77 @@ 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 +1) Set up a MySQL database with the Guacamole schema. + + When guacamole-auth-mysql is compiling, it needs to generate source + based on a database schema. Because the source generator uses a + connection to an actual database to do this, you must have a MySQL + database running with the Guacamole schema set up. + + First, create a database. For the sake of these instructions, we will + call the database "guacamole", and will run all scripts as the root user: + + $ mysql -u root -p + Enter password: + mysql> CREATE DATABASE guacamole; + Query OK, 1 row affected (0.00 sec) + + mysql> exit + Bye + + The schema files are in the schema/ subdirectory of the source. If run + in order, they will create the schema and a default user: + + $ cat schema/*.sql | mysql -u root -p guacamole + +2) Set up your ~/.m2/settings.xml + + Once the database is set up, Maven will need to have the credentials + required to connect to it and query the schema. This information is + specified in properties inside your ~/.m2/settings.xml file. If this + file does not exist yet, simply create it. + + For ease of compilation, we've included an example settings.xml + defining the required properties in doc/example/settings.xml. You can + simply copy this file into ~/.m2 and edit as necessary. + + If you wish to write the file yourself, the file should look like this in + general: + + + + ...profiles... + + + + We need to add a profile which defines the required properties by + placing a section like the following within the "profiles" section of your + settings.xml: + + + guacamole-mybatis + + DATABASE + USERNAME + PASSWORD + + + + Obviously, the DATABASE, USERNAME, and PASSWORD placeholders above must + be replaced with the appropriate values for your system. + + Finally, to make the profile available to the build, it must be activated. + Place a section like the following at the bottom of your settings.xml, + right after the profiles section: + + + guacamole-mybatis + + + Maven's documentation has more details on writing the settings.xml file + if you have different needs or the above directions are not clear. + +3) Run mvn package $ mvn package @@ -49,8 +119,12 @@ guacamole.properties such that the authentication provider is available. 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 + If this process fails, check the build errors, and verify that the + contents of your settings.xml file is correct. + +4) 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. @@ -58,7 +132,7 @@ guacamole.properties such that the authentication provider is available. 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 +5) 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. @@ -67,7 +141,7 @@ guacamole.properties such that the authentication provider is available. with username 'guacadmin' and password 'guacadmin'. This user can be used to set up any other connections and users. -4) Configure guacamole.properties for MySQL +6) Configure guacamole.properties for MySQL There are additional properties required by the MySQL JDBC driver which must be added/changed in your guacamole.properties: @@ -85,11 +159,6 @@ guacamole.properties such that the authentication provider is available. mysql-disallow-simultaneous-connections: true ------------------------------------------------------------- - Generating MyBatis ORM mappings ------------------------------------------------------------- - -See the README.mybatis file. ------------------------------------------------------------ Reporting problems