# HG changeset patch # User Marcin Kuzminski # Date 2018-01-16 23:32:34 # Node ID 0874da14e11baf94d8dbcbe933e0973432cd7473 # Parent dacca1fe5d2913be6276ca808530f5269bf12f92 ssh: update docs based on feedback. diff --git a/docs/auth/ssh-connection.rst b/docs/auth/ssh-connection.rst --- a/docs/auth/ssh-connection.rst +++ b/docs/auth/ssh-connection.rst @@ -64,7 +64,7 @@ 2. Enable the SSH module on instance. ssh.wrapper_cmd_allow_shell = false ## Enables logging, and detailed output send back to the client during SSH - ## operations. Usefull for debugging, shouldn't be used in production. + ## operations. Useful for debugging, shouldn't be used in production. ssh.enable_debug_logging = false ## Paths to binary executable, by default they are the names, but we can @@ -111,20 +111,22 @@ 4. Add the public key to your user accou Then add, remove your SSH key and try connecting again. Debug logging will be printed to help find the problems on the server side. - Test connection using the ssh command from the local machine + Test connection using the ssh command from the local machine. Make sure + to use the use who is running the |RCE| server, and not your username from + the web interface. For SVN: .. code-block:: bash - SVN_SSH="ssh -i ~/.ssh/id_rsa_test_ssh" svn checkout svn+ssh://rhodecode@rc-server/repo_name + SVN_SSH="ssh -i ~/.ssh/id_rsa_test_ssh_private.key" svn checkout svn+ssh://rhodecode@rc-server/repo_name For GIT: .. code-block:: bash - GIT_SSH_COMMAND='ssh -i ~/.ssh/id_rsa_test_ssh' git clone ssh://rhodecode@rc-server/repo_name + GIT_SSH_COMMAND='ssh -i ~/.ssh/id_rsa_test_ssh_private.key' git clone ssh://rhodecode@rc-server/repo_name For Mercurial: @@ -133,6 +135,6 @@ 4. Add the public key to your user accou Add to hgrc: [ui] - ssh = ssh -C -i ~/.ssh/id_rsa_test_ssh + ssh = ssh -C -i ~/.ssh/id_rsa_test_ssh_private.key hg clone ssh://rhodecode@rc-server/repo_name diff --git a/rhodecode/templates/admin/users/user_edit_ssh_keys_generate.mako b/rhodecode/templates/admin/users/user_edit_ssh_keys_generate.mako --- a/rhodecode/templates/admin/users/user_edit_ssh_keys_generate.mako +++ b/rhodecode/templates/admin/users/user_edit_ssh_keys_generate.mako @@ -9,9 +9,12 @@

${_('Private key')}

 # Save the content as
-~/.ssh/id_rsa_rhodecode_access_priv.key
-# Change permissions
-chmod 0600 ~/.ssh/id_rsa_rhodecode_access_priv.key
+# Windows: /Users//.ssh/id_rsa_rhodecode_access_priv.key
+# macOS: /Users//.ssh/id_rsa_rhodecode_access_priv.key
+# Linux: /home//.ssh/id_rsa_rhodecode_access_priv.key
+
+# Change permissions to 0600 to make it secure, and usable.
+e.g chmod 0600 /home//.ssh/id_rsa_rhodecode_access_priv.key
         
@@ -19,13 +22,12 @@ chmod 0600 ~/.ssh/id_rsa_rhodecode_acces

-

${_('Public key')}

 # Save the content as
-~/.ssh/id_rsa_rhodecode_access_pub.key
-# Change permissions
-chmod 0600 ~/.ssh/id_rsa_rhodecode_access_pub.key
+# Windows: /Users//.ssh/id_rsa_rhodecode_access_pub.key
+# macOS: /Users//.ssh/id_rsa_rhodecode_access_pub.key
+# Linux: /home//.ssh/id_rsa_rhodecode_access_pub.key