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 2018/04/01 00:17:29 UTC

[GitHub] guacamole-manual pull request #87: GUACAMOLE-38: Add chapter for Quickconnec...

GitHub user necouchman opened a pull request:

    https://github.com/apache/guacamole-manual/pull/87

    GUACAMOLE-38: Add chapter for Quickconnect extension.

    Adds the chapter for the quickconnect extension.

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

    $ git pull https://github.com/necouchman/guacamole-manual jira/38

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

    https://github.com/apache/guacamole-manual/pull/87.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 #87
    
----
commit 668e3f61aa8149442ea00cf44f5cd10641bceb03
Author: Nick Couchman <vn...@...>
Date:   2018-04-01T00:16:37Z

    GUACAMOLE-38: Add chapter for Quickconnect extension.

----


---

[GitHub] guacamole-manual pull request #87: GUACAMOLE-38: Add chapter for Quickconnec...

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

    https://github.com/apache/guacamole-manual/pull/87#discussion_r194400233
  
    --- Diff: src/chapters/quickconnect.xml ---
    @@ -0,0 +1,90 @@
    +<?xml version="1.0" encoding="UTF-8"?>
    +
    +<chapter xml:id="quickconnect" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
    +    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">
    +    <title>Quickconnect extension</title>
    --- End diff --
    
    Some ideas:
    - Adhoc Connections
    - User-defined Connections
    - Temporary Connections
    
    I'm having a hard time finding anything that just calls out to me, here...


---

[GitHub] guacamole-manual pull request #87: GUACAMOLE-38: Add chapter for Quickconnec...

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

    https://github.com/apache/guacamole-manual/pull/87#discussion_r194417517
  
    --- Diff: src/chapters/quickconnect.xml ---
    @@ -0,0 +1,90 @@
    +<?xml version="1.0" encoding="UTF-8"?>
    +
    +<chapter xml:id="quickconnect" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
    +    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">
    +    <title>Quickconnect extension</title>
    +    <indexterm>
    +        <primary>quickconnect</primary>
    +    </indexterm>
    +    <para>The quickconnect extension provides a connection bar on the Guacamole Client home page
    +        that allows users to type in the URI of a server to which they want to connect and the client
    +        will parse the URI and immediately establish the connection.  The purpose of the extension is
    +        to allow situations where administrators want to allow users the flexibility of establishing
    +        their own connections without having to grant them access to edit connections or even to have
    +        to create the connections at all, aside from typing the URI.</para>
    +    <important>
    +        <para>Connections established with the quickconnect extension are create in-memory and only
    +            persist until the user logs out or the browser it closed.  As soon as the user's session
    +            is cleaned up, the connections are lost.  Furthermore, connections created/established
    +            with this module will not be visibile to other users - if connections need to be usable
    +            by multiple Guacamole users, please use one of the other modules (JDBC or LDAP).</para>
    +        <para>Also, while this extension is technically an authentication extension, it provides
    +            no facility for actually authenticating users - it will not allow anonymous logins,
    +            and relies on users being successfully authenticated and able to access the Guacamole
    +            Home page before it can be used.  This extension must be "stacked" with other modules
    +            that provide facilities for authenticating users.</para>
    +    </important>
    +    <section xml:id="quickconnect-downloading">
    +        <title>Downloading the quickconnect extension</title>
    +        <para>The quickconnect extension is available separately from the main
    +                <filename>guacamole.war</filename>. The link for this and all other
    +            officially-supported and compatible extensions for a particular version of Guacamole are
    +            provided in the release notes for that version. You can find the release notes for
    +            current versions of Guacamole here: <link
    +                xlink:href="http://guacamole.apache.org/releases/"
    +                >http://guacamole.apache.org/releases/</link>.</para>
    +        <para>The quickconnect extension is packaged as a <filename>.tar.gz</filename> file containing
    +            only the extension itself, <filename>guacamole-auth-quickconnect-0.9.14.jar</filename>, which must
    +            ultimately be placed in <filename>GUACAMOLE_HOME/extensions</filename>.</para>
    +    </section>
    +    <section xml:id="installing-quickconnect">
    +        <title>Installing the quickconnect extension</title>
    +        <para>Guacamole extensions are self-contained <filename>.jar</filename> files which are
    +            located within the <filename>GUACAMOLE_HOME/extensions</filename> directory.
    +                <emphasis>If you are unsure where <varname>GUACAMOLE_HOME</varname> is located on
    +                your system, please consult <xref linkend="configuring-guacamole"/> before
    +                proceeding.</emphasis></para>
    +        <para>To install the extension, you must:</para>
    +        <procedure>
    +            <step>
    +                <para>Create the <filename>GUACAMOLE_HOME/extensions</filename> directory, if it
    +                    does not already exist.</para>
    +            </step>
    +            <step>
    +                <para>Place the <filename>guacamole-auth-quickconnect-0.9.14.jar</filename> file in
    +                    the <filename>GUACAMOLE_HOME/extensions</filename> directory.</para>
    +            </step>
    +        </procedure>
    +        <section xml:id="guac-quickconnect-config">
    +            <title>Configuring Guacamole for the quickconnect extension</title>
    +            <indexterm>
    +                <primary>configuring quickconnect</primary>
    +            </indexterm>
    +            <para>This module has no configuration options.</para>
    +        </section>
    +        <section xml:id="completing-quickconnect-install">
    +            <title>Completing the installation</title>
    +            <para>Guacamole will only load newly-installed extensions during startup, so your
    +                servlet container will need to be restarted before the quickconnect extension
    +                can be used. <emphasis>Doing this will disconnect all active users, so be sure
    +                    that it is safe to do so prior to attempting installation.</emphasis>
    +                When ready, restart your servlet container and give the extension a try.</para>
    +        </section>
    +    </section>
    +    <section xml:id="using-quickconnect">
    +        <title>Using the quickconnect extension</title>
    +        <para>The quickconnect extension provides a field on the home page that allows you to enter
    +             a Uniform Resource Identifier (URI) to create a connection.  A URI is in the form:</para>
    +            <informalexample><replaceable>protocol</replaceable>://<replaceable>username</replaceable>
    --- End diff --
    
    Yep, the `<uri/>` tag.  I've added it in - should make it a little prettier.


