Repository: guacamole-manual Updated Branches: refs/heads/staging/0.9.14 7cd86517a -> da3aa5e66
GUACAMOLE-243: Add documentation for referral parameters. Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/eab8ae3d Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/eab8ae3d Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/eab8ae3d Branch: refs/heads/staging/0.9.14 Commit: eab8ae3da4655e6677d44a81ddad982feb28d03f Parents: 4e18295 Author: Nick Couchman <vn...@apache.org> Authored: Mon Oct 23 20:41:42 2017 -0400 Committer: Nick Couchman <vn...@apache.org> Committed: Mon Oct 23 20:41:42 2017 -0400 ---------------------------------------------------------------------- src/chapters/ldap-auth.xml | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/eab8ae3d/src/chapters/ldap-auth.xml ---------------------------------------------------------------------- diff --git a/src/chapters/ldap-auth.xml b/src/chapters/ldap-auth.xml index b08cc5e..5c38113 100644 --- a/src/chapters/ldap-auth.xml +++ b/src/chapters/ldap-auth.xml @@ -404,6 +404,35 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config aliases.</para> </listitem> </varlistentry> + <varlistentry> + <term><property>ldap-follow-referrals</property></term> + <listitem> + <para>This option controls whether or not the LDAP connection follows referrals when + processing search results from a LDAP operation. Referrals can be pointers to other + parts of an LDAP tree, or to a different server/connection altogether. This is a boolean + parameter, with valid options of "true" or "false." The default is false. When disabled, + LDAP referrals will be ignored when encounterd by the Guacamole LDAP client and the client + will move on to the next result. When enabled, the LDAP client will follow the referral and + process results within the referral, subject to the maximum hops parameter below.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><property>ldap-max-referral-hops</property></term> + <listitem> + <para>This option controls the maximum number of referrals that will be processed before the + LDAP client refuses to follow any more referrals. The default is 5. If the ldap-follow-referrals + property is set to false (the default), this option has no effect. If the ldap-follow-referrals option + is set to true, this will limit the depth of referrals followed to the number specified.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><property>ldap-operation-timeout</property></term> + <para>This option sets the timeout, in seconds, of any single LDAP operation. The default is 30 seconds. + When this timeout is reached LDAP operations will be aborted. + </para> + <listitem> + </listitem> + </varlistentry> </variablelist> <para>Again, even if the defaults are sufficient for the other properties, <emphasis>you must still specify the <property>ldap-user-base-dn</property>
