You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@guacamole.apache.org by mj...@apache.org on 2017/06/25 21:23:25 UTC

[1/5] incubator-guacamole-manual git commit: GUACAMOLE-203: Add documentation for keepalive parameters for SFTP.

Repository: incubator-guacamole-manual
Updated Branches:
  refs/heads/master 3219a3f9e -> 344b3e8d3


GUACAMOLE-203: Add documentation for keepalive parameters for SFTP.


Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/commit/ae4dcccc
Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/tree/ae4dcccc
Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/diff/ae4dcccc

Branch: refs/heads/master
Commit: ae4dcccc447cf5d4ff44d1c9fb9446fd111f984b
Parents: eec6143
Author: Nick Couchman <vn...@apache.org>
Authored: Sun Jun 25 14:21:56 2017 -0400
Committer: Nick Couchman <vn...@apache.org>
Committed: Sun Jun 25 14:24:20 2017 -0400

----------------------------------------------------------------------
 src/chapters/configuring.xml | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/ae4dcccc/src/chapters/configuring.xml
----------------------------------------------------------------------
diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml
index 4ada376..ee30a27 100644
--- a/src/chapters/configuring.xml
+++ b/src/chapters/configuring.xml
@@ -827,6 +827,17 @@ guacd-port:     4822</programlisting>
                                         will be used.</para>
                                 </entry>
                             </row>
+                            <row>
+                                <entry><parameter>sftp-server-alive-interval</parameter></entry>
+                                <entry>
+                                    <para>The interval 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.  A value of 1 will be rounded up to 2.
+                                    Negative values are changed to 0, disabling sending keepalives.
+                                    </para>
+                                </entry>
+                            </row>
                         </tbody>
                     </tgroup>
                 </informaltable>
@@ -2311,6 +2322,17 @@ ed272546-87bd-4db9-acba-e36e1a9ca20a
                                         will be used.</para>
                                 </entry>
                             </row>
+                            <row>
+                                <entry><parameter>sftp-server-alive-interval</parameter></entry>
+                                <entry>
+                                    <para>The interval 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.  A value of 1 will be rounded up to 2.
+                                    Negative values are changed to 0, disabling sending keepalives.
+                                    </para>
+                                </entry>
+                            </row>
                         </tbody>
                     </tgroup>
                 </informaltable>
@@ -2785,7 +2807,8 @@ ed272546-87bd-4db9-acba-e36e1a9ca20a
                                         the interval (in seconds) at which the client connection
                                         sends keepalive packets to the server.  The default is 0,
                                         which disables sending the packets.  A value of 1 is
-                                        automatically increased to 2 by libssh2.
+                                        automatically increased to 2.  Negative values are set to
+                                        0, disabling sending keepalives.
                                     </para>
                                 </entry>
                             </row>


[3/5] incubator-guacamole-manual git commit: GUACMAOLE-203: Remove unnecesary ssh-environment section and move keepalive to network section.

Posted by mj...@apache.org.
GUACMAOLE-203: Remove unnecesary ssh-environment section and move keepalive to network section.


Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/commit/dc2b19d8
Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/tree/dc2b19d8
Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/diff/dc2b19d8

Branch: refs/heads/master
Commit: dc2b19d88e8c45197f16cd44b5db37fba13a3b96
Parents: ae4dccc
Author: Nick Couchman <vn...@apache.org>
Authored: Sun Jun 25 16:57:17 2017 -0400
Committer: Nick Couchman <ni...@yahoo.com>
Committed: Sun Jun 25 16:58:24 2017 -0400

----------------------------------------------------------------------
 src/chapters/configuring.xml | 52 +++++++++++++++++++--------------------
 1 file changed, 26 insertions(+), 26 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/dc2b19d8/src/chapters/configuring.xml
----------------------------------------------------------------------
diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml
index ee30a27..fa87774 100644
--- a/src/chapters/configuring.xml
+++ b/src/chapters/configuring.xml
@@ -2587,6 +2587,24 @@ ed272546-87bd-4db9-acba-e36e1a9ca20a
                                         the default of 22 will be used.</para>
                                 </entry>
                             </row>
+                            <row>
+                                <entry><parameter>server-alive-interval</parameter></entry>
+                                <entry>
+                                    <para>
+                                        <indexterm>
+                                            <primary>SSH</primary>
+                                            <secondary>server-alive-interval</secondary>
+                                        </indexterm>
+                                        By default the SSH client does not send keepalive requests
+                                        to the server.  This parameter allows you to configure the
+                                        the interval (in seconds) at which the client connection
+                                        sends keepalive packets to the server.  The default is 0,
+                                        which disables sending the packets.  A value of 1 is
+                                        automatically increased to 2.  Negative values are set to
+                                        0, disabling sending keepalives.
+                                    </para>
+                                </entry>
+                            </row>
                         </tbody>
                     </tgroup>
                 </informaltable>