---

[GitHub] guacamole-manual pull request #87: GUACAMOLE-38: Add chapter for Quickconnec...

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

    https://github.com/apache/guacamole-manual/pull/87#discussion_r202860705
  
    --- Diff: src/chapters/adhoc-connections.xml ---
    @@ -0,0 +1,118 @@
    +<?xml version="1.0" encoding="UTF-8"?>
    +
    +<chapter xml:id="adhoc-connections" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
    +    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">
    +    <title>Ad-hoc Connections</title>
    +    <indexterm>
    +        <primary>adhoc-connections</primary>
    +        <secondary>adhoc</secondary>
    +        <secondary>quickconnect</secondary>
    +    </indexterm>
    +    <para>The quickconnect extension provides a connection bar on the Guacamole Client home page
    +        that allows users to type in the URI of a server to which they want to connect and the client
    +        will parse the URI and immediately establish the connection.  The purpose of the extension is
    +        to allow situations where administrators want to allow users the flexibility of establishing
    +        their own connections without having to grant them access to edit connections or even to have
    +        to create the connections at all, aside from typing the URI.</para>
    +    <important>
    +        <para>There are several implications of using this extension that should be well-understood
    +            by administrators prior to implementing it:</para>
    +        <itemizedlist>
    +            <listitem><para>Connections established with this extension are created in-memory
    +                    and only persist until the user logs out or the browser is closed.</para></listitem>
    --- End diff --
    
    > ... or the browser is closed.
    
    Is this the case? I thought the connections persist in server-side memory, within the user's session, independently of whether the browser has been closed.


---

[GitHub] guacamole-manual pull request #87: GUACAMOLE-38: Add chapter for Quickconnec...

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

    https://github.com/apache/guacamole-manual/pull/87#discussion_r194235479
  
    --- Diff: src/chapters/quickconnect.xml ---
    @@ -0,0 +1,90 @@
    +<?xml version="1.0" encoding="UTF-8"?>
    +
    +<chapter xml:id="quickconnect" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
    +    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">
    +    <title>Quickconnect extension</title>
    --- End diff --
    
    Should the title represent more the high-level goal satisfied by the extension, rather than the extension itself? I don't have a suggestion for this off the top of my head, but from the perspective of a user browsing the table of contents for help, they presumably wouldn't know that the solution to their problem is the quickconnect extension until they read the chapter in question.
    
    This is the reasoning behind the existing chapters being named things like "Database authentication" rather than "JDBC extension", or "Proxying Guacamole" rather than "Apache and Nginx".


