[deployment-guide/comm-rel: 8/23] Updated the Configuring ssh-agent section.

dsilas dsilas at fedoraproject.org
Sun Jul 18 15:52:58 UTC 2010


commit 6f582820ec52261432d81a51a92fdf70f7ff5de7
Author: Jaromir Hradilek <jhradile at redhat.com>
Date:   Fri Jul 16 13:21:18 2010 +0200

    Updated the Configuring ssh-agent section.

 en-US/OpenSSH.xml |  113 ++++++++++++++++++++--------------------------------
 1 files changed, 44 insertions(+), 69 deletions(-)
---
diff --git a/en-US/OpenSSH.xml b/en-US/OpenSSH.xml
index 72a2ea9..d50ec7d 100644
--- a/en-US/OpenSSH.xml
+++ b/en-US/OpenSSH.xml
@@ -806,98 +806,73 @@ The key's randomart image is:
       </section>
       <section id="s3-ssh-configuration-keypairs-agent">
         <title>Configuring <command>ssh-agent</command></title>
-        <para>
-          Hic sunt leones.
-        </para>
-      </section>
-      <section id="s3-openssh-ssh-agent-with-gnome">
-        <title>Configuring <command>ssh-agent</command> with a GUI</title>
         <indexterm>
           <primary>OpenSSH</primary>
           <secondary>
             <command>ssh-agent</command>
           </secondary>
-          <tertiary>with GNOME</tertiary>
         </indexterm>
         <indexterm>
           <primary>
             <command>ssh-agent</command>
           </primary>
-          <secondary>with GNOME</secondary>
         </indexterm>
         <para>
-          The <command>ssh-agent</command> utility can be used to save your passphrase so that you do not have to enter it each time you initiate an <command>ssh</command> or <command>scp</command> connection. If you are using GNOME, the <command>gnome-ssh-askpass</command> package contains the application used to prompt you for your passphrase when you log in to GNOME and save it until you log out of GNOME. You will not have to enter your password or passphrase for any <command>ssh</command> or <command>scp</command> connection made during that GNOME session. If you are not using GNOME, refer to <xref linkend="s3-openssh-config-ssh-agent" />.
+          To store your passphrase so that you do not have to enter it each time you initiate a connection with a remote machine, you can use the <command>ssh-agent</command> authentication agent. If you are running GNOME, you can configure it to prompt you for your passphrase whenever you log in and remember it during the whole session. Otherwise you can store the passphrase for a certain shell prompt.
         </para>
         <para>
-          To save your passphrase during your GNOME session, follow the following steps:
+          To save your passphrase during your GNOME session, follow these steps:
         </para>
-        <orderedlist continuation="restarts" inheritnum="ignore">
-          <listitem>
-            <para>
-              You will need to have the package <filename>gnome-ssh-askpass</filename> installed; you can use the command <command>rpm -q openssh-askpass</command> to determine if it is installed or not. If it is not installed, install it from your &MAJOROS; CD-ROM set, from a Red Hat FTP mirror site, or using Red Hat Network.
-            </para>
-          </listitem>
-          <listitem>
-            <para>
-              Select <guimenu>Main Menu Button</guimenu> (on the Panel) &gt; <guimenuitem>Preferences</guimenuitem> &gt; <guimenuitem>More Preferences</guimenuitem> &gt; <guilabel>Sessions</guilabel>, and click on the <guilabel>Startup Programs</guilabel> tab. Click <guibutton>Add</guibutton> and enter <userinput>/usr/bin/ssh-add</userinput> in the <guilabel>Startup Command</guilabel> text area. Set it a priority to a number higher than any existing commands to ensure that it is executed last. A good priority number for <command>ssh-add</command> is 70 or higher. The higher the priority number, the lower the priority. If you have other programs listed, this one should have the lowest priority. Click <guibutton>Close</guibutton> to exit the program.
-            </para>
-          </listitem>
-          <listitem>
+        <procedure>
+          <step>
             <para>
