You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@guacamole.apache.org by mj...@apache.org on 2018/01/01 21:43:33 UTC
[01/11] guacamole-manual git commit: GUACAMOLE-363: Documentation for
SQL Server JDBC module.
Repository: guacamole-manual
Updated Branches:
refs/heads/master 843e1e5f3 -> e3b1362e6
GUACAMOLE-363: Documentation for SQL Server JDBC module.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/de0311d1
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/de0311d1
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/de0311d1
Branch: refs/heads/master
Commit: de0311d1f244c377ae5a5bb5d5c255e91c81026c
Parents: 4e18295
Author: Nick Couchman <vn...@apache.org>
Authored: Tue Oct 24 10:41:05 2017 -0400
Committer: Nick Couchman <vn...@apache.org>
Committed: Tue Oct 24 10:41:05 2017 -0400
----------------------------------------------------------------------
src/chapters/jdbc-auth.xml | 201 ++++++++++++++++++++++++++++++++++------
1 file changed, 171 insertions(+), 30 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/de0311d1/src/chapters/jdbc-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/jdbc-auth.xml b/src/chapters/jdbc-auth.xml
index 6718808..70d237e 100644
--- a/src/chapters/jdbc-auth.xml
+++ b/src/chapters/jdbc-auth.xml
@@ -12,12 +12,12 @@
<indexterm>
<primary>load balancing</primary>
</indexterm>
- <para>Guacamole supports authentication via MySQL or PostgreSQL databases through extensions
- available from the project website. Using a database for authentication provides additional
- features, such as the ability to use load balancing groups of connections and a web-based
- administrative interface. Unlike the default, XML-driven authentication module, all changes
- to users and connections take effect immediately; users need not logout and back in to see
- new connections.</para>
+ <para>Guacamole supports authentication via MySQL, PostgreSQL, or SQL Server databases through
+ extensions available from the project website. Using a database for authentication provides
+ additional features, such as the ability to use load balancing groups of connections and a
+ web-based administrative interface. Unlike the default, XML-driven authentication module, all
+ changes to users and connections take effect immediately; users need not logout and back in
+ to see new connections.</para>
<para>While most authentication extensions function independently, the database authentication
can act in a subordinate role, allowing users from other authentication extensions to be
associated with connections within the database. Users are considered identical to users
@@ -29,7 +29,7 @@
<para>To use the database authentication extension, you will need:</para>
<orderedlist>
<listitem>
- <para>A supported database - currently MariaDB, MySQL, or PostgreSQL.</para>
+ <para>A supported database - currently MariaDB, MySQL, PostgreSQL, or SQL Server.</para>
</listitem>
<listitem>
<para>Sufficient permission to create new databases, to create new users, and to grant
@@ -97,9 +97,29 @@
depends on the version of Java you have installed. </para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><filename>sqlserver/</filename></term>
+ <listitem>
+ <para>Contains the SQL Server authentication extension,
+ <filename>guacamole-auth-jdbc-sqlserver-0.9.13-incubating.jar</filename>,
+ along with a <filename>schema/</filename> directory contains SQL Server-specific
+ scripts requires to set up the database. The JAR extension file will need to be
+ placed within the <filename>GUACAMOLE_HOME/extensions</filename> folder, while the
+ SQL Server JDBC driver must be placed within the <filename>GUACAMOLE_HOME/lib</filename>
+ directory.</para>
+ <para><emphasis>The SQL Server JDBC driver is not included with the extension.</emphasis> You
+ must obtain the JDBC driver <filename>.jar</filename> yourselfand place it in the directory.
+ Furthermore, the SQL Server authentication extension supports a number of TDS-compatible
+ drivers, so you must make sure the one you choose is supported by the extension, that the
+ extension is configured properly, and that the <filename>.jar</filename> is in the correct
+ directory. Microsoft's JDBC driver can be downloaded from <link
+ xlink:href="https://docs.microsoft.com/en-us/sql/connect/sql-connection-libraries#anchor-20-drivers-relational-access">
+ this page</link>.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
<para>Only one of the directories within the archive will be applicable to you, depending on
- whether you are using MariaDB, MySQL, or PostgreSQL.</para>
+ whether you are using MariaDB, MySQL, PostgreSQL, or SQL Server.</para>
</section>
<section xml:id="jdbc-auth-database-creation">
<title>Creating the Guacamole database</title>
@@ -108,11 +128,13 @@
database and existing user, but for the sake of simplicity and security, these
instructions assume you will be creating a new database and new user that will be used
only by Guacamole and only for this authentication module.</para>
- <para>You need MariaDB, MySQL, or PostgreSQL installed, and must have sufficient access to
- create and administer databases. If this is not the case, install your database of
- choice now. Most distributions will provide a convenient MySQL or PostgreSQL package
+ <para>You need MariaDB, MySQL, PostgreSQL, or SQL Server installed, and must have sufficient
+ access to create and administer databases. If this is not the case, install your database
+ of choice now. Most distributions will provide a convenient MySQL or PostgreSQL package
which will set up everything for you, including the root database user, if
- applicable.</para>
+ applicable. If you're using SQL Server, you need to install the packages on your platform
+ of choice, and also make sure that you obtain the proper licensing for the version
+ and edition of SQL Server you are running.</para>
<para>For the sake of clarity, these instructions will refer to the database as
"guacamole_db" and the user as "guacamole_user", but the database and user can be named
whatever you like. Naturally, you should also choose a real password for your user
@@ -299,6 +321,59 @@ Type "help" for help.
to run any database upgrade scripts.</para>
</important>
</section>
+ <section xml:id="jdbc-auth-sqlserver">
+ <title>SQL Server</title>
+ <para>If using SQL Server, the database and schema must be created first. The example below assumes
+ that you are running SQL Server on Linux, using the command-line tools to manage it.</para>
+ <informalexample>
+ <screen><prompt>$</prompt> <userinput>/opt/mssql-tools/bin/sqlcmd -S localhost -U SA</userinput>
+<prompt>Password:</prompt> <userinput><replaceable>password</replaceable></userinput>
+<prompt>1></prompt> <userinput>CREATE DATABASE <replaceable>guacamole_db</replaceable>;</userinput>
+<prompt>2></prompt> <userinput>GO</userinput>
+<prompt>1></prompt> <userinput>CREATE LOGIN <replaceable>guacamole_user</replaceable> WITH PASSWORD = '<replaceable>S0me_Password</replaceable>';</userinput>
+<prompt>2></prompt> <userinput>GO</userinput>
+<prompt>1></prompt> <userinput>USE <replaceable>guacamole_db</replaceable>;</userinput>
+<prompt>2></prompt> <userinput>GO</userinput>
+<prompt>1></prompt> <userinput>CREATE USER <replaceable>guacamole_user</replaceable>;</userinput>
+<prompt>2></prompt> <userinput>GO</userinput>
+<prompt>1></prompt> <userinput>ALTER ROLE db_owner ADD MEMBER <replaceable>guacamole_user</replaceable>;</userinput>
+<prompt>2></prompt> <userinput>GO</userinput></screen>
+ </informalexample>
+ <para>Once the database and user account is created, and the user associated with the database, you can use
+ the supplied scripts to load the schema into the database. These scripts are included in the
+ <filename>sqlserver/schema/</filename> directory of the archive you downloaded from the Guacamole
+ web site.</para>
+ <informalexample>
+ <screen><prompt>$</prompt> <userinput>/opt/mssql-tools/bin/sqlcmd -S localhost -U <replaceable>guacamole_user</replaceable> -d <replaceable>guacamole_db</replaceable> -i schema/001-create-schema.sql</userinput>
+<prompt>Password:</prompt> <userinput><replaceable>S0me_Password</replaceable></userinput>
+<computeroutput>Rule bound to data type.
+The new rule has been bound to column(s) of the specified user data type.
+Rule bound to data type.
+The new rule has been bound to column(s) of the specified user data type.</computeroutput>
+<prompt>$</prompt> <userinput>/opt/mssql-tools/bin/sqlcmd -S localhost -U <replaceable>guacamole_user</replaceable> -d <replaceable>guacamole_db</replaceable> -i schema/002-create-admin-user.sql</userinput>
+<prompt>Password:</prompt> <userinput><replaceable>S0me_Password</replaceable></userinput>
+<computeroutput>
+(1 rows affected)
+
+(3 rows affected)
+
+(5 rows affected)</computeroutput></screen>
+ </informalexample>
+ <para>If the operation is successful, the tables and permissions have been created successfully, and you
+ can now use the database with the Guacamole client web application.</para>
+ <important xml:id="jdbc-auth-sqlserver-upgrade">
+ <para>If you are upgrading from an older version of Guacamole and were already using
+ SQL Server, you may need to run one or more database schema upgrade scripts
+ located within the <filename>schema/upgrade/</filename> directory. Each of these
+ scripts is named
+ <filename>upgrade-pre-<replaceable>VERSION</replaceable>.sql</filename>
+ where <replaceable>VERSION</replaceable> is the version of Guacamole where those
+ changes were introduced. They need to be run when you are upgrading from a
+ version of Guacamole older than <replaceable>VERSION</replaceable>.</para>
+ <para>SQL Server support was added in version <replaceable>VERSION</replaceable>, so, at the time of this
+ version of the manual, there are no upgrade scripts available.</para>
+ </important>
+ </section>
</section>
<section xml:id="jdbc-auth-installation">
<title>Installing database authentication</title>
@@ -313,9 +388,11 @@ Type "help" for help.
<step>
<para>Copy <filename>guacamole-auth-jdbc-mysql-0.9.13-incubating.jar</filename>
<emphasis>or</emphasis>
- <filename>guacamole-auth-jdbc-postgresql-0.9.13-incubating.jar</filename> within
+ <filename>guacamole-auth-jdbc-postgresql-0.9.13-incubating.jar</filename>
+ <emphasis>or</emphasis>
+ <filename>guacamole-auth-jdbc-sqlserver-0.9.13-incubating.jar</filename> within
<filename>GUACAMOLE_HOME/extensions</filename>, depending on whether you are
- using MySQL/MariaDB or PostgreSQL.</para>
+ using MySQL/MariaDB, PostgreSQL, or SQL Server.</para>
</step>
<step>
<para>Copy the JDBC driver for your database to
@@ -346,31 +423,45 @@ mysql-hostname: localhost
mysql-port: 3306
mysql-database: <replaceable>guacamole_db</replaceable>
mysql-username: <replaceable>guacamole_user</replaceable>
-mysql-password: <replaceable>some_password</replaceable></programlisting>
- <para>For PostgreSQL, the properties are similar, but with different
- prefixes:</para>
- <informalexample>
- <programlisting># PostgreSQL properties
+mysql-password: <replaceable>some_password</replaceable>
+ </programlisting>
+ </informalexample>
+ <para>For PostgreSQL, the properties are similar, but with different prefixes:</para>
+ <informalexample>
+ <programlisting># PostgreSQL properties
postgresql-hostname: localhost
postgresql-port: 5432
postgresql-database: <replaceable>guacamole_db</replaceable>
postgresql-username: <replaceable>guacamole_user</replaceable>
-postgresql-password: <replaceable>some_password</replaceable></programlisting>
- </informalexample>
+postgresql-password: <replaceable>some_password</replaceable>
+ </programlisting>
+ </informalexample>
+ <para>The SQL Server properties follow the same format:</para>
+ <informalexample>
+ <programlisting># SQL Server properties
+sqlserver-hostname: localhost
+sqlserver-port: 1433
+sqlserver-database: <replaceable>guacamole_db</replaceable>
+sqlserver-username: <replaceable>guacamole_user</replaceable>
+sqlserver-password: <replaceable>S0me_Password</replaceable>
+sqlserver-driver: microsoft2005
+ </programlisting>
</informalexample>
<para>The properties absolutely required by the database authentication extension are
relatively few and self-explanatory, describing only how the connection to the
database is to be established, and how Guacamole will authenticate when querying the
database:</para>
<informaltable frame="all">
- <tgroup cols="3">
+ <tgroup cols="4">
<colspec colname="c1" colnum="1" colwidth="1*"/>
<colspec colname="c2" colnum="2" colwidth="1*"/>
- <colspec colname="c3" colnum="3" colwidth="2*"/>
+ <colspec colname="c3" column="3" colwidth="1*"/>
+ <colspec colname="c4" colnum="4" colwidth="2*"/>
<thead>
<row>
<entry>MySQL/MariaDB Property</entry>
<entry>PostgreSQL Property</entry>
+ <entry>SQL Server Property</entry>
<entry>Description</entry>
</row>
</thead>
@@ -378,6 +469,7 @@ postgresql-password: <replaceable>some_password</replaceable></programlisting>
<row>
<entry><property>mysql-hostname</property></entry>
<entry><property>postgresql-hostname</property></entry>
+ <entry><property>sqlserver-hostname</property></entry>
<entry>
<para>The hostname or IP address of the server hosting your
database.</para>
@@ -386,6 +478,7 @@ postgresql-password: <replaceable>some_password</replaceable></programlisting>
<row>
<entry><property>mysql-port</property></entry>
<entry><property>postgresql-port</property></entry>
+ <entry><property>sqlserver-port</property></entry>
<entry>
<para>The port number of the database to connect to. For MySQL and
MariaDB, this will likely be 3306. For PostgreSQL, this will
@@ -395,6 +488,7 @@ postgresql-password: <replaceable>some_password</replaceable></programlisting>
<row>
<entry><property>mysql-database</property></entry>
<entry><property>postgresql-database</property></entry>
+ <entry><property>sqlserver-database</property></entry>
<entry>
<para>The name of the database that you created for Guacamole. This
is given as "guacamole_db" in the examples given in this
@@ -404,6 +498,7 @@ postgresql-password: <replaceable>some_password</replaceable></programlisting>
<row>
<entry><property>mysql-username</property></entry>
<entry><property>postgresql-username</property></entry>
+ <entry><property>sqlserver-username</property></entry>
<entry>
<para>The username of the user that Guacamole should use to connect
to the database. This is given as "guacamole_user" in the
@@ -413,12 +508,29 @@ postgresql-password: <replaceable>some_password</replaceable></programlisting>
<row>
<entry><property>mysql-password</property></entry>
<entry><property>postgresql-password</property></entry>
+ <entry><property>sqlserver-password</property></entry>
<entry>
<para>The password Guacamole should provide when authenticating with
the database. This is given as "some_password" in the examples
given in this chapter.</para>
</entry>
</row>
+ <row>
+ <entry></entry>
+ <entry></entry>
+ <entry><property>sqlserver-driver</property></entry>
+ <entry>
+ <para>The SQL Server driver has an additional required parameter to
+ configure the TDS compatibility of the driver. This driver supports
+ four different options for this command:
+ - <property>microsoft2005</property> for the current Microsoft driver,
+ supporting SQL Server 2005 and later.
+ - <property>microsoft</property> for legacy SQL Server support.
+ - <property>jtds</property> for the open source JTDS driver.
+ - <property>datadirect</property> for the Progress Sybase driver.
+ </para>
+ </entry>
+ </row>
</tbody>
</tgroup>
</informaltable>
@@ -461,7 +573,14 @@ postgresql-user-password-min-length: <replaceable>8</replaceable>
postgresql-user-password-require-multiple-case: true
postgresql-user-password-require-symbol: true
postgresql-user-password-require-digit: true
-postgresql-user-password-prohibit-username: true</programlisting>
+postgresql-user-password-prohibit-username: true
+
+# SQL Server
+sqlserver-user-password-min-length: <replaceable>8</replaceable>
+sqlserver-user-password-require-multiple-case: true
+sqlserver-user-password-require-symbol: true
+sqlserver-user-password-require-digit: true
+sqlserver-user-password-prohibit-username: true</programlisting>
</informalexample>
</section>
<section>
@@ -496,7 +615,11 @@ mysql-user-password-max-age: <replaceable>90</replaceable>
# PostgreSQL
postgresql-user-password-min-age: <replaceable>7</replaceable>
-postgresql-user-password-max-age: <replaceable>90</replaceable></programlisting>
+postgresql-user-password-max-age: <replaceable>90</replaceable>
+
+# SQL Server
+sqlserver-user-password-min-age: <replaceable>7</replaceable>
+sqlserver-user-password-max-age: <replaceable>90</replaceable></programlisting>
</informalexample>
</section>
<section>
@@ -515,7 +638,10 @@ postgresql-user-password-max-age: <replaceable>90</replaceable></programlisting>
mysql-user-password-history-size: <replaceable>6</replaceable>
# PostgreSQL
-postgresql-user-password-history-size: <replaceable>6</replaceable></programlisting>
+postgresql-user-password-history-size: <replaceable>6</replaceable>
+
+# SQL Server
+sqlserver-user-password-history-size: <replaceable>6</replaceable></programlisting>
</informalexample>
</section>
</section>
@@ -534,7 +660,11 @@ mysql-default-max-group-connections: 1
# PostgreSQL
postgresql-default-max-connections: 1
-postgresql-default-max-group-connections: 1</programlisting>
+postgresql-default-max-group-connections: 1
+
+# SQL Server
+sqlserver-default-max-connections: 1
+sqlserver-default-max-group-connections: 1</programlisting>
</informalexample>
<para>These properties are not required, but with the above properties in place,
users attempting to use a connection or group that is already in use will be
@@ -552,7 +682,11 @@ mysql-default-max-group-connections-per-user: 0
# PostgreSQL
postgresql-default-max-connections-per-user: 0
-postgresql-default-max-group-connections-per-user: 0</programlisting>
+postgresql-default-max-group-connections-per-user: 0
+
+# SQL Server
+sqlserver-default-max-connections-per-user: 0
+sqlserver-default-max-group-connections-per-user: 0</programlisting>
</informalexample>
<para>The above properties replace the "simultaneous" and "duplicate" properties used
by prior Guacamole releases. The older properties will still work, but are now
@@ -569,6 +703,7 @@ result of setting "postgresql-disallow-simultaneous-connections" to
"false", set "postgresql-default-max-connections" to "0" and
"postgresql-default-max-group-connections" to "0".</computeroutput></screen>
</informalexample>
+ <para>These deprecated properties are not supported in the SQL Server module.</para>
<para>If you wish to impose an absolute limit on the number of connections that can
be established through Guacamole, ignoring which users or connections are
involved, this can be done as well. By default, Guacamole will impose no such
@@ -578,7 +713,10 @@ result of setting "postgresql-disallow-simultaneous-connections" to
mysql-absolute-max-connections: 0
# PostgreSQL
-postgresql-absolute-max-connections: 0</programlisting>
+postgresql-absolute-max-connections: 0
+
+# SQL Server
+sqlserver-absolute-max-connections: 0</programlisting>
</informalexample>
</section>
</section>
@@ -601,7 +739,10 @@ postgresql-absolute-max-connections: 0</programlisting>
mysql-user-required: true
# PostgreSQL
-postgresql-user-required: true</programlisting>
+postgresql-user-required: true
+
+# SQL Server
+sqlserver-user-required: true</programlisting>
</informalexample>
<para>With the above properties set, successful authentication attempts for users which
are not associated with the database will be vetoed by the database authentication.
[05/11] guacamole-manual git commit: GUACAMOLE-363: Fix list of
sqlserver-driver options.
Posted by mj...@apache.org.
GUACAMOLE-363: Fix list of sqlserver-driver options.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/afdd4f7d
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/afdd4f7d
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/afdd4f7d
Branch: refs/heads/master
Commit: afdd4f7d8de9d22aa3ab925ca56598e1fca07b56
Parents: 31f8d44
Author: Nick Couchman <vn...@apache.org>
Authored: Sun Dec 31 11:32:57 2017 -0500
Committer: Nick Couchman <vn...@apache.org>
Committed: Sun Dec 31 11:32:57 2017 -0500
----------------------------------------------------------------------
src/chapters/jdbc-auth.xml | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/afdd4f7d/src/chapters/jdbc-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/jdbc-auth.xml b/src/chapters/jdbc-auth.xml
index d2818e5..d699f2f 100644
--- a/src/chapters/jdbc-auth.xml
+++ b/src/chapters/jdbc-auth.xml
@@ -121,21 +121,21 @@
mode of the module with various TDS-comptabile drivers such that it can be used with different
versions of SQL Server and even non-Microsoft SQL Server databases. The following options are available
for the <property>sqlserver-driver</property> property:
- <variablelist>
- <varlistentry>
+ <itemizedlist>
+ <listitem>
<constant>microsoft2005</constant>: The current Microsoft driver,
supporting SQL Server 2005 and later.
- </varlistentry>
- <varlistentry>
+ </listitem>
+ <listitem>
<constant>microsoft</constant>: The legacy SQL Server support.
- </varlistentry>
- <varlistentry>
+ </listitem>
+ <listitem>
<constant>jtds</constant>: The open source JTDS driver.
- </varlistentry>
- <varlistentry>
+ </listitem>
+ <listitem>
<constant>datadirect</constant>: The Progress Sybase driver.
- </varlistentry>
- </variablelist>
+ </listitem>
+ </itemizedlist>
</para>
</listitem>
</varlistentry>
[04/11] guacamole-manual git commit: GUACAMOLE-363: Move
sqlserver-driver documentation to different section.
Posted by mj...@apache.org.
GUACAMOLE-363: Move sqlserver-driver documentation to different section.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/31f8d443
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/31f8d443
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/31f8d443
Branch: refs/heads/master
Commit: 31f8d4430571ea6490d46329431c80bf3382bfdc
Parents: fbbc2bb
Author: Nick Couchman <vn...@apache.org>
Authored: Mon Dec 11 14:22:50 2017 -0500
Committer: Nick Couchman <vn...@apache.org>
Committed: Mon Dec 11 14:22:50 2017 -0500
----------------------------------------------------------------------
src/chapters/jdbc-auth.xml | 48 +++++++++++++++++++----------------------
1 file changed, 22 insertions(+), 26 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/31f8d443/src/chapters/jdbc-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/jdbc-auth.xml b/src/chapters/jdbc-auth.xml
index f634b73..d2818e5 100644
--- a/src/chapters/jdbc-auth.xml
+++ b/src/chapters/jdbc-auth.xml
@@ -115,6 +115,28 @@
directory. Microsoft's JDBC driver can be downloaded from Microsoft's <link
xlink:href="https://docs.microsoft.com/en-us/sql/connect/sql-connection-libraries#anchor-20-drivers-relational-access">
SQL Connection Libraries</link> page.</para>
+ <para>In addition to the various parameters mentioned below, the SQL Server driver has a
+ unique parameter available to control the driver compatibility of the JDBC module:
+ <property>sqlserver-driver</property>. This parameter allows you to choose the compatibility
+ mode of the module with various TDS-comptabile drivers such that it can be used with different
+ versions of SQL Server and even non-Microsoft SQL Server databases. The following options are available
+ for the <property>sqlserver-driver</property> property:
+ <variablelist>
+ <varlistentry>
+ <constant>microsoft2005</constant>: The current Microsoft driver,
+ supporting SQL Server 2005 and later.
+ </varlistentry>
+ <varlistentry>
+ <constant>microsoft</constant>: The legacy SQL Server support.
+ </varlistentry>
+ <varlistentry>
+ <constant>jtds</constant>: The open source JTDS driver.
+ </varlistentry>
+ <varlistentry>
+ <constant>datadirect</constant>: The Progress Sybase driver.
+ </varlistentry>
+ </variablelist>
+ </para>
</listitem>
</varlistentry>
</variablelist>
@@ -517,32 +539,6 @@ sqlserver-driver: microsoft2005
given in this chapter.</para>
</entry>
</row>
- <row>
- <entry></entry>
- <entry></entry>
- <entry><property>sqlserver-driver</property></entry>
- <entry>
- <para>The SQL Server driver has an additional required parameter to
- configure the TDS compatibility of the driver. This driver supports
- four different options for this command:
- <variablelist>
- <varlistentry>
- <constant>microsoft2005</constant> for the current Microsoft driver,
- supporting SQL Server 2005 and later.
- </varlistentry>
- <varlistentry>
- <constant>microsoft</constant> for legacy SQL Server support.
- </varlistentry>
- <varlistentry>
- <constant>jtds</constant> for the open source JTDS driver.
- </varlistentry>
- <varlistentry>
- <constant>datadirect</constant> for the Progress Sybase driver.
- </varlistentry>
- </variablelist>
- </para>
- </entry>
- </row>
</tbody>
</tgroup>
</informaltable>
[08/11] guacamole-manual git commit: GUACAMOLE-363: Fix typo from
column to colnum.
Posted by mj...@apache.org.
GUACAMOLE-363: Fix typo from column to colnum.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/08ec9ddc
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/08ec9ddc
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/08ec9ddc
Branch: refs/heads/master
Commit: 08ec9ddc919d473f26e4564965d016d3489457ff
Parents: c3f2ac0
Author: Nick Couchman <vn...@apache.org>
Authored: Mon Jan 1 16:11:33 2018 -0500
Committer: Nick Couchman <vn...@apache.org>
Committed: Mon Jan 1 16:11:33 2018 -0500
----------------------------------------------------------------------
src/chapters/jdbc-auth.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/08ec9ddc/src/chapters/jdbc-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/jdbc-auth.xml b/src/chapters/jdbc-auth.xml
index 5ab4a8e..cff15a2 100644
--- a/src/chapters/jdbc-auth.xml
+++ b/src/chapters/jdbc-auth.xml
@@ -470,7 +470,7 @@ sqlserver-driver: microsoft2005
<tgroup cols="4">
<colspec colname="c1" colnum="1" colwidth="1*"/>
<colspec colname="c2" colnum="2" colwidth="1*"/>
- <colspec colname="c3" column="3" colwidth="1*"/>
+ <colspec colname="c3" colnum="3" colwidth="1*"/>
<colspec colname="c4" colnum="4" colwidth="2*"/>
<thead>
<row>
[09/11] guacamole-manual git commit: GUACAMOLE-363: Add para tags to
text for lisitem entries.
Posted by mj...@apache.org.
GUACAMOLE-363: Add para tags to text for lisitem entries.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/78ac7359
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/78ac7359
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/78ac7359
Branch: refs/heads/master
Commit: 78ac73593fd00de26ed693ff5605e87c4b2a97de
Parents: 08ec9dd
Author: Nick Couchman <vn...@apache.org>
Authored: Mon Jan 1 16:36:36 2018 -0500
Committer: Nick Couchman <vn...@apache.org>
Committed: Mon Jan 1 16:36:36 2018 -0500
----------------------------------------------------------------------
src/chapters/jdbc-auth.xml | 16 ++++++++++++----
1 file changed, 12 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/78ac7359/src/chapters/jdbc-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/jdbc-auth.xml b/src/chapters/jdbc-auth.xml
index cff15a2..d840800 100644
--- a/src/chapters/jdbc-auth.xml
+++ b/src/chapters/jdbc-auth.xml
@@ -124,19 +124,27 @@
<variablelist>
<varlistentry>
<term>microsoft2005</term>
- <listitem>The current Microsoft driver, supporting SQL Server 2005 and later.</listitem>
+ <listitem>
+ <para>The current Microsoft driver, supporting SQL Server 2005 and later.</para>
+ </listitem>
</varlistentry>
<varlistentry>
<term>microsoft</term>
- <listitem>The legacy SQL Server support.</listitem>
+ <listitem>
+ <para>The legacy SQL Server support.</para>
+ </listitem>
</varlistentry>
<varlistentry>
<term>jtds</term>
- <listitem>The open source JTDS driver.</listitem>
+ <listitem>
+ <para>The open source JTDS driver.</para>
+ </listitem>
</varlistentry>
<varlistentry>
<term>datadirect</term>
- <listitem>The Progress Sybase driver.</listitem>
+ <listitem>
+ <para>The Progress Sybase driver.</para>
+ </listitem>
</varlistentry>
</variablelist>
</para>
[06/11] guacamole-manual git commit: GUACAMOLE-363: Remove
unnecessary upgrade block.
Posted by mj...@apache.org.
GUACAMOLE-363: Remove unnecessary upgrade block.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/2301b398
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/2301b398
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/2301b398
Branch: refs/heads/master
Commit: 2301b398bd1f223549ece67b4b59f7fc6cafe23b
Parents: afdd4f7
Author: Nick Couchman <vn...@apache.org>
Authored: Sun Dec 31 11:33:37 2017 -0500
Committer: Nick Couchman <vn...@apache.org>
Committed: Sun Dec 31 11:33:37 2017 -0500
----------------------------------------------------------------------
src/chapters/jdbc-auth.xml | 12 ------------
1 file changed, 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/2301b398/src/chapters/jdbc-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/jdbc-auth.xml b/src/chapters/jdbc-auth.xml
index d699f2f..e57ce02 100644
--- a/src/chapters/jdbc-auth.xml
+++ b/src/chapters/jdbc-auth.xml
@@ -385,18 +385,6 @@ The new rule has been bound to column(s) of the specified user data type.</compu
</informalexample>
<para>If the operation is successful, the tables and permissions have been created successfully, and you
can now use the database with the Guacamole client web application.</para>
- <important xml:id="jdbc-auth-sqlserver-upgrade">
- <para>If you are upgrading from an older version of Guacamole and were already using
- SQL Server, you may need to run one or more database schema upgrade scripts
- located within the <filename>schema/upgrade/</filename> directory. Each of these
- scripts is named
- <filename>upgrade-pre-<replaceable>VERSION</replaceable>.sql</filename>
- where <replaceable>VERSION</replaceable> is the version of Guacamole where those
- changes were introduced. They need to be run when you are upgrading from a
- version of Guacamole older than <replaceable>VERSION</replaceable>.</para>
- <para>SQL Server support was added in version <replaceable>VERSION</replaceable>, so, at the time of this
- version of the manual, there are no upgrade scripts available.</para>
- </important>
</section>
</section>
<section xml:id="jdbc-auth-installation">
[07/11] guacamole-manual git commit: GUACAMOLE-363: Switch back to
variablelist for sqlserver-driver.
Posted by mj...@apache.org.
GUACAMOLE-363: Switch back to variablelist for sqlserver-driver.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/c3f2ac01
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/c3f2ac01
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/c3f2ac01
Branch: refs/heads/master
Commit: c3f2ac017663a9a91296dbb2ae3ba507c885de8e
Parents: 2301b39
Author: Nick Couchman <vn...@apache.org>
Authored: Mon Jan 1 16:09:15 2018 -0500
Committer: Nick Couchman <vn...@apache.org>
Committed: Mon Jan 1 16:09:15 2018 -0500
----------------------------------------------------------------------
src/chapters/jdbc-auth.xml | 33 ++++++++++++++++++---------------
1 file changed, 18 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/c3f2ac01/src/chapters/jdbc-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/jdbc-auth.xml b/src/chapters/jdbc-auth.xml
index e57ce02..5ab4a8e 100644
--- a/src/chapters/jdbc-auth.xml
+++ b/src/chapters/jdbc-auth.xml
@@ -121,21 +121,24 @@
mode of the module with various TDS-comptabile drivers such that it can be used with different
versions of SQL Server and even non-Microsoft SQL Server databases. The following options are available
for the <property>sqlserver-driver</property> property:
- <itemizedlist>
- <listitem>
- <constant>microsoft2005</constant>: The current Microsoft driver,
- supporting SQL Server 2005 and later.
- </listitem>
- <listitem>
- <constant>microsoft</constant>: The legacy SQL Server support.
- </listitem>
- <listitem>
- <constant>jtds</constant>: The open source JTDS driver.
- </listitem>
- <listitem>
- <constant>datadirect</constant>: The Progress Sybase driver.
- </listitem>
- </itemizedlist>
+ <variablelist>
+ <varlistentry>
+ <term>microsoft2005</term>
+ <listitem>The current Microsoft driver, supporting SQL Server 2005 and later.</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>microsoft</term>
+ <listitem>The legacy SQL Server support.</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>jtds</term>
+ <listitem>The open source JTDS driver.</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>datadirect</term>
+ <listitem>The Progress Sybase driver.</listitem>
+ </varlistentry>
+ </variablelist>
</para>
</listitem>
</varlistentry>
[11/11] guacamole-manual git commit: Merge 0.9.14 changes back to
master.
Posted by mj...@apache.org.
Merge 0.9.14 changes back to master.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/e3b1362e
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/e3b1362e
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/e3b1362e
Branch: refs/heads/master
Commit: e3b1362e6c06cbb34931abbb2b99f3eb60868a78
Parents: 843e1e5 0be491d
Author: Michael Jumper <mj...@apache.org>
Authored: Mon Jan 1 13:43:13 2018 -0800
Committer: Michael Jumper <mj...@apache.org>
Committed: Mon Jan 1 13:43:13 2018 -0800
----------------------------------------------------------------------
src/chapters/jdbc-auth.xml | 208 ++++++++++++++++++++++++++++++++++------
1 file changed, 178 insertions(+), 30 deletions(-)
----------------------------------------------------------------------
[03/11] guacamole-manual git commit: GUACAMOLE-363: Corrections and
style fixes for SQL Server documentation.
Posted by mj...@apache.org.
GUACAMOLE-363: Corrections and style fixes for SQL Server documentation.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/fbbc2bb2
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/fbbc2bb2
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/fbbc2bb2
Branch: refs/heads/master
Commit: fbbc2bb2e4b94bf6760f745b4f64a4a5730f7213
Parents: b9791eb
Author: Nick Couchman <vn...@apache.org>
Authored: Mon Dec 11 09:44:08 2017 -0500
Committer: Nick Couchman <vn...@apache.org>
Committed: Mon Dec 11 09:44:08 2017 -0500
----------------------------------------------------------------------
src/chapters/jdbc-auth.xml | 41 ++++++++++++++++++++++++++---------------
1 file changed, 26 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/fbbc2bb2/src/chapters/jdbc-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/jdbc-auth.xml b/src/chapters/jdbc-auth.xml
index 84f9359..f634b73 100644
--- a/src/chapters/jdbc-auth.xml
+++ b/src/chapters/jdbc-auth.xml
@@ -108,13 +108,13 @@
SQL Server JDBC driver must be placed within the <filename>GUACAMOLE_HOME/lib</filename>
directory.</para>
<para><emphasis>The SQL Server JDBC driver is not included with the extension.</emphasis> You
- must obtain the JDBC driver <filename>.jar</filename> yourselfand place it in the directory.
+ must obtain the JDBC driver <filename>.jar</filename> yourself and place it in the directory.
Furthermore, the SQL Server authentication extension supports a number of TDS-compatible
drivers, so you must make sure the one you choose is supported by the extension, that the
extension is configured properly, and that the <filename>.jar</filename> is in the correct
- directory. Microsoft's JDBC driver can be downloaded from <link
+ directory. Microsoft's JDBC driver can be downloaded from Microsoft's <link
xlink:href="https://docs.microsoft.com/en-us/sql/connect/sql-connection-libraries#anchor-20-drivers-relational-access">
- this page</link>.</para>
+ SQL Connection Libraries</link> page.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -324,21 +324,22 @@ Type "help" for help.
<section xml:id="jdbc-auth-sqlserver">
<title>SQL Server</title>
<para>If using SQL Server, the database and schema must be created first. The example below assumes
- that you are running SQL Server on Linux, using the command-line tools to manage it.</para>
+ that you are running SQL Server on Linux, using the command-line tools to manage it, however, this
+ code can be run using any tool capable of running SQL against a SQL Server database.</para>
<informalexample>
<screen><prompt>$</prompt> <userinput>/opt/mssql-tools/bin/sqlcmd -S localhost -U SA</userinput>
<prompt>Password:</prompt> <userinput><replaceable>password</replaceable></userinput>
<prompt>1></prompt> <userinput>CREATE DATABASE <replaceable>guacamole_db</replaceable>;</userinput>
<prompt>2></prompt> <userinput>GO</userinput>
-<prompt>1></prompt> <userinput>CREATE LOGIN <replaceable>guacamole_user</replaceable> WITH PASSWORD = '<replaceable>S0me_Password</replaceable>';</userinput>
+<prompt>1></prompt> <userinput>CREATE LOGIN <replaceable>guacamole_user</replaceable> WITH PASSWORD = '<replaceable>some_password</replaceable>';</userinput>
<prompt>2></prompt> <userinput>GO</userinput>
<prompt>1></prompt> <userinput>USE <replaceable>guacamole_db</replaceable>;</userinput>
<prompt>2></prompt> <userinput>GO</userinput>
<prompt>1></prompt> <userinput>CREATE USER <replaceable>guacamole_user</replaceable>;</userinput>
<prompt>2></prompt> <userinput>GO</userinput>
<prompt>1></prompt> <userinput>ALTER ROLE db_datawriter ADD MEMBER <replaceable>guacamole_user</replaceable>;</userinput>
-<prompt>1></prompt> <userinput>ALTER ROLE db_datareader ADD MEMBER <replaceable>guacamole_user</replaceable>;</userinput>
-<prompt>2></prompt> <userinput>GO</userinput></screen>
+<prompt>2></prompt> <userinput>ALTER ROLE db_datareader ADD MEMBER <replaceable>guacamole_user</replaceable>;</userinput>
+<prompt>3></prompt> <userinput>GO</userinput></screen>
</informalexample>
<para>Once the database and user account is created, and the user associated with the database, you can use
the supplied scripts to load the schema into the database. These scripts are included in the
@@ -346,13 +347,13 @@ Type "help" for help.
web site.</para>
<informalexample>
<screen><prompt>$</prompt> <userinput>/opt/mssql-tools/bin/sqlcmd -S localhost -U <replaceable>guacamole_user</replaceable> -d <replaceable>guacamole_db</replaceable> -i schema/001-create-schema.sql</userinput>
-<prompt>Password:</prompt> <userinput><replaceable>S0me_Password</replaceable></userinput>
+<prompt>Password:</prompt> <userinput><replaceable>some_password</replaceable></userinput>
<computeroutput>Rule bound to data type.
The new rule has been bound to column(s) of the specified user data type.
Rule bound to data type.
The new rule has been bound to column(s) of the specified user data type.</computeroutput>
<prompt>$</prompt> <userinput>/opt/mssql-tools/bin/sqlcmd -S localhost -U <replaceable>guacamole_user</replaceable> -d <replaceable>guacamole_db</replaceable> -i schema/002-create-admin-user.sql</userinput>
-<prompt>Password:</prompt> <userinput><replaceable>S0me_Password</replaceable></userinput>
+<prompt>Password:</prompt> <userinput><replaceable>some_password</replaceable></userinput>
<computeroutput>
(1 rows affected)
@@ -444,7 +445,7 @@ sqlserver-hostname: localhost
sqlserver-port: 1433
sqlserver-database: <replaceable>guacamole_db</replaceable>
sqlserver-username: <replaceable>guacamole_user</replaceable>
-sqlserver-password: <replaceable>S0me_Password</replaceable>
+sqlserver-password: <replaceable>some_password</replaceable>
sqlserver-driver: microsoft2005
</programlisting>
</informalexample>
@@ -524,11 +525,21 @@ sqlserver-driver: microsoft2005
<para>The SQL Server driver has an additional required parameter to
configure the TDS compatibility of the driver. This driver supports
four different options for this command:
- - <property>microsoft2005</property> for the current Microsoft driver,
- supporting SQL Server 2005 and later.
- - <property>microsoft</property> for legacy SQL Server support.
- - <property>jtds</property> for the open source JTDS driver.
- - <property>datadirect</property> for the Progress Sybase driver.
+ <variablelist>
+ <varlistentry>
+ <constant>microsoft2005</constant> for the current Microsoft driver,
+ supporting SQL Server 2005 and later.
+ </varlistentry>
+ <varlistentry>
+ <constant>microsoft</constant> for legacy SQL Server support.
+ </varlistentry>
+ <varlistentry>
+ <constant>jtds</constant> for the open source JTDS driver.
+ </varlistentry>
+ <varlistentry>
+ <constant>datadirect</constant> for the Progress Sybase driver.
+ </varlistentry>
+ </variablelist>
</para>
</entry>
</row>
[02/11] guacamole-manual git commit: GUACAMOLE-363: Limit scope of
role for guacamole database user.
Posted by mj...@apache.org.
GUACAMOLE-363: Limit scope of role for guacamole database user.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/b9791ebd
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/b9791ebd
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/b9791ebd
Branch: refs/heads/master
Commit: b9791ebd803a5e9b4076a3510166eab404d7bc25
Parents: de0311d
Author: Nick Couchman <vn...@apache.org>
Authored: Thu Nov 30 08:38:44 2017 -0500
Committer: Nick Couchman <vn...@apache.org>
Committed: Thu Nov 30 08:38:44 2017 -0500
----------------------------------------------------------------------
src/chapters/jdbc-auth.xml | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/b9791ebd/src/chapters/jdbc-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/jdbc-auth.xml b/src/chapters/jdbc-auth.xml
index 70d237e..84f9359 100644
--- a/src/chapters/jdbc-auth.xml
+++ b/src/chapters/jdbc-auth.xml
@@ -336,7 +336,8 @@ Type "help" for help.
<prompt>2></prompt> <userinput>GO</userinput>
<prompt>1></prompt> <userinput>CREATE USER <replaceable>guacamole_user</replaceable>;</userinput>
<prompt>2></prompt> <userinput>GO</userinput>
-<prompt>1></prompt> <userinput>ALTER ROLE db_owner ADD MEMBER <replaceable>guacamole_user</replaceable>;</userinput>
+<prompt>1></prompt> <userinput>ALTER ROLE db_datawriter ADD MEMBER <replaceable>guacamole_user</replaceable>;</userinput>
+<prompt>1></prompt> <userinput>ALTER ROLE db_datareader ADD MEMBER <replaceable>guacamole_user</replaceable>;</userinput>
<prompt>2></prompt> <userinput>GO</userinput></screen>
</informalexample>
<para>Once the database and user account is created, and the user associated with the database, you can use
[10/11] guacamole-manual git commit: GUACAMOLE-363: Merge
documentation for SQL Server support.
Posted by mj...@apache.org.
GUACAMOLE-363: Merge documentation for SQL Server support.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/0be491d2
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/0be491d2
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/0be491d2
Branch: refs/heads/master
Commit: 0be491d2e6331bd5b704e5d0bae27d260575cee4
Parents: 3a177d7 78ac735
Author: Michael Jumper <mj...@apache.org>
Authored: Mon Jan 1 13:39:50 2018 -0800
Committer: Michael Jumper <mj...@apache.org>
Committed: Mon Jan 1 13:39:50 2018 -0800
----------------------------------------------------------------------
src/chapters/jdbc-auth.xml | 208 ++++++++++++++++++++++++++++++++++------
1 file changed, 178 insertions(+), 30 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/0be491d2/src/chapters/jdbc-auth.xml
----------------------------------------------------------------------