You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@guacamole.apache.org by necouchman <gi...@git.apache.org> on 2017/03/18 17:34:07 UTC

[GitHub] incubator-guacamole-manual pull request #38: GUACAMOLE-244: Configuration of...

GitHub user necouchman opened a pull request:

    https://github.com/apache/incubator-guacamole-manual/pull/38

    GUACAMOLE-244: Configuration of Dereferencing Aliases

    This adds documentation for the single parameter added to the client that allows for configuring when the LDAP connection follows (dereferences) aliases.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/necouchman/incubator-guacamole-manual GUACAMOLE-244

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/incubator-guacamole-manual/pull/38.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #38
    
----
commit 8c5d6ff6d04f3912390d15b6d7be3d7d2d4bba9f
Author: Nick Couchman <ni...@yahoo.com>
Date:   2017-03-18T17:32:31Z

    GUACAMOLE-244: Add documentation for new ldap-dereference-alises parameter.

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-guacamole-manual pull request #38: GUACAMOLE-244: Configuration of...

Posted by necouchman <gi...@git.apache.org>.
Github user necouchman commented on a diff in the pull request:

    https://github.com/apache/incubator-guacamole-manual/pull/38#discussion_r107881977
  
    --- Diff: src/chapters/ldap-auth.xml ---
    @@ -384,6 +384,16 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
                                     have no effect on Guacamole configurations.</emphasis></para>
                         </listitem>
                     </varlistentry>
    +                <varlistentry>
    +                    <term><property>ldap-dereference-aliases</property></term>
    +                    <listitem>
    +                        <para>Controls whether or not the LDAP connection follows (dereferences) aliases
    +                            as it searches the tree.  Possible values for this property are "never" (the default)
    +                            so that aliases will never be followed, "searching" to dereference during search operations
    +                            after the base object is located, "finding" to dereference in order to locate the
    +                            search base, but not during the actual search, and "always" to always dereference aliases.
    --- End diff --
    
    Fixed, and built it to make sure.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-guacamole-manual pull request #38: GUACAMOLE-244: Configuration of...

Posted by mike-jumper <gi...@git.apache.org>.
Github user mike-jumper commented on a diff in the pull request:

    https://github.com/apache/incubator-guacamole-manual/pull/38#discussion_r107335467
  
    --- Diff: src/chapters/ldap-auth.xml ---
    @@ -384,6 +384,17 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
                                     have no effect on Guacamole configurations.</emphasis></para>
                         </listitem>
                     </varlistentry>
    +                <varlistentry>
    +                    <term><property>ldap-dereference-aliases</property></term>
    +                    <listitem>
    +                        <para>Controls whether or not the LDAP connection follows (dereferences) aliases
    +                            as it searches the tree.  There are four possible values: never (the default),
    +                            finding, searching, and always.  Never means aliases will never be followed;
    --- End diff --
    
    Similar to the above, starting this sentence with "Never means ..." (uppercase N) could lead to confusion when specifying the `ldap-dereference-aliases` property, as the values are strictly interpreted. Things need to be rephrased/reorganized somehow such that the value itself can be written lowercase, exactly as it would appear in `guacamole.properties`, and in quotes so it's clear that we're referring to a strict literal value.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-guacamole-manual pull request #38: GUACAMOLE-244: Configuration of...

Posted by mike-jumper <gi...@git.apache.org>.
Github user mike-jumper commented on a diff in the pull request:

    https://github.com/apache/incubator-guacamole-manual/pull/38#discussion_r107831161
  
    --- Diff: src/chapters/ldap-auth.xml ---
    @@ -384,6 +384,16 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
                                     have no effect on Guacamole configurations.</emphasis></para>
                         </listitem>
                     </varlistentry>
    +                <varlistentry>
    +                    <term><property>ldap-dereference-aliases</property></term>
    +                    <listitem>
    +                        <para>Controls whether or not the LDAP connection follows (dereferences) aliases
    +                            as it searches the tree.  Possible values for this property are "never" (the default)
    +                            so that aliases will never be followed, "searching" to dereference during search operations
    +                            after the base object is located, "finding" to dereference in order to locate the
    +                            search base, but not during the actual search, and "always" to always dereference aliases.
    --- End diff --
    
    Your `<para>` is missing a corresponding end tag, which is causing the manual build to fail with these changes present:
    
    ```
    $ make
    cd src; xsltproc -o ../html/ --xinclude site.xslt gug.xml
    chapters/ldap-auth.xml:395: parser error : Opening and ending tag mismatch: para line 390 and listitem
                        </listitem>
                                   ^
    ```



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-guacamole-manual pull request #38: GUACAMOLE-244: Configuration of...

