From d1ca8b89596a0ef64ca803128e08fd8a5958bf4b Mon Sep 17 00:00:00 2001 From: "Michael G. Noll" Date: Fri, 20 Apr 2018 21:49:49 +0200 Subject: [PATCH] sftp: update docs to match code, fix typos and clarify disable_hashcheck prompt --- backend/sftp/sftp.go | 4 ++-- docs/content/sftp.md | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/backend/sftp/sftp.go b/backend/sftp/sftp.go index c00736035..8e1537455 100644 --- a/backend/sftp/sftp.go +++ b/backend/sftp/sftp.go @@ -74,7 +74,7 @@ func init() { Optional: true, }, { Name: "use_insecure_cipher", - Help: "Enable the user of the aes128-cbc cipher. This cipher is insecure and may allow plaintext data to be recovered by an attacker..", + Help: "Enable the user of the aes128-cbc cipher. This cipher is insecure and may allow plaintext data to be recovered by an attacker.", Optional: true, Examples: []fs.OptionExample{ { @@ -87,7 +87,7 @@ func init() { }, }, { Name: "disable_hashcheck", - Help: "Disable the exectution of SSH commands to determine if remote file hashing is available, leave blank unless you know what you are doing.", + Help: "Disable the execution of SSH commands to determine if remote file hashing is available. Leave blank or set to false to enable hashing (recommended), set to true to disable hashing.", Optional: true, }}, } diff --git a/docs/content/sftp.md b/docs/content/sftp.md index fa79f2ae2..270e9ef94 100644 --- a/docs/content/sftp.md +++ b/docs/content/sftp.md @@ -167,10 +167,11 @@ your RClone backend configuration to disable this behaviour. SFTP supports checksums if the same login has shell access and `md5sum` or `sha1sum` as well as `echo` are in the remote's PATH. -This remote check can be disabled by setting the configuration option -`disable_hashcheck`. This may be required if you're connecting to SFTP servers +This remote checksumming (file hashing) is recommended and enabled by default. +Disabling the checksumming may be required if you are connecting to SFTP servers which are not under your control, and to which the execution of remote commands -is prohibited. +is prohibited. Set the configuration option `disable_hashcheck` to `true` to +disable checksumming. The only ssh agent supported under Windows is Putty's pageant.