go/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-07-16 22:42:36 +02:00
Code Issues Releases Activity

Version v1.60.0

Browse Source
This commit is contained in:
Nick Craig-Wood
2022-10-21 15:06:08 +01:00
parent afa61e702c
commit 01dbbff62e
34 changed files with 9667 additions and 2000 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/content/commands/rclone_serve_sftp.md
View File

@ -11,11 +11,19 @@ Serve the remote over SFTP.
## Synopsis
Run a SFTP server to serve a remote over SFTP. This can be used
with an SFTP client or you can make a remote of type sftp to use with it.
Run an SFTP server to serve a remote over SFTP. This can be used
with an SFTP client or you can make a remote of type [sftp](/sftp) to use with it.
You can use the filter flags (e.g. `--include`, `--exclude`) to control what
is served.
You can use the [filter](/filtering) flags (e.g. `--include`, `--exclude`)
to control what is served.
The server will respond to a small number of shell commands, mainly
md5sum, sha1sum and df, which enable it to provide support for checksums
and the about feature when accessed from an sftp remote.
Note that this server uses standard 32 KiB packet payload size, which
means you must not configure the client to expect anything else, e.g.
with the [chunk_size](/sftp/#sftp-chunk-size) option on an sftp remote.
The server will log errors. Use `-v` to see access logs.
@ -28,11 +36,6 @@ You must provide some means of authentication, either with
`--auth-proxy`, or set the `--no-auth` flag for no
authentication when logging in.
Note that this also implements a small number of shell commands so
that it can provide md5sum/sha1sum/df information for the rclone sftp
backend. This means that is can support SHA1SUMs, MD5SUMs and the
about command when paired with the rclone sftp backend.
If you don't supply a host `--key` then rclone will generate rsa, ecdsa
and ed25519 variants, and cache them for later use in rclone's cache
directory (see `rclone help flags cache-dir`) in the "serve-sftp"
@ -484,7 +487,7 @@ rclone serve sftp remote:path [flags]
--pass string Password for authentication
--poll-interval duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
--read-only Only allow read-only access
--stdio Run an sftp server on run stdin/stdout
--stdio Run an sftp server on stdin/stdout
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
--user string User name for authentication