@@ -2760,14 +2778,14 @@ ed272546-87bd-4db9-acba-e36e1a9ca20a
                     </tgroup>
                 </informaltable>
             </section>
-            <section xml:id="ssh-environment">
-                <title>SSH Environment Settings</title>
-                <para>The following parameters allow you to adjust the environment used by the
-                    Guacamole SSH client.  Currently only two parameters are supported, allowing
-                    you to adjust the command executed during login (the defualt is to launch the
-                    user's shell) and change whether or not the SSH client sends keepalive packets
-                    to the server to prevent idle sessions from being automatically disconnected.
-                </para>
+            <section xml:id="ssh-command">
+                <title>Running a command (instead of a shell)</title>
+                <para>By default, SSH sessions will start an interactive shell. The shell which will
+                    be used is determined by the SSH server, normally by reading the user's default
+                    shell previously set with <command>chsh</command> or within
+                        <filename>/etc/passwd</filename>. If you wish to override this and instead
+                    run a specific command, you can do so by specifying that command in the
+                    configuration of the Guacamole SSH connection.</para>
                 <informaltable frame="all">
                     <indexterm>
                         <primary>parameters</primary>
@@ -2794,24 +2812,6 @@ ed272546-87bd-4db9-acba-e36e1a9ca20a
                                         session will use the user's default shell.</para>
                                 </entry>
                             </row>
-                            <row>
-                                <entry><parameter>server-alive-interval</parameter></entry>
-                                <entry>
-                                    <para>
-                                        <indexterm>
-                                            <primary>SSH</primary>
-                                            <secondary>server-alive-interval</secondary>
-                                        </indexterm>
-                                        By default the SSH client does not send keepalive requests
-                                        to the server.  This parameter allows you to configure the
-                                        the interval (in seconds) at which the client connection
-                                        sends keepalive packets to the server.  The default is 0,
-                                        which disables sending the packets.  A value of 1 is
-                                        automatically increased to 2.  Negative values are set to
-                                        0, disabling sending keepalives.
-                                    </para>
-                                </entry>
-                            </row>
                         </tbody>
                     </tgroup>
                 </informaltable>


[5/5] incubator-guacamole-manual git commit: GUACAMOLE-203: Merge documentation for SSH/SFTP keep-alive parameters.

Posted by mj...@apache.org.
GUACAMOLE-203: Merge documentation for SSH/SFTP keep-alive parameters.


Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/commit/344b3e8d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/tree/344b3e8d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/diff/344b3e8d

Branch: refs/heads/master
Commit: 344b3e8d37b8f5faf63592657dd0ae8df35e2e64
Parents: 3219a3f 83d504e
Author: Michael Jumper <mj...@apache.org>
Authored: Sun Jun 25 14:22:09 2017 -0700
Committer: Michael Jumper <mj...@apache.org>
Committed: Sun Jun 25 14:22:09 2017 -0700

----------------------------------------------------------------------
 src/chapters/configuring.xml | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
----------------------------------------------------------------------



[2/5] incubator-guacamole-manual git commit: GUACAMOLE-203: Update SSH documentation to include keepalive interval.

Posted by mj...@apache.org.
GUACAMOLE-203: Update SSH documentation to include keepalive interval.


Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/commit/eec61431
Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/tree/eec61431
Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/diff/eec61431

Branch: refs/heads/master
Commit: eec61431b01f1a6e3ca1ec2df09070211812ae9d
Parents: 3219a3f
Author: Nick Couchman <vn...@apache.org>
Authored: Wed May 31 09:22:30 2017 -0400
Committer: Nick Couchman <vn...@apache.org>
Committed: Sun Jun 25 14:24:20 2017 -0400

----------------------------------------------------------------------
 src/chapters/configuring.xml | 33 +++++++++++++++++++++++++--------
 1 file changed, 25 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/eec61431/src/chapters/configuring.xml
----------------------------------------------------------------------
diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml
index d247f31..4ada376 100644
--- a/src/chapters/configuring.xml
+++ b/src/chapters/configuring.xml
@@ -2738,14 +2738,14 @@ ed272546-87bd-4db9-acba-e36e1a9ca20a
                     </tgroup>
                 </informaltable>
             </section>
-            <section xml:id="ssh-command">
-                <title>Running a command (instead of a shell)</title>
-                <para>By default, SSH sessions will start an interactive shell. The shell which will
-                    be used is determined by the SSH server, normally by reading the user's default
-                    shell previously set with <command>chsh</command> or within
-                        <filename>/etc/passwd</filename>. If you wish to override this and instead
-                    run a specific command, you can do so by specifying that command in the
-                    configuration of the Guacamole SSH connection.</para>
+            <section xml:id="ssh-environment">
+                <title>SSH Environment Settings</title>
+                <para>The following parameters allow you to adjust the environment used by the
+                    Guacamole SSH client.  Currently only two parameters are supported, allowing
+                    you to adjust the command executed during login (the defualt is to launch the
+                    user's shell) and change whether or not the SSH client sends keepalive packets
+                    to the server to prevent idle sessions from being automatically disconnected.
+                </para>
                 <informaltable frame="all">
                     <indexterm>
                         <primary>parameters</primary>
@@ -2772,6 +2772,23 @@ ed272546-87bd-4db9-acba-e36e1a9ca20a
                                         session will use the user's default shell.</para>
                                 </entry>
                             </row>
+                            <row>
+                                <entry><parameter>server-alive-interval</parameter></entry>
+                                <entry>
+                                    <para>
+                                        <indexterm>
+                                            <primary>SSH</primary>
+                                            <secondary>server-alive-interval</secondary>
+                                        </indexterm>
+                                        By default the SSH client does not send keepalive requests
+                                        to the server.  This parameter allows you to configure the
+                                        the interval (in seconds) at which the client connection
+                                        sends keepalive packets to the server.  The default is 0,
+                                        which disables sending the packets.  A value of 1 is
+                                        automatically increased to 2 by libssh2.
+                                    </para>
+                                </entry>
+                            </row>
                         </tbody>
                     </tgroup>
                 </informaltable>


[4/5] incubator-guacamole-manual git commit: GUACAMOLE-203: Clean up wording for acceptable values for server alive interval.

Posted by mj...@apache.org.
GUACAMOLE-203: Clean up wording for acceptable values for server alive interval.


Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/commit/83d504e6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/tree/83d504e6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/diff/83d504e6

Branch: refs/heads/master
Commit: 83d504e68db5bc88d77295e7a91e71afa650adff
Parents: dc2b19d
Author: Nick Couchman <vn...@apache.org>
Authored: Sun Jun 25 17:08:01 2017 -0400
Committer: Nick Couchman <vn...@apache.org>
Committed: Sun Jun 25 17:08:01 2017 -0400

----------------------------------------------------------------------
 src/chapters/configuring.xml | 27 +++++++++++++--------------
 1 file changed, 13 insertions(+), 14 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/83d504e6/src/chapters/configuring.xml
----------------------------------------------------------------------
diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml
index fa87774..7073a43 100644
--- a/src/chapters/configuring.xml
+++ b/src/chapters/configuring.xml
@@ -830,11 +830,11 @@ guacd-port:     4822</programlisting>
                             <row>
                                 <entry><parameter>sftp-server-alive-interval</parameter></entry>
                                 <entry>
-                                    <para>The interval 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.  A value of 1 will be rounded up to 2.
-                                    Negative values are changed to 0, disabling sending keepalives.
+                                    <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>
                             </row>
@@ -2325,11 +2325,11 @@ ed272546-87bd-4db9-acba-e36e1a9ca20a
                             <row>
                                 <entry><parameter>sftp-server-alive-interval</parameter></entry>
                                 <entry>
-                                    <para>The interval 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.  A value of 1 will be rounded up to 2.
-                                    Negative values are changed to 0, disabling sending keepalives.
+                                    <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>
                             </row>
@@ -2597,11 +2597,10 @@ ed272546-87bd-4db9-acba-e36e1a9ca20a
                                         </indexterm>
                                         By default the SSH client does not send keepalive requests
                                         to the server.  This parameter allows you to configure the
-                                        the interval (in seconds) at which the client connection
+                                        the interval in seconds at which the client connection
                                         sends keepalive packets to the server.  The default is 0,
-                                        which disables sending the packets.  A value of 1 is
-                                        automatically increased to 2.  Negative values are set to
-                                        0, disabling sending keepalives.
+                                        which disables sending the packets.  The minimum value
+                                        is 2.
                                     </para>
                                 </entry>
                             </row>