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:26 UTC

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

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>