You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@guacamole.apache.org by vn...@apache.org on 2018/09/28 19:52:12 UTC
[01/19] guacamole-manual git commit: GUACAMOLE-582: Correct link to
Apache JIRA tracker.
Repository: guacamole-manual
Updated Branches:
refs/heads/staging/1.0.0 563a0e6fa -> c0c699016
GUACAMOLE-582: Correct link to Apache JIRA tracker.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/51c9dc6f
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/51c9dc6f
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/51c9dc6f
Branch: refs/heads/staging/1.0.0
Commit: 51c9dc6f58e68eead7cecf656e92fe9689ddcd5b
Parents: fbd81b0
Author: Nick Couchman <ni...@cotyinc.com>
Authored: Tue Jun 26 16:10:07 2018 -0400
Committer: Nick Couchman <ni...@cotyinc.com>
Committed: Tue Jun 26 16:12:28 2018 -0400
----------------------------------------------------------------------
src/chapters/configuring.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/51c9dc6f/src/chapters/configuring.xml
----------------------------------------------------------------------
diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml
index 7d78a5a..990b03b 100644
--- a/src/chapters/configuring.xml
+++ b/src/chapters/configuring.xml
@@ -1530,7 +1530,7 @@ tcp6 0 0 :::4713 :::* LISTEN</comp
translated, and you will need to explicitly choose a different layout in your
connection settings. If your keyboard layout is not supported, please notify the
Guacamole team by <link xmlns:xlink="http://www.w3.org/1999/xlink"
- xlink:href="https://glyptodon.org/jira/">opening an issue in
+ xlink:href="https://issues.apache.org/jira/browse/GUACAMOLE">opening an issue in
JIRA</link>.</para>
<informaltable frame="all">
<indexterm>
[16/19] guacamole-manual git commit: Merge 1.0.0 changes back to
master.
Posted by vn...@apache.org.
Merge 1.0.0 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/bd3b4d9a
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/bd3b4d9a
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/bd3b4d9a
Branch: refs/heads/staging/1.0.0
Commit: bd3b4d9a8abbb51aeccec0b42edab2115d754be8
Parents: c0f679c 18a11ff
Author: Nick Couchman <vn...@apache.org>
Authored: Tue Aug 21 12:15:58 2018 -0400
Committer: Nick Couchman <vn...@apache.org>
Committed: Tue Aug 21 12:15:58 2018 -0400
----------------------------------------------------------------------
src/chapters/configuring.xml | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/bd3b4d9a/src/chapters/configuring.xml
----------------------------------------------------------------------
[04/19] guacamole-manual git commit: GUACAMOLE-524: Document the
added attribute tokens in Configuring Guacamole
Posted by vn...@apache.org.
GUACAMOLE-524: Document the added attribute tokens in Configuring Guacamole
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/be2091a7
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/be2091a7
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/be2091a7
Branch: refs/heads/staging/1.0.0
Commit: be2091a73aaf881fa2e64b38368e705569bf29da
Parents: ed72607
Author: Jared Frees <fr...@osu.edu>
Authored: Mon Jul 2 12:13:16 2018 -0400
Committer: Jared Frees <fr...@osu.edu>
Committed: Mon Jul 2 12:13:16 2018 -0400
----------------------------------------------------------------------
src/chapters/configuring.xml | 28 ++++++++++++++++++++--------
1 file changed, 20 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/be2091a7/src/chapters/configuring.xml
----------------------------------------------------------------------
diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml
index 8cb89e3..f2714ae 100644
--- a/src/chapters/configuring.xml
+++ b/src/chapters/configuring.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
-<chapter xml:id="configuring-guacamole"
+<chapter xml:id="configuring-guacamole"
xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
xmlns:xi="http://www.w3.org/2001/XInclude">
@@ -328,7 +328,7 @@ guacd-port: 4822</programlisting>
located at <filename>GUACAMOLE_HOME/user-mapping.xml</filename>. An example of a
user mapping file is included with Guacamole, and looks something like this:</para>
<programlisting><user-mapping>
-
+
<!-- Per-user authentication and config information -->
<authorize username="USERNAME" password="PASSWORD">
<protocol>vnc</protocol>
@@ -339,7 +339,7 @@ guacd-port: 4822</programlisting>
<!-- Another user, but using md5 to hash the password
(example below uses the md5 hash of "PASSWORD") -->
- <authorize
+ <authorize
username="USERNAME2"
password="319f4d26e3c536b5dd871bb2c52e3178"
encoding="md5">
@@ -2484,10 +2484,10 @@ ed272546-87bd-4db9-acba-e36e1a9ca20a
<row>
<entry><parameter>sftp-server-alive-interval</parameter></entry>
<entry>
- <para>The interval in seconds at which to send keepalive
- packets to the SSH server for the SFTP connection. This
- parameter is optional. If omitted, the default of 0 will be
- used, disabling sending keepalive packets. The minimum
+ <para>The interval in seconds at which to send keepalive
+ packets to the SSH server for the SFTP connection. This
+ parameter is optional. If omitted, the default of 0 will be
+ used, disabling sending keepalive packets. The minimum
value is 2.
</para>
</entry>
@@ -2610,7 +2610,7 @@ ed272546-87bd-4db9-acba-e36e1a9ca20a
<row>
<entry><parameter>disable-offscreen-caching</parameter></entry>
<entry>
- <para><indexterm>
+ <para><indexterm>
<primary>RDP</primary>
<secondary>offscreen bitmap caching</secondary>
</indexterm>RDP normally maintains caches of regions of the screen
@@ -4033,6 +4033,18 @@ guaclog: INFO: All files interpreted successfully.</computeroutput>
time that the connection began.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>${GUAC_ATTR_<replaceable>CUSTOM_ATTRIBUTE_NAME</replaceable>}</varname></term>
+ <listitem>
+ <para>An attribute value specified on the current Guacamole user.
+ <replaceable>CUSTOM_ATTRIBUTE_NAME</replaceable> is a custom attrbiute
+ name specified in guacamole.properties. The values for these attributes
+ are queried from the LDAP directory when the user is authenticated.
+ There is a token for each attribute specified in guacamole.properties,
+ so the number of these tokens is arbitrary. If no attributes
+ are specified then these tokens do not exist.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
<para>Note that these tokens are replaced dynamically each time a connection is used. If
two different users access the same connection at the same time, both users will be
[12/19] guacamole-manual git commit: GUACAMOLE-524: Fixed typo and
formatting
Posted by vn...@apache.org.
GUACAMOLE-524: Fixed typo and formatting
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/433cbf95
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/433cbf95
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/433cbf95
Branch: refs/heads/staging/1.0.0
Commit: 433cbf9599fada9d8209cfc562a5219226e3d43d
Parents: 1ee6ba9
Author: Jared Frees <fr...@osu.edu>
Authored: Fri Jul 13 09:30:09 2018 -0400
Committer: Jared Frees <fr...@osu.edu>
Committed: Fri Jul 13 09:30:09 2018 -0400
----------------------------------------------------------------------
src/chapters/ldap-auth.xml | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/433cbf95/src/chapters/ldap-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/ldap-auth.xml b/src/chapters/ldap-auth.xml
index 951758c..9796676 100644
--- a/src/chapters/ldap-auth.xml
+++ b/src/chapters/ldap-auth.xml
@@ -369,17 +369,17 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
saves the first value of the attribute. Multiple attributes can be
specified here, separated by commas.</para>
<para>For example, if <property>ldap-user-attributes</property> is
- "<systemitem>mail, workstation</systemitem>", then a GUAC_ATTR_MAIL
- token would be set to the value of the mail attribute in the LDAP directory
- for the currently logged-in user and a GUAC_ATTR_WORKSTATION token
- would be set to the value of the workstation attribute similarly,
- contingent on the fact that the attributes have a value in the LDAP directory.
- So, the tokens could be used like this:
- <varname>${GUAC_ATTR_MAIL}</varname> or <varname>${GUAC_ATTR_WORKSTATION}/<varname>.
- If the value of mail in the LDAP directory is "example@email.com" then
- <varname>${GUAC_ATTR_MAIL}</varname> would have the value "example@email.com".
- Tokens usage is discussed more in <xref linkend="configuring-guacamole"/> in
- <xref linkend="parameter-tokens"/>.</para>
+ "<systemitem>mail, workstation</systemitem>", then a GUAC_ATTR_MAIL
+ token would be set to the value of the mail attribute in the LDAP directory
+ for the currently logged-in user and a GUAC_ATTR_WORKSTATION token
+ would be set to the value of the workstation attribute similarly,
+ contingent on the fact that the attributes have a value in the LDAP directory.
+ So, the tokens could be used like this:
+ <varname>${GUAC_ATTR_MAIL}</varname> or <varname>${GUAC_ATTR_WORKSTATION}</varname>.
+ If the value of mail in the LDAP directory is "example@email.com" then
+ <varname>${GUAC_ATTR_MAIL}</varname> would have the value "example@email.com".
+ Tokens usage is discussed more in <xref linkend="configuring-guacamole"/> in
+ <xref linkend="parameter-tokens"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
[02/19] guacamole-manual git commit: GUACAMOLE-582: Merge changes
correcting JIRA link.
Posted by vn...@apache.org.
GUACAMOLE-582: Merge changes correcting JIRA link.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/3ffaf262
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/3ffaf262
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/3ffaf262
Branch: refs/heads/staging/1.0.0
Commit: 3ffaf2622ad6b5e2cfe11f2b9c5f78030ed86047
Parents: 744e719 51c9dc6
Author: Michael Jumper <mj...@apache.org>
Authored: Wed Jun 27 20:59:30 2018 -0700
Committer: Michael Jumper <mj...@apache.org>
Committed: Wed Jun 27 20:59:30 2018 -0700
----------------------------------------------------------------------
src/chapters/configuring.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/3ffaf262/src/chapters/configuring.xml
----------------------------------------------------------------------
[03/19] guacamole-manual git commit: GUACAMOLE-524: Document
ldap-user-attributes property that may be added to guacamole.properties
Posted by vn...@apache.org.
GUACAMOLE-524: Document ldap-user-attributes property that may be added
to guacamole.properties
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/ed726073
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/ed726073
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/ed726073
Branch: refs/heads/staging/1.0.0
Commit: ed7260732d747169c204dd8412a6bf85b960aee2
Parents: 744e719
Author: Jared Frees <fr...@osu.edu>
Authored: Mon Jul 2 11:55:47 2018 -0400
Committer: Jared Frees <fr...@osu.edu>
Committed: Mon Jul 2 11:55:47 2018 -0400
----------------------------------------------------------------------
src/chapters/ldap-auth.xml | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/ed726073/src/chapters/ldap-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/ldap-auth.xml b/src/chapters/ldap-auth.xml
index 60e34f7..47d969d 100644
--- a/src/chapters/ldap-auth.xml
+++ b/src/chapters/ldap-auth.xml
@@ -357,6 +357,17 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
</listitem>
</varlistentry>
<varlistentry>
+ <term><property>ldap-user-attributes</property></term>
+ <listitem>
+ <para>The attribute or attributes to retrieve from the LDAP directory.
+ These attributes are stored as tokens with the prefix "GUAC_ATTR_"
+ and the name of the attribute appended in uppercase letters.
+ The value of the token is the value of the attribute in the LDAP directory.
+ If the attribute has no value in the directory then the token is not saved.
+ Multiple attributes can be specified here, separated by commas.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><property>ldap-user-search-filter</property></term>
<listitem>
<para>The search filter used to query the LDAP tree for users that
@@ -539,7 +550,7 @@ member: cn=user2,ou=people,dc=example,dc=net</programlisting>
utility:</para>
<informalexample>
<screen><prompt>$</prompt> <userinput>ldapadd -x -D <replaceable>cn=admin,dc=example,dc=net</replaceable> -W -f <replaceable>example-connection.ldif</replaceable></userinput>
-<computeroutput>Enter LDAP Password:
+<computeroutput>Enter LDAP Password:
adding new entry "cn=Example Connection,ou=groups,dc=example,dc=net"
</computeroutput>
<prompt>$</prompt></screen>
[13/19] guacamole-manual git commit: GUACAMOLE-524: Merge
documentation of user attribute tokens.
Posted by vn...@apache.org.
GUACAMOLE-524: Merge documentation of user attribute tokens.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/95865af6
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/95865af6
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/95865af6
Branch: refs/heads/staging/1.0.0
Commit: 95865af6544123cc48195f4e6650ce7e01a500d3
Parents: faed84f 433cbf9
Author: Nick Couchman <vn...@apache.org>
Authored: Fri Jul 13 10:25:42 2018 -0400
Committer: Nick Couchman <vn...@apache.org>
Committed: Fri Jul 13 10:25:42 2018 -0400
----------------------------------------------------------------------
src/chapters/configuring.xml | 31 +++++++++++++++++++++++--------
src/chapters/ldap-auth.xml | 28 +++++++++++++++++++++++++++-
2 files changed, 50 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/95865af6/src/chapters/configuring.xml
----------------------------------------------------------------------
[07/19] guacamole-manual git commit: GUACAMOLE-524: Fixed wording
Posted by vn...@apache.org.
GUACAMOLE-524: Fixed wording
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/99836115
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/99836115
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/99836115
Branch: refs/heads/staging/1.0.0
Commit: 9983611526ff61e79eced9e31faaef684865a782
Parents: a6139b2
Author: Jared Frees <fr...@osu.edu>
Authored: Thu Jul 5 11:18:29 2018 -0400
Committer: Jared Frees <fr...@osu.edu>
Committed: Thu Jul 5 11:18:29 2018 -0400
----------------------------------------------------------------------
src/chapters/ldap-auth.xml | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/99836115/src/chapters/ldap-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/ldap-auth.xml b/src/chapters/ldap-auth.xml
index d94eb12..19f0b1d 100644
--- a/src/chapters/ldap-auth.xml
+++ b/src/chapters/ldap-auth.xml
@@ -365,8 +365,9 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
in uppercase letters. The value of the token is the value of the attribute
in the LDAP directory for the currently logged-in user. If the attribute
has no value in the LDAP directory then the token is not saved.
- If the LDAP attribute has multiple values then the token saves all of the
- values together. Multiple attributes can be specified here, separated by commas.</para>
+ If the attribute has multiple values in the LDAP directory then the token
+ saves all of the values together. Multiple attributes can be specified here,
+ separated by commas.</para>
</listitem>
</varlistentry>
<varlistentry>
[05/19] guacamole-manual git commit: GUACAMOLE-524: Made attribute
token explanation more generic
Posted by vn...@apache.org.
GUACAMOLE-524: Made attribute token explanation more generic
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/a18f5966
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/a18f5966
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/a18f5966
Branch: refs/heads/staging/1.0.0
Commit: a18f596678719d626270a499b1f9fce93114bf9f
Parents: be2091a
Author: Jared Frees <fr...@osu.edu>
Authored: Thu Jul 5 11:00:46 2018 -0400
Committer: Jared Frees <fr...@osu.edu>
Committed: Thu Jul 5 11:00:46 2018 -0400
----------------------------------------------------------------------
src/chapters/configuring.xml | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/a18f5966/src/chapters/configuring.xml
----------------------------------------------------------------------
diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml
index f2714ae..de25f7e 100644
--- a/src/chapters/configuring.xml
+++ b/src/chapters/configuring.xml
@@ -4037,12 +4037,11 @@ guaclog: INFO: All files interpreted successfully.</computeroutput>
<term><varname>${GUAC_ATTR_<replaceable>CUSTOM_ATTRIBUTE_NAME</replaceable>}</varname></term>
<listitem>
<para>An attribute value specified on the current Guacamole user.
- <replaceable>CUSTOM_ATTRIBUTE_NAME</replaceable> is a custom attrbiute
- name specified in guacamole.properties. The values for these attributes
- are queried from the LDAP directory when the user is authenticated.
- There is a token for each attribute specified in guacamole.properties,
- so the number of these tokens is arbitrary. If no attributes
- are specified then these tokens do not exist.</para>
+ <replaceable>CUSTOM_ATTRIBUTE_NAME</replaceable> is a custom
+ user attribute that may be obtained from any of the authentication
+ modules that implement the feature. There are an arbitrary
+ number of these tokens. If no attributes are specified
+ then this token does not exist.</para>
</listitem>
</varlistentry>
</variablelist>
[11/19] guacamole-manual git commit: GUACAMOLE-524: Added
in two spots where it was missing
Posted by vn...@apache.org.
GUACAMOLE-524: Added <varname> in two spots where it was missing
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/1ee6ba9f
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/1ee6ba9f
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/1ee6ba9f
Branch: refs/heads/staging/1.0.0
Commit: 1ee6ba9fbe7cc19b85cb1f0efe76e63054a1206c
Parents: 86cbb0b
Author: Jared Frees <fr...@osu.edu>
Authored: Tue Jul 10 11:49:29 2018 -0400
Committer: Jared Frees <fr...@osu.edu>
Committed: Tue Jul 10 11:49:29 2018 -0400
----------------------------------------------------------------------
src/chapters/configuring.xml | 2 +-
src/chapters/ldap-auth.xml | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/1ee6ba9f/src/chapters/configuring.xml
----------------------------------------------------------------------
diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml
index d0548ff..e4acadb 100644
--- a/src/chapters/configuring.xml
+++ b/src/chapters/configuring.xml
@@ -4043,7 +4043,7 @@ guaclog: INFO: All files interpreted successfully.</computeroutput>
number of these tokens. If no attributes are specified
then this token does not exist.</para>
<para>For example, if an attribute name is specified as "mail" then a token would
- be set as ${GUAC_ATTR_MAIL} with the value of "mail" in the authentication
+ be set as <varname>${GUAC_ATTR_MAIL}</varname> with the value of "mail" in the authentication
module that "mail" is specified in. For a practical example, see
<property>ldap-user-attributes</property> in <xref linkend="ldap-auth"/>.</para>
</listitem>
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/1ee6ba9f/src/chapters/ldap-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/ldap-auth.xml b/src/chapters/ldap-auth.xml
index 45e728d..951758c 100644
--- a/src/chapters/ldap-auth.xml
+++ b/src/chapters/ldap-auth.xml
@@ -377,7 +377,7 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
So, the tokens could be used like this:
<varname>${GUAC_ATTR_MAIL}</varname> or <varname>${GUAC_ATTR_WORKSTATION}/<varname>.
If the value of mail in the LDAP directory is "example@email.com" then
- ${GUAC_ATTR_MAIL} would have the value "example@email.com".
+ <varname>${GUAC_ATTR_MAIL}</varname> would have the value "example@email.com".
Tokens usage is discussed more in <xref linkend="configuring-guacamole"/> in
<xref linkend="parameter-tokens"/>.</para>
</listitem>
[14/19] guacamole-manual git commit: Merge 1.0.0 changes back to
master.
Posted by vn...@apache.org.
Merge 1.0.0 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/06dd5933
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/06dd5933
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/06dd5933
Branch: refs/heads/staging/1.0.0
Commit: 06dd5933c406d8af773a0d054d0ff1afb8cfe589
Parents: 95865af ca29a65
Author: Michael Jumper <mj...@apache.org>
Authored: Tue Jul 17 18:25:06 2018 -0700
Committer: Michael Jumper <mj...@apache.org>
Committed: Tue Jul 17 18:25:06 2018 -0700
----------------------------------------------------------------------
src/chapters/adhoc-connections.xml | 118 ++++++++++++++++++++++++++++++++
src/gug.xml | 1 +
2 files changed, 119 insertions(+)
----------------------------------------------------------------------
[10/19] guacamole-manual git commit: GUACAMOLE-524: Added exmaples
and links for attribute tokens
Posted by vn...@apache.org.
GUACAMOLE-524: Added exmaples and links for attribute tokens
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/86cbb0b8
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/86cbb0b8
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/86cbb0b8
Branch: refs/heads/staging/1.0.0
Commit: 86cbb0b86bb71cdb50ecaac5361dea5ee3127a32
Parents: df26b02
Author: Jared Frees <fr...@osu.edu>
Authored: Tue Jul 10 11:46:02 2018 -0400
Committer: Jared Frees <fr...@osu.edu>
Committed: Tue Jul 10 11:46:02 2018 -0400
----------------------------------------------------------------------
src/chapters/configuring.xml | 4 ++++
src/chapters/ldap-auth.xml | 12 ++++++++++++
2 files changed, 16 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/86cbb0b8/src/chapters/configuring.xml
----------------------------------------------------------------------
diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml
index de25f7e..d0548ff 100644
--- a/src/chapters/configuring.xml
+++ b/src/chapters/configuring.xml
@@ -4042,6 +4042,10 @@ guaclog: INFO: All files interpreted successfully.</computeroutput>
modules that implement the feature. There are an arbitrary
number of these tokens. If no attributes are specified
then this token does not exist.</para>
+ <para>For example, if an attribute name is specified as "mail" then a token would
+ be set as ${GUAC_ATTR_MAIL} with the value of "mail" in the authentication
+ module that "mail" is specified in. For a practical example, see
+ <property>ldap-user-attributes</property> in <xref linkend="ldap-auth"/>.</para>
</listitem>
</varlistentry>
</variablelist>
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/86cbb0b8/src/chapters/ldap-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/ldap-auth.xml b/src/chapters/ldap-auth.xml
index 58f9dbf..45e728d 100644
--- a/src/chapters/ldap-auth.xml
+++ b/src/chapters/ldap-auth.xml
@@ -368,6 +368,18 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
If the attribute has multiple values in the LDAP directory then the token
saves the first value of the attribute. Multiple attributes can be
specified here, separated by commas.</para>
+ <para>For example, if <property>ldap-user-attributes</property> is
+ "<systemitem>mail, workstation</systemitem>", then a GUAC_ATTR_MAIL
+ token would be set to the value of the mail attribute in the LDAP directory
+ for the currently logged-in user and a GUAC_ATTR_WORKSTATION token
+ would be set to the value of the workstation attribute similarly,
+ contingent on the fact that the attributes have a value in the LDAP directory.
+ So, the tokens could be used like this:
+ <varname>${GUAC_ATTR_MAIL}</varname> or <varname>${GUAC_ATTR_WORKSTATION}/<varname>.
+ If the value of mail in the LDAP directory is "example@email.com" then
+ ${GUAC_ATTR_MAIL} would have the value "example@email.com".
+ Tokens usage is discussed more in <xref linkend="configuring-guacamole"/> in
+ <xref linkend="parameter-tokens"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
[08/19] guacamole-manual git commit: GUACAMOLE-524: Correct what
happens for a multi-valued attribute
Posted by vn...@apache.org.
GUACAMOLE-524: Correct what happens for a multi-valued attribute
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/df26b02f
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/df26b02f
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/df26b02f
Branch: refs/heads/staging/1.0.0
Commit: df26b02fae822c810df7973142f590597fe7727c
Parents: 9983611
Author: Jared Frees <fr...@osu.edu>
Authored: Thu Jul 5 12:36:24 2018 -0400
Committer: Jared Frees <fr...@osu.edu>
Committed: Thu Jul 5 12:36:24 2018 -0400
----------------------------------------------------------------------
src/chapters/ldap-auth.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/df26b02f/src/chapters/ldap-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/ldap-auth.xml b/src/chapters/ldap-auth.xml
index 19f0b1d..58f9dbf 100644
--- a/src/chapters/ldap-auth.xml
+++ b/src/chapters/ldap-auth.xml
@@ -366,8 +366,8 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
in the LDAP directory for the currently logged-in user. If the attribute
has no value in the LDAP directory then the token is not saved.
If the attribute has multiple values in the LDAP directory then the token
- saves all of the values together. Multiple attributes can be specified here,
- separated by commas.</para>
+ saves the first value of the attribute. Multiple attributes can be
+ specified here, separated by commas.</para>
</listitem>
</varlistentry>
<varlistentry>
[19/19] guacamole-manual git commit: GUACAMOLE-464: Merge document
enable-environment-properties
Posted by vn...@apache.org.
GUACAMOLE-464: Merge document enable-environment-properties
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/c0c69901
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/c0c69901
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/c0c69901
Branch: refs/heads/staging/1.0.0
Commit: c0c6990168986c0c87db745056731b0b39b87f9b
Parents: 37be4cc 998f9d6
Author: Nick Couchman <vn...@apache.org>
Authored: Fri Sep 28 15:51:23 2018 -0400
Committer: Nick Couchman <vn...@apache.org>
Committed: Fri Sep 28 15:51:23 2018 -0400
----------------------------------------------------------------------
src/chapters/configuring.xml | 22 ++++++++++++++++++++++
src/chapters/docker.xml | 12 ++++++++++++
2 files changed, 34 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/c0c69901/src/chapters/configuring.xml
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/c0c69901/src/chapters/docker.xml
----------------------------------------------------------------------
[17/19] guacamole-manual git commit: Merge 1.0.0 changes back to
master.
Posted by vn...@apache.org.
Merge 1.0.0 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/37be4cc7
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/37be4cc7
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/37be4cc7
Branch: refs/heads/staging/1.0.0
Commit: 37be4cc7e46f16f8ecfccd7b997e4501098e7566
Parents: bd3b4d9 563a0e6
Author: Nick Couchman <vn...@apache.org>
Authored: Tue Aug 21 12:28:09 2018 -0400
Committer: Nick Couchman <vn...@apache.org>
Committed: Tue Aug 21 12:28:09 2018 -0400
----------------------------------------------------------------------
src/chapters/configuring.xml | 164 ++++++++++++++++++++++++++++++++++----
1 file changed, 150 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/37be4cc7/src/chapters/configuring.xml
----------------------------------------------------------------------
[15/19] guacamole-manual git commit: Merge 1.0.0 changes back to
master.
Posted by vn...@apache.org.
Merge 1.0.0 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/c0f679cb
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/c0f679cb
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/c0f679cb
Branch: refs/heads/staging/1.0.0
Commit: c0f679cbf69d6590d4e4a1120e440b420da23868
Parents: 06dd593 4e1b3b3
Author: Michael Jumper <mj...@apache.org>
Authored: Wed Jul 18 21:27:21 2018 -0700
Committer: Michael Jumper <mj...@apache.org>
Committed: Wed Jul 18 21:27:21 2018 -0700
----------------------------------------------------------------------
src/chapters/configuring.xml | 68 ++++++++++++++++++++++++
src/chapters/reverse-proxy.xml | 100 ++++++++++++++++++++++++++++++++++++
2 files changed, 168 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/c0f679cb/src/chapters/configuring.xml
----------------------------------------------------------------------
[09/19] guacamole-manual git commit: Merge 1.0.0 changes back to
master.
Posted by vn...@apache.org.
Merge 1.0.0 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/faed84f5
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/faed84f5
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/faed84f5
Branch: refs/heads/staging/1.0.0
Commit: faed84f5310566890cf178352cc167b4d52fa5f4
Parents: 3ffaf26 b8330b1
Author: Michael Jumper <mj...@apache.org>
Authored: Fri Jul 6 11:43:15 2018 -0700
Committer: Michael Jumper <mj...@apache.org>
Committed: Fri Jul 6 11:43:15 2018 -0700
----------------------------------------------------------------------
src/chapters/configuring.xml | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/faed84f5/src/chapters/configuring.xml
----------------------------------------------------------------------
[06/19] guacamole-manual git commit: GUACAMOLE-524: Clarify ldap
attributes are for logged in user and multiple-valued attributes are saved
all together as a token
Posted by vn...@apache.org.
GUACAMOLE-524: Clarify ldap attributes are for logged in user and multiple-valued attributes are saved all together as a token
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/a6139b2d
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/a6139b2d
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/a6139b2d
Branch: refs/heads/staging/1.0.0
Commit: a6139b2d191c93021ebeaf92879490bf174f3c55
Parents: a18f596
Author: Jared Frees <fr...@osu.edu>
Authored: Thu Jul 5 11:16:27 2018 -0400
Committer: Jared Frees <fr...@osu.edu>
Committed: Thu Jul 5 11:16:27 2018 -0400
----------------------------------------------------------------------
src/chapters/ldap-auth.xml | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/a6139b2d/src/chapters/ldap-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/ldap-auth.xml b/src/chapters/ldap-auth.xml
index 47d969d..d94eb12 100644
--- a/src/chapters/ldap-auth.xml
+++ b/src/chapters/ldap-auth.xml
@@ -359,12 +359,14 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
<varlistentry>
<term><property>ldap-user-attributes</property></term>
<listitem>
- <para>The attribute or attributes to retrieve from the LDAP directory.
- These attributes are stored as tokens with the prefix "GUAC_ATTR_"
- and the name of the attribute appended in uppercase letters.
- The value of the token is the value of the attribute in the LDAP directory.
- If the attribute has no value in the directory then the token is not saved.
- Multiple attributes can be specified here, separated by commas.</para>
+ <para>The attribute or attributes to retrieve from the LDAP directory
+ for the currently logged-in user. These attributes are stored as
+ tokens with the prefix "GUAC_ATTR_" and the name of the attribute appended
+ in uppercase letters. The value of the token is the value of the attribute
+ in the LDAP directory for the currently logged-in user. If the attribute
+ has no value in the LDAP directory then the token is not saved.
+ If the LDAP attribute has multiple values then the token saves all of the
+ values together. Multiple attributes can be specified here, separated by commas.</para>
</listitem>
</varlistentry>
<varlistentry>
[18/19] guacamole-manual git commit: GUACAMOLE-464: document
enable-environment-properties configuration property
Posted by vn...@apache.org.
GUACAMOLE-464: document enable-environment-properties configuration property
Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/998f9d63
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/998f9d63
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/998f9d63
Branch: refs/heads/staging/1.0.0
Commit: 998f9d6303b3815ad06c4cf0c63eb75d1a4050bd
Parents: c36251e
Author: Carl Harris <ce...@vt.edu>
Authored: Tue Jan 16 16:47:49 2018 -0500
Committer: Carl Harris <ce...@vt.edu>
Committed: Fri Sep 28 10:14:43 2018 -0400
----------------------------------------------------------------------
src/chapters/configuring.xml | 22 ++++++++++++++++++++++
src/chapters/docker.xml | 12 ++++++++++++
2 files changed, 34 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/998f9d63/src/chapters/configuring.xml
----------------------------------------------------------------------
diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml
index e8104f7..4d930e3 100644
--- a/src/chapters/configuring.xml
+++ b/src/chapters/configuring.xml
@@ -161,6 +161,28 @@
</varlistentry>
<varlistentry>
<term><indexterm xmlns:xl="http://www.w3.org/1999/xlink">
+ <primary>enable-environment-properties</primary>
+ </indexterm><parameter>enable-environment-properties</parameter></term>
+ <listitem>
+ <para>If set to "true", Guacamole will first evaluate its environment to obtain
+ the value for any given configuration property, before using a value specified
+ in <filename>guacamole.properties</filename> or falling back to a default
+ value. By enabling this option, you can easily override any other configuration
+ property using an environment variable.</para>
+ <informalexample>
+ <programlisting>enable-environment-properties: true</programlisting>
+ </informalexample>
+ <para>When searching for a configuration property in the environment, the name of
+ the property is first transformed by converting all lower case characters to
+ their upper case equivalents, and by replacing all hyphen characters (<code>-</code>) with
+ underscore characters (<code>_</code>). For example, the
+ <parameter>guacd-hostname</parameter> property would be transformed to
+ <parameter>GUACD_HOSTNAME</parameter> when searching the environment.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><indexterm xmlns:xl="http://www.w3.org/1999/xlink">
<primary>guacd-hostname</primary>
</indexterm><parameter>guacd-hostname</parameter></term>
<listitem>
http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/998f9d63/src/chapters/docker.xml
----------------------------------------------------------------------
diff --git a/src/chapters/docker.xml b/src/chapters/docker.xml
index c58cee8..d63ceb7 100644
--- a/src/chapters/docker.xml
+++ b/src/chapters/docker.xml
@@ -106,6 +106,18 @@
<uri>http://<replaceable>HOSTNAME</replaceable>:8080/guacamole/</uri>, where
<replaceable>HOSTNAME</replaceable> is the hostname or address of the machine
hosting Docker.</para>
+ <section xml:id="guacamole-docker-config-via-env">
+ <title>Configuring Guacamole when using Docker</title>
+ <para>When running Guacamole using Docker, the traditional approach to configuring
+ Guacamole by editing <filename>guacamole.properties</filename> is less
+ convenient. When using Docker, you may wish to make use of the
+ <parameter>enable-environment-properties</parameter> configuration
+ property, which allows you to specify values for arbitrary Guacamole
+ configuration properties using environment variables. This is covered in
+ <xref xmlns:xlink="http://www.w3.org/1999/xlink"
+ linkend="configuring-guacamole"/>.
+ </para>
+ </section>
<section xml:id="guacamole-docker-guacd">
<title>Connecting Guacamole to <package>guacd</package></title>
<para>The Guacamole Docker image needs to be able to connect to <package>guacd</package>