---

[GitHub] guacamole-manual pull request #87: GUACAMOLE-38: Add chapter for Quickconnec...

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

    https://github.com/apache/guacamole-manual/pull/87#discussion_r194235574
  
    --- Diff: src/chapters/quickconnect.xml ---
    @@ -0,0 +1,90 @@
    +<?xml version="1.0" encoding="UTF-8"?>
    +
    +<chapter xml:id="quickconnect" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
    +    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">
    +    <title>Quickconnect extension</title>
    +    <indexterm>
    +        <primary>quickconnect</primary>
    +    </indexterm>
    +    <para>The quickconnect extension provides a connection bar on the Guacamole Client home page
    +        that allows users to type in the URI of a server to which they want to connect and the client
    +        will parse the URI and immediately establish the connection.  The purpose of the extension is
    +        to allow situations where administrators want to allow users the flexibility of establishing
    +        their own connections without having to grant them access to edit connections or even to have
    +        to create the connections at all, aside from typing the URI.</para>
    +    <important>
    +        <para>Connections established with the quickconnect extension are create in-memory and only
    +            persist until the user logs out or the browser it closed.  As soon as the user's session
    +            is cleaned up, the connections are lost.  Furthermore, connections created/established
    +            with this module will not be visibile to other users - if connections need to be usable
    +            by multiple Guacamole users, please use one of the other modules (JDBC or LDAP).</para>
    +        <para>Also, while this extension is technically an authentication extension, it provides
    +            no facility for actually authenticating users - it will not allow anonymous logins,
    +            and relies on users being successfully authenticated and able to access the Guacamole
    +            Home page before it can be used.  This extension must be "stacked" with other modules
    +            that provide facilities for authenticating users.</para>
    +    </important>
    +    <section xml:id="quickconnect-downloading">
    +        <title>Downloading the quickconnect extension</title>
    +        <para>The quickconnect extension is available separately from the main
    +                <filename>guacamole.war</filename>. The link for this and all other
    +            officially-supported and compatible extensions for a particular version of Guacamole are
    +            provided in the release notes for that version. You can find the release notes for
    +            current versions of Guacamole here: <link
    +                xlink:href="http://guacamole.apache.org/releases/"
    +                >http://guacamole.apache.org/releases/</link>.</para>
    +        <para>The quickconnect extension is packaged as a <filename>.tar.gz</filename> file containing
    +            only the extension itself, <filename>guacamole-auth-quickconnect-0.9.14.jar</filename>, which must
    +            ultimately be placed in <filename>GUACAMOLE_HOME/extensions</filename>.</para>
    +    </section>
    +    <section xml:id="installing-quickconnect">
    +        <title>Installing the quickconnect extension</title>
    +        <para>Guacamole extensions are self-contained <filename>.jar</filename> files which are
    +            located within the <filename>GUACAMOLE_HOME/extensions</filename> directory.
    +                <emphasis>If you are unsure where <varname>GUACAMOLE_HOME</varname> is located on
    +                your system, please consult <xref linkend="configuring-guacamole"/> before
    +                proceeding.</emphasis></para>
    +        <para>To install the extension, you must:</para>
    +        <procedure>
    +            <step>
    +                <para>Create the <filename>GUACAMOLE_HOME/extensions</filename> directory, if it
    +                    does not already exist.</para>
    +            </step>
    +            <step>
    +                <para>Place the <filename>guacamole-auth-quickconnect-0.9.14.jar</filename> file in
    +                    the <filename>GUACAMOLE_HOME/extensions</filename> directory.</para>
    +            </step>
    +        </procedure>
    +        <section xml:id="guac-quickconnect-config">
    +            <title>Configuring Guacamole for the quickconnect extension</title>
    +            <indexterm>
    +                <primary>configuring quickconnect</primary>
    +            </indexterm>
    +            <para>This module has no configuration options.</para>
    +        </section>
    +        <section xml:id="completing-quickconnect-install">
    +            <title>Completing the installation</title>
    +            <para>Guacamole will only load newly-installed extensions during startup, so your
    +                servlet container will need to be restarted before the quickconnect extension
    +                can be used. <emphasis>Doing this will disconnect all active users, so be sure
    +                    that it is safe to do so prior to attempting installation.</emphasis>
    +                When ready, restart your servlet container and give the extension a try.</para>
    +        </section>
    +    </section>
    +    <section xml:id="using-quickconnect">
    +        <title>Using the quickconnect extension</title>
    +        <para>The quickconnect extension provides a field on the home page that allows you to enter
    +             a Uniform Resource Identifier (URI) to create a connection.  A URI is in the form:</para>
    +            <informalexample><replaceable>protocol</replaceable>://<replaceable>username</replaceable>
    +            :<replaceable>password</replaceable>@<replaceable>host</replaceable>:
    +            <replaceable>port</replaceable>/?<replaceable>options</replaceable></informalexample>
    --- End diff --
    
    The documentation for the supported protocols refers to these as "parameters", not "options". I suggest:
    
    * Consistently referencing the connection parameters as parameters
    * Providing a concrete example or set of examples which demonstrates the use of these parameters
    * Explaining, at least briefly, how multiple parameters are represented in the URI (`name1=value1&name2=value2&...`), as that may not be clear.