Posted by necouchman <gi...@git.apache.org>.
Github user necouchman commented on a diff in the pull request:

    https://github.com/apache/incubator-guacamole-manual/pull/38#discussion_r107403427
  
    --- Diff: src/chapters/ldap-auth.xml ---
    @@ -384,6 +384,17 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
                                     have no effect on Guacamole configurations.</emphasis></para>
                         </listitem>
                     </varlistentry>
    +                <varlistentry>
    +                    <term><property>ldap-dereference-aliases</property></term>
    +                    <listitem>
    +                        <para>Controls whether or not the LDAP connection follows (dereferences) aliases
    +                            as it searches the tree.  There are four possible values: never (the default),
    +                            finding, searching, and always.  Never means aliases will never be followed;
    --- End diff --
    
    Reworded.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-guacamole-manual pull request #38: GUACAMOLE-244: Configuration of...

Posted by mike-jumper <gi...@git.apache.org>.
Github user mike-jumper commented on a diff in the pull request:

    https://github.com/apache/incubator-guacamole-manual/pull/38#discussion_r107585193
  
    --- Diff: src/chapters/ldap-auth.xml ---
    @@ -388,11 +388,10 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
                         <term><property>ldap-dereference-aliases</property></term>
                         <listitem>
                             <para>Controls whether or not the LDAP connection follows (dereferences) aliases
    -                            as it searches the tree.  There are four possible values: never (the default),
    -                            finding, searching, and always.  Never means aliases will never be followed;
    -                            searching means they will be dereferenced during search, but not when finding
    -                            the start of the search; finding means only when finding the start of the search,
    -                            but not during the search; always means they will always be followed.</para>
    +                            as it searches the tree.  Poossible values for this property are "never" (the default)
    --- End diff --
    
    "Poossible", you say. \U0001f4a9


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-guacamole-manual pull request #38: GUACAMOLE-244: Configuration of...

Posted by necouchman <gi...@git.apache.org>.
Github user necouchman commented on a diff in the pull request:

    https://github.com/apache/incubator-guacamole-manual/pull/38#discussion_r107403407
  
    --- Diff: src/chapters/ldap-auth.xml ---
    @@ -384,6 +384,17 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
                                     have no effect on Guacamole configurations.</emphasis></para>
                         </listitem>
                     </varlistentry>
    +                <varlistentry>
    +                    <term><property>ldap-dereference-aliases</property></term>
    +                    <listitem>
    +                        <para>Controls whether or not the LDAP connection follows (dereferences) aliases
    +                            as it searches the tree.  There are four possible values: never (the default),
    --- End diff --
    
    Fixed.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-guacamole-manual pull request #38: GUACAMOLE-244: Configuration of...

Posted by mike-jumper <gi...@git.apache.org>.
Github user mike-jumper commented on a diff in the pull request:

    https://github.com/apache/incubator-guacamole-manual/pull/38#discussion_r107335308
  
    --- Diff: src/chapters/ldap-auth.xml ---
    @@ -384,6 +384,17 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
                                     have no effect on Guacamole configurations.</emphasis></para>
                         </listitem>
                     </varlistentry>
    +                <varlistentry>
    +                    <term><property>ldap-dereference-aliases</property></term>
    +                    <listitem>
    +                        <para>Controls whether or not the LDAP connection follows (dereferences) aliases
    +                            as it searches the tree.  There are four possible values: never (the default),
    --- End diff --
    
    The values themselves need to be in quotes, so it's clear that their literal values must be specified verbatim. This is the convention that we follow elsewhere. For example, a few sections above:
    
        <para>The encryption mechanism that Guacamole should use when communicating
            with your LDAP server. Legal values are "none" for unencrypted LDAP,
            "ssl" for LDAP over SSL/TLS (commonly known as LDAPS), or "starttls" for
            STARTTLS. If omitted, encryption will not be used.</para>



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-guacamole-manual pull request #38: GUACAMOLE-244: Configuration of...

Posted by necouchman <gi...@git.apache.org>.
Github user necouchman commented on a diff in the pull request:

    https://github.com/apache/incubator-guacamole-manual/pull/38#discussion_r107682052
  
    --- Diff: src/chapters/ldap-auth.xml ---
    @@ -388,11 +388,10 @@ dn: cn={4}guacConfigGroup,cn=schema,cn=config
                         <term><property>ldap-dereference-aliases</property></term>
                         <listitem>
                             <para>Controls whether or not the LDAP connection follows (dereferences) aliases
    -                            as it searches the tree.  There are four possible values: never (the default),
    -                            finding, searching, and always.  Never means aliases will never be followed;
    -                            searching means they will be dereferenced during search, but not when finding
    -                            the start of the search; finding means only when finding the start of the search,
    -                            but not during the search; always means they will always be followed.</para>
    +                            as it searches the tree.  Poossible values for this property are "never" (the default)
    --- End diff --
    
    Fixed.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-guacamole-manual pull request #38: GUACAMOLE-244: Configuration of...

Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:

    https://github.com/apache/incubator-guacamole-manual/pull/38


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---