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 <nick.couch...@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>