---

[GitHub] guacamole-manual pull request #87: GUACAMOLE-38: Add chapter for Quickconnec...

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

    https://github.com/apache/guacamole-manual/pull/87#discussion_r194235515
  
    --- Diff: src/chapters/quickconnect.xml ---
    @@ -0,0 +1,90 @@
    +<?xml version="1.0" encoding="UTF-8"?>
    +
    +<chapter xml:id="quickconnect" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
    +    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">
    +    <title>Quickconnect extension</title>
    +    <indexterm>
    +        <primary>quickconnect</primary>
    +    </indexterm>
    +    <para>The quickconnect extension provides a connection bar on the Guacamole Client home page
    +        that allows users to type in the URI of a server to which they want to connect and the client
    +        will parse the URI and immediately establish the connection.  The purpose of the extension is
    +        to allow situations where administrators want to allow users the flexibility of establishing
    +        their own connections without having to grant them access to edit connections or even to have
    +        to create the connections at all, aside from typing the URI.</para>
    +    <important>
    +        <para>Connections established with the quickconnect extension are create in-memory and only
    +            persist until the user logs out or the browser it closed.  As soon as the user's session
    +            is cleaned up, the connections are lost.  Furthermore, connections created/established
    +            with this module will not be visibile to other users - if connections need to be usable
    +            by multiple Guacamole users, please use one of the other modules (JDBC or LDAP).</para>
    +        <para>Also, while this extension is technically an authentication extension, it provides
    +            no facility for actually authenticating users - it will not allow anonymous logins,
    +            and relies on users being successfully authenticated and able to access the Guacamole
    +            Home page before it can be used.  This extension must be "stacked" with other modules
    +            that provide facilities for authenticating users.</para>
    +    </important>
    +    <section xml:id="quickconnect-downloading">
    +        <title>Downloading the quickconnect extension</title>
    +        <para>The quickconnect extension is available separately from the main
    +                <filename>guacamole.war</filename>. The link for this and all other
    +            officially-supported and compatible extensions for a particular version of Guacamole are
    +            provided in the release notes for that version. You can find the release notes for
    +            current versions of Guacamole here: <link
    +                xlink:href="http://guacamole.apache.org/releases/"
    +                >http://guacamole.apache.org/releases/</link>.</para>
    +        <para>The quickconnect extension is packaged as a <filename>.tar.gz</filename> file containing
    +            only the extension itself, <filename>guacamole-auth-quickconnect-0.9.14.jar</filename>, which must
    +            ultimately be placed in <filename>GUACAMOLE_HOME/extensions</filename>.</para>
    +    </section>
    +    <section xml:id="installing-quickconnect">
    +        <title>Installing the quickconnect extension</title>
    +        <para>Guacamole extensions are self-contained <filename>.jar</filename> files which are
    +            located within the <filename>GUACAMOLE_HOME/extensions</filename> directory.
    +                <emphasis>If you are unsure where <varname>GUACAMOLE_HOME</varname> is located on
    +                your system, please consult <xref linkend="configuring-guacamole"/> before
    +                proceeding.</emphasis></para>
    +        <para>To install the extension, you must:</para>
    +        <procedure>
    +            <step>
    +                <para>Create the <filename>GUACAMOLE_HOME/extensions</filename> directory, if it
    +                    does not already exist.</para>
    +            </step>
    +            <step>
    +                <para>Place the <filename>guacamole-auth-quickconnect-0.9.14.jar</filename> file in
    +                    the <filename>GUACAMOLE_HOME/extensions</filename> directory.</para>
    +            </step>
    +        </procedure>
    +        <section xml:id="guac-quickconnect-config">
    +            <title>Configuring Guacamole for the quickconnect extension</title>
    +            <indexterm>
    +                <primary>configuring quickconnect</primary>
    +            </indexterm>
    +            <para>This module has no configuration options.</para>
    +        </section>
    +        <section xml:id="completing-quickconnect-install">
    +            <title>Completing the installation</title>
    +            <para>Guacamole will only load newly-installed extensions during startup, so your
    +                servlet container will need to be restarted before the quickconnect extension
    +                can be used. <emphasis>Doing this will disconnect all active users, so be sure
    +                    that it is safe to do so prior to attempting installation.</emphasis>
    +                When ready, restart your servlet container and give the extension a try.</para>
    +        </section>
    +    </section>
    +    <section xml:id="using-quickconnect">
    +        <title>Using the quickconnect extension</title>
    +        <para>The quickconnect extension provides a field on the home page that allows you to enter
    +             a Uniform Resource Identifier (URI) to create a connection.  A URI is in the form:</para>
    +            <informalexample><replaceable>protocol</replaceable>://<replaceable>username</replaceable>
    --- End diff --
    
    There should be a Docbook tag which represents the semantics of a URI which can be nested within `<informalexample>`. Currently, this is simply normal paragraph text.