-              Log out and then log back into GNOME; in other words, restart X. After GNOME is started, a dialog box will appear prompting you for your passphrase(s). Enter the passphrase requested. If you have both DSA and RSA key pairs configured, you will be prompted for both. From this point on, you should not be prompted for a password by <command>ssh</command>, <command>scp</command>, or <command>sftp</command>.
+              Make sure you have the <package>openssh-askpass</package> package installed. If not, refer to <xref linkend="sec-Installing" /> for more information on how to install new packages in &MAJOROS;.
             </para>
-          </listitem>
-        </orderedlist>
-      </section>
-      <section id="s3-openssh-config-ssh-agent">
-        <title>Configuring <command>ssh-agent</command></title>
-        <indexterm>
-          <primary>OpenSSH</primary>
-          <secondary>
-            <command>ssh-agent</command>
-          </secondary>
-        </indexterm>
-        <indexterm>
-          <primary>
-            <command>ssh-agent</command>
-          </primary>
-        </indexterm>
-        <para>
-          The <command>ssh-agent</command> can be used to store your passphrase so that you do not have to enter it each time you make a <command>ssh</command> or <command>scp</command> connection. If you are not running the X Window System, follow these steps from a shell prompt. If you are running GNOME but you do not want to configure it to prompt you for your passphrase when you log in (refer to <xref linkend="s3-openssh-ssh-agent-with-gnome" />), this procedure will work in a terminal window, such as an XTerm. If you are running X but not GNOME, this procedure will work in a terminal window. However, your passphrase will only be remembered for that terminal window; it is not a global setting.
-        </para>
-        <indexterm>
-          <primary>OpenSSH</primary>
-          <secondary>
-            <command>ssh-add</command>
-          </secondary>
-        </indexterm>
-        <indexterm>
-          <primary>
-            <command>ssh-add</command>
-          </primary>
-        </indexterm>
-        <orderedlist continuation="restarts" inheritnum="ignore">
-          <listitem id="nox">
+          </step>
+          <step>
             <para>
-              At a shell prompt, type the following command:
+              Select <menuchoice><guimenu>System</guimenu><guisubmenu>Preferences</guisubmenu><guimenuitem>Startup Applications</guimenuitem></menuchoice> from the panel. The <application>Startup Applications Preferences</application> will be started, and the tab containing a list of available startup programs will be shown by default. 
             </para>
-            <screen>exec /usr/bin/ssh-agent $SHELL</screen>
-          </listitem>
-          <listitem>
+            <!-- TODO: Add screenshot. -->
+          </step>
+          <step>
+            <indexterm>
+              <primary>OpenSSH</primary>
+              <secondary>
+                <command>ssh-add</command>
+              </secondary>
+            </indexterm>
+            <indexterm>
+              <primary>
+                <command>ssh-add</command>
+              </primary>
+            </indexterm>
             <para>
-              Then type the command:
+              Click the <guibutton>Add</guibutton> button on the left, and enter <userinput>/usr/bin/ssh-add</userinput> in the <guilabel>Command</guilabel> field.
             </para>
-            <screen>ssh-add</screen>
+            <!-- TODO: Add screenshot. -->
+          </step>
+          <step>
             <para>
-              and enter your passphrase(s). If you have more than one key pair configured, you will be prompted for each one.
+              Click <guibutton>Add</guibutton> and make sure the checkbox next to the newly added item is selected.
             </para>
-          </listitem>
-          <listitem>
+            <!-- TODO: Add screenshot. -->
+          </step>
+          <step>
             <para>
-              When you log out, your passphrase(s) will be forgotten. You must execute these two commands each time you log in to a virtual console or open a terminal window.
+              Log out and then log back in. A dialog box will appear prompting you for your passphrase. From this point on, you should not be prompted for a password by <command>ssh</command>, <command>scp</command>, or <command>sftp</command>.
             </para>
-          </listitem>
-        </orderedlist>
+            <!-- TODO: Add screenshot. -->
+          </step>
+        </procedure>
+        <para>
+          To save your passphrase for a certain shell prompt, use the following command:
+        </para>
+        <screen>~]$ <command>ssh-add</command>
+Enter passphrase for /home/john/.ssh/id_rsa:</screen>
+        <para>
+          Note that when you log out, your passphrase will be forgotten. You must execute the command each time you log in to a virtual console or a terminal window.
+        </para>
       </section>
     </section>
   </section>


More information about the docs-commits mailing list