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/master
Commit: be2091a73aaf881fa2e64b38368e705569bf29da
Parents: ed72607
Author: Jared Frees <frees...@osu.edu>
Authored: Mon Jul 2 12:13:16 2018 -0400
Committer: Jared Frees <frees...@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>&lt;user-mapping>
-       
+
     &lt;!-- Per-user authentication and config information -->
     &lt;authorize username="USERNAME" password="PASSWORD">
         &lt;protocol>vnc&lt;/protocol>
@@ -339,7 +339,7 @@ guacd-port:     4822</programlisting>
 
     &lt;!-- Another user, but using md5 to hash the password
          (example below uses the md5 hash of "PASSWORD") -->
-    &lt;authorize 
+    &lt;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

Reply via email to