---

[GitHub] guacamole-manual pull request #87: GUACAMOLE-38: Add chapter for Quickconnec...

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

    https://github.com/apache/guacamole-manual/pull/87#discussion_r194428065
  
    --- Diff: src/chapters/quickconnect.xml ---
    @@ -0,0 +1,90 @@
    +<?xml version="1.0" encoding="UTF-8"?>
    +
    +<chapter xml:id="quickconnect" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
    +    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">
    +    <title>Quickconnect extension</title>
    +    <indexterm>
    +        <primary>quickconnect</primary>
    +    </indexterm>
    +    <para>The quickconnect extension provides a connection bar on the Guacamole Client home page
    +        that allows users to type in the URI of a server to which they want to connect and the client
    +        will parse the URI and immediately establish the connection.  The purpose of the extension is
    +        to allow situations where administrators want to allow users the flexibility of establishing
    +        their own connections without having to grant them access to edit connections or even to have
    +        to create the connections at all, aside from typing the URI.</para>
    +    <important>
    +        <para>Connections established with the quickconnect extension are create in-memory and only
    +            persist until the user logs out or the browser it closed.  As soon as the user's session
    +            is cleaned up, the connections are lost.  Furthermore, connections created/established
    +            with this module will not be visibile to other users - if connections need to be usable
    +            by multiple Guacamole users, please use one of the other modules (JDBC or LDAP).</para>
    +        <para>Also, while this extension is technically an authentication extension, it provides
    +            no facility for actually authenticating users - it will not allow anonymous logins,
    +            and relies on users being successfully authenticated and able to access the Guacamole
    +            Home page before it can be used.  This extension must be "stacked" with other modules
    +            that provide facilities for authenticating users.</para>
    +    </important>
    +    <section xml:id="quickconnect-downloading">
    +        <title>Downloading the quickconnect extension</title>
    +        <para>The quickconnect extension is available separately from the main
    +                <filename>guacamole.war</filename>. The link for this and all other
    +            officially-supported and compatible extensions for a particular version of Guacamole are
    +            provided in the release notes for that version. You can find the release notes for
    +            current versions of Guacamole here: <link
    +                xlink:href="http://guacamole.apache.org/releases/"
    +                >http://guacamole.apache.org/releases/</link>.</para>
    +        <para>The quickconnect extension is packaged as a <filename>.tar.gz</filename> file containing
    +            only the extension itself, <filename>guacamole-auth-quickconnect-0.9.14.jar</filename>, which must
    +            ultimately be placed in <filename>GUACAMOLE_HOME/extensions</filename>.</para>
    +    </section>
    +    <section xml:id="installing-quickconnect">
    +        <title>Installing the quickconnect extension</title>
    +        <para>Guacamole extensions are self-contained <filename>.jar</filename> files which are
    +            located within the <filename>GUACAMOLE_HOME/extensions</filename> directory.
    +                <emphasis>If you are unsure where <varname>GUACAMOLE_HOME</varname> is located on
    +                your system, please consult <xref linkend="configuring-guacamole"/> before
    +                proceeding.</emphasis></para>
    +        <para>To install the extension, you must:</para>
    +        <procedure>
    +            <step>
    +                <para>Create the <filename>GUACAMOLE_HOME/extensions</filename> directory, if it
    +                    does not already exist.</para>
    +            </step>
    +            <step>
    +                <para>Place the <filename>guacamole-auth-quickconnect-0.9.14.jar</filename> file in
    +                    the <filename>GUACAMOLE_HOME/extensions</filename> directory.</para>
    +            </step>
    +        </procedure>
    +        <section xml:id="guac-quickconnect-config">
    +            <title>Configuring Guacamole for the quickconnect extension</title>
    +            <indexterm>
    +                <primary>configuring quickconnect</primary>
    +            </indexterm>
    +            <para>This module has no configuration options.</para>
    +        </section>
    +        <section xml:id="completing-quickconnect-install">
    +            <title>Completing the installation</title>
    +            <para>Guacamole will only load newly-installed extensions during startup, so your
    +                servlet container will need to be restarted before the quickconnect extension
    +                can be used. <emphasis>Doing this will disconnect all active users, so be sure
    +                    that it is safe to do so prior to attempting installation.</emphasis>
    +                When ready, restart your servlet container and give the extension a try.</para>
    +        </section>
    +    </section>
    +    <section xml:id="using-quickconnect">
    +        <title>Using the quickconnect extension</title>
    +        <para>The quickconnect extension provides a field on the home page that allows you to enter
    +             a Uniform Resource Identifier (URI) to create a connection.  A URI is in the form:</para>
    +            <informalexample><replaceable>protocol</replaceable>://<replaceable>username</replaceable>
    +            :<replaceable>password</replaceable>@<replaceable>host</replaceable>:
    +            <replaceable>port</replaceable>/?<replaceable>options</replaceable></informalexample>
    --- End diff --
    
    Okay, I changed all of the appropriate references to parameters to use parameter instead of option, so that should be good.  Also provided three examples of URIs, including a RDP one with several parameters specified in the URI.


