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/master Commit: 86cbb0b86bb71cdb50ecaac5361dea5ee3127a32 Parents: df26b02 Author: Jared Frees <frees...@osu.edu> Authored: Tue Jul 10 11:46:02 2018 -0400 Committer: Jared Frees <frees...@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 "exam...@email.com" then + ${GUAC_ATTR_MAIL} would have the value "exam...@email.com". + Tokens usage is discussed more in <xref linkend="configuring-guacamole"/> in + <xref linkend="parameter-tokens"/>.</para> </listitem> </varlistentry> <varlistentry>
