GUACAMOLE-524: Added exmaples and links for attribute tokens


Branch: refs/heads/master
Commit: 86cbb0b86bb71cdb50ecaac5361dea5ee3127a32
Parents: df26b02
Author: Jared Frees <>
Authored: Tue Jul 10 11:46:02 2018 -0400
Committer: Jared Frees <>
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(+)
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 
                             modules that implement the feature. There are an 
                             number of these tokens. If no attributes are 
                             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 
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 
+                        token would be set to the value of the mail attribute 
in the LDAP directory
+                        for the currently logged-in user and a 
+                        would be set to the value of the workstation attribute 
+                        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 
+                        If the value of mail in the LDAP directory is 
"" then
+                        ${GUAC_ATTR_MAIL} would have the value 
+                        Tokens usage is discussed more in <xref 
linkend="configuring-guacamole"/> in
+                        <xref linkend="parameter-tokens"/>.</para>

Reply via email to