---

[GitHub] guacamole-manual pull request #87: GUACAMOLE-38: Add chapter for Quickconnec...

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

    https://github.com/apache/guacamole-manual/pull/87


---

[GitHub] guacamole-manual pull request #87: GUACAMOLE-38: Add chapter for Quickconnec...

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

    https://github.com/apache/guacamole-manual/pull/87#discussion_r203091536
  
    --- Diff: src/chapters/adhoc-connections.xml ---
    @@ -0,0 +1,118 @@
    +<?xml version="1.0" encoding="UTF-8"?>
    +
    +<chapter xml:id="adhoc-connections" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
    +    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">
    +    <title>Ad-hoc Connections</title>
    +    <indexterm>
    +        <primary>adhoc-connections</primary>
    +        <secondary>adhoc</secondary>
    +        <secondary>quickconnect</secondary>
    +    </indexterm>
    +    <para>The quickconnect extension provides a connection bar on the Guacamole Client home page
    +        that allows users to type in the URI of a server to which they want to connect and the client
    +        will parse the URI and immediately establish the connection.  The purpose of the extension is
    +        to allow situations where administrators want to allow users the flexibility of establishing
    +        their own connections without having to grant them access to edit connections or even to have
    +        to create the connections at all, aside from typing the URI.</para>
    +    <important>
    +        <para>There are several implications of using this extension that should be well-understood
    +            by administrators prior to implementing it:</para>
    +        <itemizedlist>
    +            <listitem><para>Connections established with this extension are created in-memory
    +                    and only persist until the user logs out or the browser is closed.</para></listitem>
    --- End diff --
    
    Modified that a little.


---