f-denkena/rclone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Version v1.75.0

Browse Source
This commit is contained in:
Nick Craig-Wood
2026-07-31 16:56:33 +01:00
parent 3f8df416c8
commit 9ee9d0a0ca
76 changed files with 13809 additions and 4340 deletions
Download Patch File Download Diff File Expand all files Collapse all files
MANUAL.html
Generated
+4262 -2078
View File
File diff suppressed because it is too large Load Diff
MANUAL.md
Generated
+2271 -571
View File
File diff suppressed because it is too large Load Diff
MANUAL.txt
Generated
+2477 -581
View File
File diff suppressed because it is too large Load Diff
bin/make_manual.py
+3 -3
View File
@@ -8,7 +8,7 @@ import os
import re
import time
import subprocess
from datetime import datetime
from datetime import datetime, timezone
docpath = "docs/content"
outfile = "MANUAL.md"
@@ -200,8 +200,8 @@ def read_commands(docpath):
def main():
check_docs(docpath)
command_docs = read_commands(docpath).replace("\\", "\\\\") # escape \ so we can use command_docs in re.sub
build_date = datetime.utcfromtimestamp(
int(os.environ.get('SOURCE_DATE_EPOCH', time.time())))
build_date = datetime.fromtimestamp(
int(os.environ.get('SOURCE_DATE_EPOCH', time.time())), timezone.utc)
help_output = subprocess.check_output(["rclone", "help"]).decode("utf-8")
with open(outfile, "w") as out:
out.write("""\
docs/content/azureblob.md
-22
View File
@@ -963,28 +963,6 @@ Properties:
- Type: bool
- Default: false
#### --azureblob-memory-pool-flush-time
How often internal memory buffer pools will be flushed. (no longer used)
Properties:
- Config: memory_pool_flush_time
- Env Var: RCLONE_AZUREBLOB_MEMORY_POOL_FLUSH_TIME
- Type: Duration
- Default: 1m0s
#### --azureblob-memory-pool-use-mmap
Whether to use mmap buffers in internal memory pool. (no longer used)
Properties:
- Config: memory_pool_use_mmap
- Env Var: RCLONE_AZUREBLOB_MEMORY_POOL_USE_MMAP
- Type: bool
- Default: false
#### --azureblob-encoding
The encoding for the backend.
docs/content/b2.md
-22
View File
@@ -601,28 +601,6 @@ Properties:
- Type: Duration
- Default: 1w
#### --b2-memory-pool-flush-time
How often internal memory buffer pools will be flushed. (no longer used)
Properties:
- Config: memory_pool_flush_time
- Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME
- Type: Duration
- Default: 1m0s
#### --b2-memory-pool-use-mmap
Whether to use mmap buffers in internal memory pool. (no longer used)
Properties:
- Config: memory_pool_use_mmap
- Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP
- Type: bool
- Default: false
#### --b2-lifecycle
Set the number of days deleted files should be kept when creating a bucket.
docs/content/bisync.md
+15 -4
View File
@@ -1053,9 +1053,17 @@ encodings.)
The following backends have known issues that need more investigation:
<!--- start list_failures - DO NOT EDIT THIS SECTION - use make commanddocs --->
- `TestDropbox` (`dropbox`)
- [`TestBisyncRemoteRemote/normalization`](https://pub.rclone.org/integration-tests/current/dropbox-cmd.bisync-TestDropbox-1.txt)
- Updated: 2026-05-01-010013
- `TestHuaweiDrive` (`huaweidrive`)
- [`TestBisyncRemoteLocal/ext_paths`](https://pub.rclone.org/integration-tests/current/huaweidrive-cmd.bisync-TestHuaweiDrive-1.txt)
- [`TestBisyncRemoteLocal/extended_filenames`](https://pub.rclone.org/integration-tests/current/huaweidrive-cmd.bisync-TestHuaweiDrive-1.txt)
- [`TestBisyncRemoteLocal/normalization`](https://pub.rclone.org/integration-tests/current/huaweidrive-cmd.bisync-TestHuaweiDrive-1.txt)
- [`TestBisyncLocalRemote/ext_paths`](https://pub.rclone.org/integration-tests/current/huaweidrive-cmd.bisync-TestHuaweiDrive-1.txt)
- [`TestBisyncLocalRemote/extended_filenames`](https://pub.rclone.org/integration-tests/current/huaweidrive-cmd.bisync-TestHuaweiDrive-1.txt)
- [4 more](https://pub.rclone.org/integration-tests/current/)
- `TestPcloud` (`pcloud`)
- [`TestBisyncRemoteRemote/check_access`](https://pub.rclone.org/integration-tests/current/pcloud-cmd.bisync-TestPcloud-1.txt)
- [`TestBisyncRemoteRemote/rmdirs`](https://pub.rclone.org/integration-tests/current/pcloud-cmd.bisync-TestPcloud-1.txt)
- Updated: 2026-07-31-010017
<!--- end list_failures - DO NOT EDIT THIS SECTION - use make commanddocs --->
The following backends either have not been tested recently or have known issues
@@ -1065,6 +1073,10 @@ that are deemed unfixable for the time being:
- `TestArchive` (`archive`)
- `TestCache` (`cache`)
- `TestDrime` (`drime`)
- `TestDropbox` (`dropbox`)
- `TestBisyncRemoteLocal/normalization`
- `TestBisyncLocalRemote/normalization`
- `TestBisyncRemoteRemote/normalization`
- `TestFileLu` (`filelu`)
- `TestFilesCom` (`filescom`)
- `TestImageKit` (`imagekit`)
@@ -1084,7 +1096,6 @@ that are deemed unfixable for the time being:
- `TestS3Rclone` (`s3`)
- `TestSFTPRsyncNet` (`sftp`)
- `TestStorj` (`storj`)
- `TestWebdavInfiniteScale` (`webdav`)
- `TestWebdavNextcloud` (`webdav`)
- `TestWebdavOwncloud` (`webdav`)
- `TestnStorage` (`netstorage`)
docs/content/box.md
-13
View File
@@ -323,19 +323,6 @@ Properties:
- Type: string
- Required: false
#### --box-config-credentials
Box App config.json contents.
Leave blank normally.
Properties:
- Config: config_credentials
- Env Var: RCLONE_BOX_CONFIG_CREDENTIALS
- Type: string
- Required: false
#### --box-access-token
Box App Primary Access Token
docs/content/cache.md
-11
View File
@@ -448,17 +448,6 @@ Properties:
Here are the Advanced options specific to cache (Cache a remote).
#### --cache-plex-token
The plex token for authentication - auto set normally.
Properties:
- Config: plex_token
- Env Var: RCLONE_CACHE_PLEX_TOKEN
- Type: string
- Required: false
#### --cache-plex-insecure
Skip all certificate verification when connecting to the Plex server.
docs/content/changelog.md
+223
View File
@@ -6,6 +6,229 @@ description: "Rclone Changelog"
# Changelog
## v1.75.0 - 2026-07-31
[See commits](https://github.com/rclone/rclone/compare/v1.74.0...v1.75.0)
- New S3 Providers
- [Scality](/s3/#scality) (RING / ARTESCA)
- [Zero Services](/s3/#zero-z3) (ZERO-Z3)
- Security
- archive: Don't crash on malformed squashfs images GHSA-6jcg-q3wp-x2f4 CVE-PENDING (Nick Craig-Wood)
- ftp: Fix ftp command injection when encoding doesn't include CRLF GHSA-8c48-q9wj-3w37 CVE-PENDING (Nick Craig-Wood)
- lib/http: Use TLS on all `--addr` listeners when `--cert` and `--key` are set GHSA-mfvx-7rcj-9m5g (Nick Craig-Wood)
- lib/proxy: Fix unbounded HTTP CONNECT headers causing OOM GHSA-xhf4-832v-7xcr CVE-PENDING (Nick Craig-Wood)
- local: Stop source file names escaping the destination directory GHSA-7p4m-qxvv-g567 CVE-PENDING (Nick Craig-Wood)
- rc
- Don't expose pprof debug handlers on an unauthenticated server GHSA-mfvx-7rcj-9m5g CVE-PENDING (Nick Craig-Wood)
- Require authentication to list the remotes with `--rc-serve` GHSA-mfvx-7rcj-9m5g (Nick Craig-Wood)
- Fix leaking stack traces on panics GHSA-gwfq-86j8-7qhv (Nick Craig-Wood)
- s3
- Fix redirect credential leaks, reject HTTPS->HTTP and strip secrets GHSA-8mxv-9xhp-86h4 (Nick Craig-Wood)
- Strip S3 Express session token on cross-host redirects GHSA-8mxv-9xhp-86h4 (Nick Craig-Wood)
- serve ftp: Use constant time comparison for password check GHSA-mfvx-7rcj-9m5g (Nick Craig-Wood)
- serve restic: Fix path traversal above the served directory GHSA-45pq-889g-fcgh CVE-PENDING (Nick Craig-Wood)
- serve sftp: Don't crash the whole server on a bad request GHSA-6jcg-q3wp-x2f4 (Nick Craig-Wood)
- sftp: Fix command injection via crafted filenames on PowerShell remotes GHSA-2m8m-jhrm-w6j2 CVE-PENDING (Nick Craig-Wood)
- vfs: Don't crash the process if a backend panics on a background goroutine GHSA-6jcg-q3wp-x2f4 (Nick Craig-Wood)
- webdav
- Fix HTTPS to HTTP redirects leaking credentials GHSA-h4mf-4v27-hggj (Nick Craig-Wood)
- Tus: fix potential nil pointer crash GHSA-3x6r-wxxg-53vv (Nick Craig-Wood)
- Update `google.golang.org/grpc` to fix multiple security problems (Nick Craig-Wood)
- New Features
- build: Update all dependencies (Nick Craig-Wood)
- config
- Add `config unset` command to remove options from a remote (Nick Craig-Wood)
- Add tier to config wizard (dougal)
- docker serve
- Add timeout to volume restore so slow remotes don't block startup (Nick Craig-Wood)
- Restore volumes concurrently so one slow remote doesn't block others (Nick Craig-Wood)
- Make Create idempotent to avoid "volume already exists" after restart (Nick Craig-Wood)
- doc fixes (blackflytech, dougal, Giridhar, KTibow, mathieulongtin, Nick Craig-Wood, p1, Socialpranker, Søren Lindberg, yashanil98)
- filter
- Support nested `{}` alternates in glob filters (maximilize)
- Add `--files-from0` to support NUL-delimited input (Gaurav)
- fserrors: Make http2 "server sent GOAWAY" a retriable error (phatlc)
- fshttp
- Add `--dump errors` to dump only failed HTTP transactions (Nick Craig-Wood)
- Add `--dump trace` to log connection level events via httptrace (Nick Craig-Wood)
- gui
- Serve static files with gzip/deflate compression (Leon Brocard)
- Respect explicit `--rc-allow-origin` instead of always deriving it from the bind address (Kyue)
- Update embedded release to 1.1.11 (Nick Craig-Wood)
- mount2: Add `--allow-idmap` to advertise FUSE_ALLOW_IDMAP (Valerij Fredriksen)
- nfsmount: Call mount_nfs directly on OpenBSD so -T is accepted (Socialpranker)
- rc
- Respond with 202 if `prefer-async` header is passed (FTCHD)
- Add `config/oauthstop` and `config/oauthstatus` to control oauth listener (FTCHD)
- Include OAuth authorization URL in rc `config/oauthstatus` response (Hakan İSMAİL)
- Allow setting rc config and filter options as flat parameters (Hakan İSMAİL)
- serve
- Support custom http response headers (kkocdko)
- Update serve remote control to accept nested as well as flat options (Hakan İSMAİL)
- serve dlna: Bound SOAP request bodies (Acts1631)
- serve nfs
- Allow NFS clients to mount subpaths of the served remote (Nick Craig-Wood)
- Advertise AUTH_UNIX so the *BSD NFS clients can mount (Socialpranker)
- serve s3: Stream multipart uploads to the backend instead of buffering in memory (Nick Craig-Wood)
- serve sftp
- Implement `statvfs@openssh.com` to report disk usage (Nick Craig-Wood)
- Use the requested atime when setting file times (Nick Craig-Wood)
- serve webdav: Add gzip compression for compressible responses (Leon Brocard)
- serve http: Add `--disable-dir-list` flag (Leon Brocard)
- Bug Fixes
- archive/squashfs: Fix reading images with no fragment or xattr table (maximilize)
- chunkedreader: Fix spurious errors when a parallel stream is closed early (Nick Craig-Wood)
- config
- Fix config_template_file and config_template being ignored via config/create (hexbinoct)
- Fix normalization when obscuring passwords (Nick Craig-Wood)
- docker serve: Fix plugin timeout on restart when volumes have active mounts (Nick Craig-Wood)
- fs: Fix passwords and tokens appearing in the debug log during rclone config (Nick Craig-Wood)
- gui: Fix cross-origin API requests when bound to a wildcard address (FTCHD)
- hash: Fix xxh128 hasher size (Yuhang Cao)
- log: Fix side effects when importing rclone as a library (Sven Rebhan)
- march
- Fix unnecessarily listing dst directory when src listing finished (Nick Craig-Wood)
- Fix goroutine leak on completed async rc jobs (Yash Anil)
- nfsmount: Fix mount_nfs options incompatible with OpenBSD (Socialpranker)
- rc
- Fix `operations/stat` for directories with large parent dirs (Nick Craig-Wood)
- Fix `_filter` and `_config` parameters being ignored by `mount/*` commands (Hakan İSMAİL)
- serve: Fix auth proxy using stale config parameters when making a backend (Nick Craig-Wood)
- serve s3
- Fix aborted multipart uploads appearing as ghosts (Nick Craig-Wood)
- Fix streamed multipart uploads not being atomic (Nick Craig-Wood)
- Fix OOM and InvalidPart errors with concurrent multipart uploads (Nick Craig-Wood)
- sync: Fix `--fix-case` rename on backends that need upload before overwrite (Nick Craig-Wood)
- Mount
- Support flat VFS and Mount options in mount RC command (Hakan İSMAİL)
- VFS
- Fix IO error by recreating the cache file if it has been removed (Nick Craig-Wood)
- Fix "invalid seek position" error when cache files larger than the remote (Nick Craig-Wood)
- Fix vfs cache writeback timer not being stopped when `--transfers` reached (Nick Craig-Wood)
- Fix crash when multiple mounts or servers share the same VFS (Nick Craig-Wood)
- Local
- Add `--local-fatal-if-no-space` flag (ferrumclaudepilgrim)
- Don't resolve relative roots to absolute paths (Nick Craig-Wood)
- Archive
- Fix squashfs listings failing with invalid argument after update (Nick Craig-Wood)
- Azure Blob
- Fix MD5 being dropped on range reads causing vfs cache re-downloads (Nick Craig-Wood)
- Add `use_arrow_list` flag for experimental Apache Arrow listing (Nick Craig-Wood)
- List very large containers in parallel with `list_parallelism` (Nick Craig-Wood)
- Azurefiles
- Fix incorrect modtime after uploading a file or setting its modtime (Nick Craig-Wood)
- Improve modtime precision from 1s to 100ns (Nick Craig-Wood)
- Combine
- Don't return an error message as the remote name for a bad object (Nick Craig-Wood)
- Drime
- Remove stale mux_status field from Item (Nick Craig-Wood)
- Drive
- Warn in config wizard before using the shared client_id (Nick Craig-Wood)
- Detect shortcut loops to avoid infinite recursion (Nick Craig-Wood)
- Dropbox
- Add support for impersonate_admin (Gaurav)
- Add `--dropbox-skip-shared-folders` and `--dropbox-skip-unowned-folders` (Gaurav)
- Make Rmdir use one less API call (Socialpranker)
- Use much less memory when uploading small files (Nick Craig-Wood)
- Remove an unnecessary API call when uploading small files (Nick Craig-Wood)
- Filen
- Fix incorrect modtime after updating a file or setting its modtime (Nick Craig-Wood)
- Filescom
- Fix missing MD5 hash after uploading a file (Nick Craig-Wood)
- FTP
- Fix incorrect modtime after uploading a file or setting its modtime (Nick Craig-Wood)
- Googlephotos
- Warn in config wizard before using the shared client_id (Nick Craig-Wood)
- Hasher
- Fix Update not storing hashes in bolt DB after file replacement (Nick Craig-Wood)
- Hdfs
- Fix incorrect modtime after uploading a file or setting its modtime (Nick Craig-Wood)
- Hidrive
- Fix incorrect modtime after setting a file's modtime (Nick Craig-Wood)
- HTTP
- Don't list parent directory when pointing at a single file (Nick Craig-Wood)
- Add Prefer to CORS Access-Control-Allow-Headers header (sijie-Z)
- Iclouddrive
- Fix "cannot unmarshal number" error when listing photo albums (Nick Craig-Wood)
- Fix 2FA failing with 409 even when the code is valid (Punya Jain)
- Imagekit
- Fix Open with a RangeOption returning the wrong data (Nick Craig-Wood)
- Add mtime to the available metadata (Nick Craig-Wood)
- Internxt
- Add Move and DirMove methods for server-side file and directory operations (jzunigax2)
- Handle file size limit errors during uploads (jzunigax2)
- Surface re-login error when re-auth fails in NewFs (0rangeSeaW0lf)
- Jottacloud
- Fix incorrect modtime after setting a file's modtime (Nick Craig-Wood)
- Linkbox
- Retry bot protection HTML challenge responses instead of failing (Nick Craig-Wood)
- Mailru
- Fix incorrect modtime after updating a file or setting its modtime (Nick Craig-Wood)
- Mega
- Fix files reappearing in listings after being renamed (Nick Craig-Wood)
- Fix moved files disappearing from listings between remotes (Nick Craig-Wood)
- Netstorage
- Fix missing MD5 hash after uploading a file (Nick Craig-Wood)
- Onedrive
- Add support for no admin mode (TaterLi)
- Treat non-2xx preauth download as error (ifloppy)
- Download malware-flagged files via Graph Prefer header (ifloppy)
- Opendrive
- Fix uploaded objects returning the wrong hash and modtime (Nick Craig-Wood)
- Oracleobjectstorage
- Fix crash when downloading objects with unknown length (Nick Craig-Wood)
- Add `--oos-decompress` flag to download gzip-encoded files (Nick Craig-Wood)
- Pixeldrain
- Fix incorrect modtime and missing hash after uploading a file (Nick Craig-Wood)
- Protondrive
- Implement proper retry logic (tomholford)
- Fix gopenpgp: invalid data: user ID signature with wrong type on custom-domain account (Nick Craig-Wood)
- Fix long hangs on permanent validation failures (Nick Craig-Wood)
- Fix incorrect modtime after uploading a file (Nick Craig-Wood)
- Putio
- Fix incorrect modtime after setting a file's modtime (Nick Craig-Wood)
- Fix sync deletions failing with 400 TRASH_LOCK_TIMEOUT errors (Nick Craig-Wood)
- Quatrix
- Fix incorrect modtime after uploading a file (Nick Craig-Wood)
- S3
- Add Zero Services (ZERO-Z3) provider (Zero Services GmbH)
- Add Scality (RING / ARTESCA) provider (Dzmitry Nianakhau)
- Seafile
- Fix rclone sync files with identical size again and again (TowyTowy)
- SFTP
- Add `--sftp-pin-host-key` - Trust On First Use host key pinning (Nick Craig-Wood)
- Add `--sftp-encoding` support (Puneet Dixit)
- Don't retry permanent connection errors (Nick Craig-Wood)
- Allow silencing no hostkey validation warning (Noah Zalev)
- Fix cmd shell execution of paths containing variable-expansion or newline characters (Nick Craig-Wood)
- Shade
- Retry server errors instead of failing the transfer (Nick Craig-Wood)
- Fix uploads failing with EOF when completing multipart uploads (Nick Craig-Wood)
- Smb
- Fix Kerberos credentials being reloaded for every connection (Nick Craig-Wood)
- Fix TCP connection leak when connection setup fails (Nick Craig-Wood)
- Fix server-side move of directories with special characters in the name (Nick Craig-Wood)
- Fix spurious "Directory already exists" errors when moving directories (Nick Craig-Wood)
- Ulozto
- Fix server side moves between differently rooted remotes losing files (Nick Craig-Wood)
- WebDAV
- Fix incorrect modtime after setting a file's modtime (Nick Craig-Wood)
- Yandex
- Fix 500 errors by waiting for uploads to complete before setting modtime (Nick Craig-Wood)
- Fix missing MD5 hash after uploading a file (Nick Craig-Wood)
- Fix modtime randomly reverting to the upload time after upload (Nick Craig-Wood)
- Add `--yandex-upload-wait` to fix 500 errors when uploading (Nick Craig-Wood)
- Zoho
- Honour `Retry-After` header on 429 (Erol Ozcan)
- Add `--zoho-tpslimit` and `--zoho-tpslimit-burst` (Erol Ozcan)
- Log throttling once per episode at NOTICE (Erol Ozcan)
- Rate limit repeated listings of the same folder (Erol Ozcan)
- Fix flaky folder list limiter test under concurrent listings (Nick Craig-Wood)
- Fix large file overwrite creating a duplicate instead of replacing (Erol Ozcan)
- Treat R008 unauthorized as directory not found (Erol Ozcan)
- Preserve `root_folder_id` on reconnect and allow setting it (Erol Ozcan)
## v1.74.4 - 2026-07-08
[See commits](https://github.com/rclone/rclone/compare/v1.74.3...v1.74.4)
docs/content/commands/rclone.md
+25 -5
View File
@@ -232,7 +232,7 @@ rclone [flags]
--drime-list-chunk int Number of items to list in each call (default 1000)
--drime-root-folder-id string ID of the root folder
--drime-upload-concurrency int Concurrency for multipart uploads and copies (default 4)
--drime-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
--drime-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 5Mi)
--drime-workspace-id string Account ID
--drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded
--drive-allow-import-name-change Allow the filetype to change when uploading Google docs
@@ -241,7 +241,7 @@ rclone [flags]
--drive-chunk-size SizeSuffix Upload chunk size (default 8Mi)
--drive-client-credentials Use client credentials OAuth flow
--drive-client-id string Google Application Client Id
--drive-client-secret string OAuth Client Secret
--drive-client-secret string Google Application Client Secret
--drive-copy-shortcut-content Server side copy contents of shortcuts instead of the shortcut
--drive-description string Description of the remote
--drive-disable-http2 Disable drive using http2 (default true)
@@ -297,17 +297,20 @@ rclone [flags]
--dropbox-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot)
--dropbox-export-formats CommaSepList Comma separated list of preferred formats for exporting files (default html,md)
--dropbox-impersonate string Impersonate this user when using a business account
--dropbox-impersonate-admin string Team admin ID to use when performing actions as a team administrator
--dropbox-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms)
--dropbox-root-namespace string Specify a different Dropbox namespace ID to use as the root for all paths
--dropbox-shared-files Instructs rclone to work on individual shared files
--dropbox-shared-folders Instructs rclone to work on shared folders
--dropbox-show-all-exports Show all exportable files in listings
--dropbox-skip-exports Skip exportable files in all listings
--dropbox-skip-shared-folders Instructs rclone to skip all shared folders
--dropbox-skip-unowned-folders Instructs rclone to skip shared folders not owned by the current user
--dropbox-token string OAuth Access Token as a JSON blob
--dropbox-token-url string Token server url
-n, --dry-run Do a trial run with no permanent changes
--dscp string Set DSCP value to connections, value or name, e.g. CS1, LE, DF, AF21
--dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper, curl
--dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper, curl, errors, trace
--dump-bodies Dump HTTP headers and bodies - may contain sensitive info
--dump-headers Dump HTTP headers - may contain sensitive info
--error-on-no-transfer Sets exit code 9 if no files are transferred, useful in scripts
@@ -349,6 +352,7 @@ rclone [flags]
--filen-upload-concurrency int Concurrency for chunked uploads (default 16)
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
--filescom-api-key string The API key used to authenticate with Files.com
--filescom-description string Description of the remote
--filescom-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
@@ -558,8 +562,10 @@ rclone [flags]
--local-case-sensitive Force the filesystem to report itself as case sensitive
--local-description string Description of the remote
--local-encoding Encoding The encoding for the backend (default Slash,Dot)
--local-fatal-if-no-space Make out-of-space errors fatal during transfers
--local-hashes CommaSepList Comma separated list of supported checksum types
--local-links Translate symlinks to/from regular files with a '.rclonelink' extension for the local backend
--local-metadata-restore-special-bits Restore the setuid, setgid and sticky bits from metadata
--local-no-check-updated Don't check to see if the files change during upload
--local-no-clone Disable reflink cloning for server-side copies
--local-no-preallocate Disable preallocation of disk space for transferred files
@@ -624,7 +630,7 @@ rclone [flags]
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
--metadata-mapper SpaceSepList Program to run to transforming metadata before upload
--metadata-set stringArray Add metadata key=value when uploading
--metrics-addr stringArray IPaddress:Port or :Port to bind metrics server to
--metrics-addr stringArray IPaddress:Port or :Port to bind server to
--metrics-allow-origin string Origin which cross-domain request (CORS) can be executed from
--metrics-baseurl string Prefix for URLs - leave blank for root
--metrics-cert string TLS PEM key (concatenation of certificate and CA certificate)
@@ -635,6 +641,7 @@ rclone [flags]
--metrics-min-tls-version string Minimum TLS version that is acceptable (default "tls1.0")
--metrics-pass string Password for authentication
--metrics-realm string Realm for authentication
--metrics-response-header stringArray Set HTTP header for all responses, overriding existing values
--metrics-salt string Password hashing salt (default "dlPL2MqE")
--metrics-server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
--metrics-server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
@@ -688,6 +695,7 @@ rclone [flags]
--onedrive-root-folder-id string ID of the root folder
--onedrive-server-side-across-configs Deprecated: use --server-side-across-configs instead
--onedrive-tenant string ID of the service principal's tenant. Also called its directory ID
--onedrive-tenant-url string The tenant URL for non-admin OneDrive access
--onedrive-token string OAuth Access Token as a JSON blob
--onedrive-token-url string Token server url
--onedrive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default off)
@@ -698,6 +706,7 @@ rclone [flags]
--oos-config-profile string Profile name inside the oci config file (default "Default")
--oos-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi)
--oos-copy-timeout Duration Timeout for copy (default 1m0s)
--oos-decompress If set this will decompress gzip encoded objects
--oos-description string Description of the remote
--oos-disable-checksum Don't store MD5 checksum with object metadata
--oos-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot)
@@ -822,6 +831,7 @@ rclone [flags]
--rc-no-auth Don't require auth for certain methods
--rc-pass string Password for authentication
--rc-realm string Realm for authentication
--rc-response-header stringArray Set HTTP header for all responses, overriding existing values
--rc-salt string Password hashing salt (default "dlPL2MqE")
--rc-serve Enable the serving of remote objects
--rc-serve-no-modtime Don't read the modification time (can speed things up)
@@ -935,9 +945,11 @@ rclone [flags]
--sftp-disable-concurrent-reads If set don't use concurrent reads
--sftp-disable-concurrent-writes If set don't use concurrent writes
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available
--sftp-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,Dot)
--sftp-hashes CommaSepList Comma separated list of supported checksum types
--sftp-host string SSH host to connect to
--sftp-host-key-algorithms SpaceSepList Space separated list of host key algorithms, ordered by preference
--sftp-host-keys CommaSepList Pinned host keys for this remote, used to verify the server
--sftp-http-proxy string URL for HTTP CONNECT proxy
--sftp-idle-timeout Duration Max time before closing idle connections (default 1m0s)
--sftp-key-exchange SpaceSepList Space separated list of key exchange algorithms, ordered by preference
@@ -950,6 +962,7 @@ rclone [flags]
--sftp-md5sum-command string The command used to read MD5 hashes
--sftp-pass string SSH password, leave blank to use ssh-agent (obscured)
--sftp-path-override string Override path used by SSH shell commands
--sftp-pin-host-key Pin the server host key on first connection (Trust On First Use)
--sftp-port int SSH port number (default 22)
--sftp-pubkey string SSH public certificate for public certificate based authentication
--sftp-pubkey-file string Optional path to public key file
@@ -1094,7 +1107,7 @@ rclone [flags]
--use-json-log Use json log format
--use-mmap Use mmap allocator (see docs)
--use-server-modtime Use server modified time instead of object metadata
--user-agent string Set the user-agent to a specified string (default "rclone/v1.74.0")
--user-agent string Set the user-agent to a specified string (default "rclone/v1.75.0")
-v, --verbose count Print lots more stuff (repeat for more)
-V, --version Print the version number
--webdav-auth-redirect Preserve authentication on redirect
@@ -1122,15 +1135,22 @@ rclone [flags]
--yandex-spoof-ua Set the user agent to match an official version of the yandex disk client. May help with upload performance (default true)
--yandex-token string OAuth Access Token as a JSON blob
--yandex-token-url string Token server url
--yandex-upload-wait Duration Wait this long after an upload before setting the modification time (default 0s)
--zoho-auth-url string Auth server URL
--zoho-client-credentials Use client credentials OAuth flow
--zoho-client-id string OAuth Client Id
--zoho-client-secret string OAuth Client Secret
--zoho-description string Description of the remote
--zoho-encoding Encoding The encoding for the backend (default Del,Ctl,InvalidUtf8)
--zoho-list-folder-burst int Same-folder listings allowed back-to-back before --zoho-list-folder-limit paces them (default 6)
--zoho-list-folder-limit int Max listings of the SAME folder allowed per --zoho-list-folder-window (default 19)
--zoho-list-folder-window Duration The window for --zoho-list-folder-limit (default 1m0s)
--zoho-region string Zoho region to connect to
--zoho-root-folder-id string ID of the root folder
--zoho-token string OAuth Access Token as a JSON blob
--zoho-token-url string Token server url
--zoho-tpslimit float Max number of API transactions per second (default 6)
--zoho-tpslimit-burst int Number of API calls to allow back-to-back without sleeping, for --zoho-tpslimit (default 1)
--zoho-upload-cutoff SizeSuffix Cutoff for switching to large file upload api (>= 10 MiB) (default 10Mi)
```
docs/content/commands/rclone_bisync.md
+1
View File
@@ -149,6 +149,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_cat.md
+1
View File
@@ -81,6 +81,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_check.md
+1
View File
@@ -93,6 +93,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_checksum.md
+1
View File
@@ -79,6 +79,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_config.md
+1
View File
@@ -47,6 +47,7 @@ See the [global flags page](/flags/) for global options not listed here.
* [rclone config show](/commands/rclone_config_show/) - Print (decrypted) config file, or the config for a single remote.
* [rclone config string](/commands/rclone_config_string/) - Print connection string for a single remote.
* [rclone config touch](/commands/rclone_config_touch/) - Ensure configuration file exists.
* [rclone config unset](/commands/rclone_config_unset/) - Unset options in an existing remote.
* [rclone config update](/commands/rclone_config_update/) - Update options in an existing remote.
* [rclone config userinfo](/commands/rclone_config_userinfo/) - Prints info about logged in user of remote.
docs/content/commands/rclone_config_unset.md
+51
View File
@@ -0,0 +1,51 @@
---
title: "rclone config unset"
description: "Unset options in an existing remote."
versionIntroduced: v1.75
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/config/unset/ and as part of making a release run "make commanddocs"
---
# rclone config unset
Unset options in an existing remote.
## Synopsis
Remove one or more options from an existing remote. The options to
remove should be passed in as a list of key names.
For example, to remove the `client_id` and `client_secret` options from
a remote of name myremote you would do:
```sh
rclone config unset myremote client_id client_secret
```
This removes the keys from the config file entirely, which is different
from setting them to an empty string with `config update`. Removing a
key restores rclone's default behaviour for that option, whereas setting
it to an empty string overrides the default with an empty value.
You can't unset the `type` of a remote - use `config delete` to remove
the whole remote instead.
```
rclone config unset name [key]+ [flags]
```
## Options
```
-h, --help help for unset
```
See the [global flags page](/flags/) for global options not listed here.
## See Also
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.
<!-- markdownlint-restore -->
docs/content/commands/rclone_convmv.md
+3 -2
View File
@@ -231,12 +231,12 @@ rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,command=e
```console
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}"
// Output: stories/The Quick Brown Fox!-20260501
// Output: stories/The Quick Brown Fox!-20260731
```
```console
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}"
// Output: stories/The Quick Brown Fox!-2026-05-01 0208PM
// Output: stories/The Quick Brown Fox!-2026-07-31 0340PM
```
```console
@@ -399,6 +399,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_copy.md
+1
View File
@@ -217,6 +217,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_copyto.md
+4 -2
View File
@@ -13,8 +13,9 @@ Copy files from source to dest, skipping identical files.
If source:path is a file or directory then it copies it to a file or
directory named dest:path.
This can be used to upload single files to other than their current
name. If the source is a directory then it acts exactly like the
This can be used to copy a single file to a destination with a name
different from its source - for example, uploading and renaming in one
step. If the source is a directory then it acts exactly like the
[copy](/commands/rclone_copy/) command.
So
@@ -178,6 +179,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_cryptcheck.md
+1
View File
@@ -100,6 +100,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_delete.md
+1
View File
@@ -76,6 +76,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_gui.md
+1
View File
@@ -92,6 +92,7 @@ Flags to control the Remote Control API
--rc-no-auth Don't require auth for certain methods
--rc-pass string Password for authentication
--rc-realm string Realm for authentication
--rc-response-header stringArray Set HTTP header for all responses, overriding existing values
--rc-salt string Password hashing salt (default "dlPL2MqE")
--rc-serve Enable the serving of remote objects
--rc-serve-no-modtime Don't read the modification time (can speed things up)
docs/content/commands/rclone_hashsum.md
+1
View File
@@ -79,6 +79,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_ls.md
+1
View File
@@ -73,6 +73,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_lsd.md
+1
View File
@@ -86,6 +86,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_lsf.md
+7
View File
@@ -43,6 +43,12 @@ T - tier of storage if known, e.g. "Hot" or "Cool"
M - Metadata of object in JSON blob format, eg {"key":"value"}
```
Some backends use composite IDs. In particular, Google Drive shortcuts are
normally dereferenced, and their "i" field contains the target object's ID
followed by the shortcut's ID, separated by a tab. This tab is part of the ID
field and is not changed by `--separator`. Use `--drive-skip-shortcuts` to omit
shortcut entries.
So if you wanted the path, size and modification time, you would use
`--format "pst"`, or maybe `--format "tsp"` to put the path last.
@@ -200,6 +206,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_lsjson.md
+1
View File
@@ -154,6 +154,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_lsl.md
+1
View File
@@ -74,6 +74,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_md5sum.md
+1
View File
@@ -55,6 +55,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_mount.md
+59
View File
@@ -349,6 +349,63 @@ This may be due to newer [Apparmor](https://wiki.ubuntu.com/AppArmor) restrictio
which can be disabled with `sudo aa-disable /usr/bin/fusermount3` (you may need
to `sudo apt install apparmor-utils` beforehand).
## Mounting on OpenBSD
`rclone nfsmount` works on OpenBSD by spinning up the [serve nfs](/commands/rclone_serve_nfs/)
server and mounting it with the system `mount_nfs(8)`, the same approach used
for the NFS mount method on macOS. There is no FUSE-based mount option on
OpenBSD, so `nfsmount` is the only way to mount rclone remotes as a local
file system there.
### portmap registration
OpenBSD's kernel NFS client locates `mountd` through the system portmapper
rather than connecting to a fixed port, so rclone's in-process NFS server
needs to be registered with portmap before it can be mounted. Start the
`serve nfs` server on a fixed port, stop the system NFS services so they
don't conflict with it, then register that port with portmap for both the
`nfs` and `mountd` RPC programs (this is the recipe from
[hjicks in #8578](https://github.com/rclone/rclone/issues/8578#issuecomment-2799229652)):
```console
rclone serve nfs --addr localhost:<PORT> remote:path
doas rcctl stop nfsd portmap
doas pkill -9 mountd # mountd can't be stopped via rcctl(8)
doas rcctl -f start portmap
doas rpcinfo -s nfs 3 <PORT>
doas rpcinfo -s mountd 3 <PORT>
```
Replace `<PORT>` with the port passed to `--addr`. Port 2049 works too, but
needs either running rclone as root or adjusting `sysctl(8)` at
securelevel 0, so a non-privileged port is simpler for testing.
### Use `mount_nfs -T`, not `mount`
Mount the exported NFS share directly with `mount_nfs(8)` using the `-T`
flag to force TCP, rather than the generic `mount(8)` wrapper - OpenBSD's
`mount(8)` does not understand `-T` and rejects it with `unknown option -- T`:
```console
mount_nfs -T localhost:/ /path/to/local/mount
```
`rclone nfsmount` does this for you automatically on OpenBSD (it calls
`mount_nfs` directly with `-T` instead of going through `mount`), so this
is only needed if you are mounting the `serve nfs` export by hand.
### AUTH_UNIX and existing limitations
OpenBSD's (and the other BSDs') kernel NFS client requires the server to
offer the `AUTH_UNIX` authentication flavor during the MOUNT RPC handshake;
a server that only offers `AUTH_NULL` is rejected with
`mount_nfs: can't access /: Authentication error`. rclone's NFS server
advertises `AUTH_UNIX` for this reason, though it does not implement any
per-user access control on top of it - see
[issue #8578](https://github.com/rclone/rclone/issues/8578) for the
background on this and for the current state of OpenBSD support.
## Limitations
Without the use of `--vfs-cache-mode` this can only write files
@@ -1005,6 +1062,7 @@ rclone mount remote:path /path/to/mountpoint [flags]
## Options
```
--allow-idmap Allow id-mapped mounts (Linux 6.12+, mount2 only)
--allow-non-empty Allow mounting over a non-empty directory (not supported on Windows)
--allow-other Allow access to other users (not supported on Windows)
--allow-root Allow access to root user (not supported on Windows)
@@ -1076,6 +1134,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_move.md
+1
View File
@@ -182,6 +182,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_moveto.md
+1
View File
@@ -177,6 +177,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_ncdu.md
+1
View File
@@ -99,6 +99,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_nfsmount.md
+60
View File
@@ -350,6 +350,63 @@ This may be due to newer [Apparmor](https://wiki.ubuntu.com/AppArmor) restrictio
which can be disabled with `sudo aa-disable /usr/bin/fusermount3` (you may need
to `sudo apt install apparmor-utils` beforehand).
## Mounting on OpenBSD
`rclone nfsmount` works on OpenBSD by spinning up the [serve nfs](/commands/rclone_serve_nfs/)
server and mounting it with the system `mount_nfs(8)`, the same approach used
for the NFS mount method on macOS. There is no FUSE-based mount option on
OpenBSD, so `nfsmount` is the only way to mount rclone remotes as a local
file system there.
### portmap registration
OpenBSD's kernel NFS client locates `mountd` through the system portmapper
rather than connecting to a fixed port, so rclone's in-process NFS server
needs to be registered with portmap before it can be mounted. Start the
`serve nfs` server on a fixed port, stop the system NFS services so they
don't conflict with it, then register that port with portmap for both the
`nfs` and `mountd` RPC programs (this is the recipe from
[hjicks in #8578](https://github.com/rclone/rclone/issues/8578#issuecomment-2799229652)):
```console
rclone serve nfs --addr localhost:<PORT> remote:path
doas rcctl stop nfsd portmap
doas pkill -9 mountd # mountd can't be stopped via rcctl(8)
doas rcctl -f start portmap
doas rpcinfo -s nfs 3 <PORT>
doas rpcinfo -s mountd 3 <PORT>
```
Replace `<PORT>` with the port passed to `--addr`. Port 2049 works too, but
needs either running rclone as root or adjusting `sysctl(8)` at
securelevel 0, so a non-privileged port is simpler for testing.
### Use `mount_nfs -T`, not `mount`
Mount the exported NFS share directly with `mount_nfs(8)` using the `-T`
flag to force TCP, rather than the generic `mount(8)` wrapper - OpenBSD's
`mount(8)` does not understand `-T` and rejects it with `unknown option -- T`:
```console
mount_nfs -T localhost:/ /path/to/local/mount
```
`rclone nfsmount` does this for you automatically on OpenBSD (it calls
`mount_nfs` directly with `-T` instead of going through `mount`), so this
is only needed if you are mounting the `serve nfs` export by hand.
### AUTH_UNIX and existing limitations
OpenBSD's (and the other BSDs') kernel NFS client requires the server to
offer the `AUTH_UNIX` authentication flavor during the MOUNT RPC handshake;
a server that only offers `AUTH_NULL` is rejected with
`mount_nfs: can't access /: Authentication error`. rclone's NFS server
advertises `AUTH_UNIX` for this reason, though it does not implement any
per-user access control on top of it - see
[issue #8578](https://github.com/rclone/rclone/issues/8578) for the
background on this and for the current state of OpenBSD support.
## Limitations
Without the use of `--vfs-cache-mode` this can only write files
@@ -1007,6 +1064,7 @@ rclone nfsmount remote:path /path/to/mountpoint [flags]
```
--addr string IPaddress:Port or :Port to bind server to
--allow-idmap Allow id-mapped mounts (Linux 6.12+, mount2 only)
--allow-non-empty Allow mounting over a non-empty directory (not supported on Windows)
--allow-other Allow access to other users (not supported on Windows)
--allow-root Allow access to root user (not supported on Windows)
@@ -1032,6 +1090,7 @@ rclone nfsmount remote:path /path/to/mountpoint [flags]
--nfs-cache-dir string The directory the NFS handle cache will use if set
--nfs-cache-handle-limit int max file handles cached simultaneously (min 5) (default 1000000)
--nfs-cache-type memory|disk|symlink Type of NFS handle cache to use (default memory)
--nfs-mount-path string Subpath of the remote to mount via NFS (must be an existing directory). (default "/")
--no-checksum Don't compare checksums on up/download
--no-modtime Don't read/write the modification time (can speed things up)
--no-seek Don't allow seeking in files
@@ -1082,6 +1141,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_rcd.md
+10
View File
@@ -43,6 +43,10 @@ for a transfer.
`--rc-max-header-bytes` controls the maximum number of bytes the server will
accept in the HTTP header.
`--rc-response-header` can be used to set an HTTP header for all responses,
will overriding existing values. The flag may be repeated to add multiple
headers. Use the format `Header-Name: value`.
`--rc-baseurl` controls the URL prefix that rclone serves from. By default
rclone will serve from the root. If you used `--rc-baseurl "/rclone"` then
rclone would serve from a URL starting with "/rclone/". This is
@@ -66,6 +70,11 @@ https. You will need to supply the `--rc-cert` and `--rc-key` flags.
If you wish to do client side certificate validation then you will need to
supply `--rc-client-ca` also.
When TLS is configured every listener given with `--rc-addr` serves TLS.
An individual listener can be prefixed with `http://` to serve unencrypted
HTTP on that address, or with `tls://` to state explicitly that it must serve
TLS. Using a `tls://` address without `--rc-cert` and `--rc-key` is an error.
`--rc-cert` must be set to the path of a file containing
either a PEM encoded certificate, or a concatenation of that with the CA
certificate. `--rc-key` must be set to the path of a file
@@ -197,6 +206,7 @@ Flags to control the Remote Control API
--rc-no-auth Don't require auth for certain methods
--rc-pass string Password for authentication
--rc-realm string Realm for authentication
--rc-response-header stringArray Set HTTP header for all responses, overriding existing values
--rc-salt string Password hashing salt (default "dlPL2MqE")
--rc-serve Enable the serving of remote objects
--rc-serve-no-modtime Don't read the modification time (can speed things up)
docs/content/commands/rclone_serve_dlna.md
+1
View File
@@ -588,6 +588,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_serve_docker.md
+51
View File
@@ -50,6 +50,55 @@ All mount and VFS options are submitted by the docker daemon via API, but
you can also provide defaults on the command line as well as set path to the
config file and cache directory or adjust logging verbosity.
# Restarting or upgrading the plugin
When the plugin is restarted (for example with
`docker plugin disable rclone && docker plugin enable rclone`, when upgrading
the plugin, or when the host reboots) rclone reads its `docker-plugin.state`
file and restores the volumes and mounts that were active before. The plugin
starts serving its socket straight away and re-establishes the mounts in the
background, so a slow or unreachable remote no longer prevents the plugin from
coming back up.
However, restarting the plugin necessarily stops and restarts the process that
serves the FUSE mounts. Any container that is **already running** and holding
files open on an rclone volume keeps a handle to the old, now dead mount, so
those handles start returning `transport endpoint is not connected` until the
container is restarted. This is a limitation of replacing the process behind a
live FUSE mount and cannot be avoided by rclone - the plugin itself recovers and
newly started containers work normally, but:
- **Restart any containers that were using rclone volumes** after you restart
or upgrade the plugin (e.g. `docker restart <container>`), or stop them before
and start them after.
- Databases and other applications that keep files open continuously (Grafana,
Prometheus, SQLite-backed apps, etc.) are the most affected and should always
be restarted.
# Security
The plugin API accepts a `remote` (aka `fs`) option on volume creation, and this
is parsed exactly like an rclone connection string. Connection strings are
trusted configuration: they may carry inline backend options, and some backends
use those options to run local commands (for example the `sftp` backend's `ssh`
option spawns an external binary). Anyone who can send requests to the plugin
socket can therefore make rclone run arbitrary commands as the user running
`rclone serve docker` (typically root). Treat access to the socket as equivalent
to that level of access and only expose it to trusted callers.
When listening on the default unix socket at `/run/docker/plugins/rclone.sock`
rclone creates it with mode `0660` owned by `root` and the group given by
`--socket-gid` (the process GID by default), so only root and members of that
group - normally just the docker daemon - can reach it. Do not loosen these
permissions or hand the group to untrusted users.
When using `--socket-addr` to listen on a TCP socket there is no authentication
and the API is reachable by anyone who can open the port, so bind it to a
loopback or otherwise trusted address and protect it with a firewall. Note that
holding Docker daemon access is already equivalent to root on the host, so a
caller able to issue `docker volume create` does not gain anything new from
this; the concern is exposing the socket more widely than the daemon itself.
## VFS - Virtual File System
This command uses the VFS layer. This adapts the cloud storage objects
@@ -546,6 +595,7 @@ rclone serve docker [flags]
## Options
```
--allow-idmap Allow id-mapped mounts (Linux 6.12+, mount2 only)
--allow-non-empty Allow mounting over a non-empty directory (not supported on Windows)
--allow-other Allow access to other users (not supported on Windows)
--allow-root Allow access to root user (not supported on Windows)
@@ -622,6 +672,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_serve_ftp.md
+6 -4
View File
@@ -594,10 +594,11 @@ to make proxy to many different sftp backends, you could make the
in the output and the user to `user`. For security you'd probably want
to restrict the `host` to a limited list.
Note that an internal cache is keyed on `user` so only use that for
configuration, don't use `pass` or `public_key`. This also means that if a user's
password or public-key is changed the cache will need to expire (which takes 5 mins)
before it takes effect.
An internal cache of backends is keyed on the `user` and a hash of the
`pass` or `public_key`. This means that if a user's password or
public-key changes, or the proxy returns different config parameters
(eg a rotated `api_key`), a fresh backend will be created on the next
request rather than the cached one being reused.
This can be used to build general purpose proxies to any kind of
backend that rclone supports.
@@ -667,6 +668,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_serve_http.md
+17 -4
View File
@@ -45,6 +45,10 @@ for a transfer.
`--max-header-bytes` controls the maximum number of bytes the server will
accept in the HTTP header.
`--response-header` can be used to set an HTTP header for all responses,
will overriding existing values. The flag may be repeated to add multiple
headers. Use the format `Header-Name: value`.
`--baseurl` controls the URL prefix that rclone serves from. By default
rclone will serve from the root. If you used `--baseurl "/rclone"` then
rclone would serve from a URL starting with "/rclone/". This is
@@ -68,6 +72,11 @@ https. You will need to supply the `--cert` and `--key` flags.
If you wish to do client side certificate validation then you will need to
supply `--client-ca` also.
When TLS is configured every listener given with `--addr` serves TLS.
An individual listener can be prefixed with `http://` to serve unencrypted
HTTP on that address, or with `tls://` to state explicitly that it must serve
TLS. Using a `tls://` address without `--cert` and `--key` is an error.
`--cert` must be set to the path of a file containing
either a PEM encoded certificate, or a concatenation of that with the CA
certificate. `--key` must be set to the path of a file
@@ -728,10 +737,11 @@ to make proxy to many different sftp backends, you could make the
in the output and the user to `user`. For security you'd probably want
to restrict the `host` to a limited list.
Note that an internal cache is keyed on `user` so only use that for
configuration, don't use `pass` or `public_key`. This also means that if a user's
password or public-key is changed the cache will need to expire (which takes 5 mins)
before it takes effect.
An internal cache of backends is keyed on the `user` and a hash of the
`pass` or `public_key`. This means that if a user's password or
public-key changes, or the proxy returns different config parameters
(eg a rotated `api_key`), a fresh backend will be created on the next
request rather than the cached one being reused.
This can be used to build general purpose proxies to any kind of
backend that rclone supports.
@@ -751,6 +761,7 @@ rclone serve http remote:path [flags]
--client-ca string Client certificate authority to verify clients with
--dir-cache-time Duration Time to cache directory entries for (default 5m0s)
--dir-perms FileMode Directory permissions (default 777)
--disable-dir-list Disable HTML directory list on GET request for a directory
--disable-zip Disable zip download of directories
--file-perms FileMode File permissions (default 666)
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
@@ -767,6 +778,7 @@ rclone serve http remote:path [flags]
--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
--realm string Realm for authentication
--response-header stringArray Set HTTP header for all responses, overriding existing values
--salt string Password hashing salt (default "dlPL2MqE")
--server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
--server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
@@ -812,6 +824,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_serve_nfs.md
+16
View File
@@ -81,6 +81,21 @@ Where `$PORT` is the same port number used in the `serve nfs` command
and `$HOSTNAME` is the network address of the machine that `serve nfs`
was run on.
NFS clients can also mount a subdirectory of the served remote by
including it in the mount path. For example to mount only the
`photos/2024` subdirectory:
```sh
mount -t nfs -o port=$PORT,mountport=$PORT,tcp $HOSTNAME:/photos/2024 path/to/mountpoint
```
The subpath is resolved within the served remote and must refer to an
existing directory (not a file or a symlink). Subpath mounts are a
convenience equivalent to mounting `/` and changing directory: they
share access to the same underlying VFS and the same file handles, so
they do not isolate the client from siblings or parents of the mounted
subdirectory.
If `--vfs-metadata-extension` is in use then for the `--nfs-cache-type disk`
and `--nfs-cache-type cache` the metadata files will have the file
handle of their parent file suffixed with `0x00, 0x00, 0x00, 0x01`.
@@ -639,6 +654,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_serve_restic.md
+10
View File
@@ -122,6 +122,10 @@ for a transfer.
`--max-header-bytes` controls the maximum number of bytes the server will
accept in the HTTP header.
`--response-header` can be used to set an HTTP header for all responses,
will overriding existing values. The flag may be repeated to add multiple
headers. Use the format `Header-Name: value`.
`--baseurl` controls the URL prefix that rclone serves from. By default
rclone will serve from the root. If you used `--baseurl "/rclone"` then
rclone would serve from a URL starting with "/rclone/". This is
@@ -145,6 +149,11 @@ https. You will need to supply the `--cert` and `--key` flags.
If you wish to do client side certificate validation then you will need to
supply `--client-ca` also.
When TLS is configured every listener given with `--addr` serves TLS.
An individual listener can be prefixed with `http://` to serve unencrypted
HTTP on that address, or with `tls://` to state explicitly that it must serve
TLS. Using a `tls://` address without `--cert` and `--key` is an error.
`--cert` must be set to the path of a file containing
either a PEM encoded certificate, or a concatenation of that with the CA
certificate. `--key` must be set to the path of a file
@@ -229,6 +238,7 @@ rclone serve restic remote:path [flags]
--pass string Password for authentication
--private-repos Users can only access their private repo
--realm string Realm for authentication
--response-header stringArray Set HTTP header for all responses, overriding existing values
--salt string Password hashing salt (default "dlPL2MqE")
--server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
--server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
docs/content/commands/rclone_serve_s3.md
+165 -63
View File
@@ -99,19 +99,97 @@ provider = Rclone
endpoint = http://127.0.0.1:8080/
access_key_id = ACCESS_KEY_ID
secret_access_key = SECRET_ACCESS_KEY
use_multipart_uploads = false
```
Note that setting `use_multipart_uploads = false` is to work around
[a bug](#bugs) which will be fixed in due course.
## Multipart uploads
By default `serve s3` **streams** each multipart upload, in part-number
order, into a single `PutStream` upload to the underlying remote, so the
whole file is never buffered in memory - memory use stays bounded by the
parts in flight. The remote then performs its own internal upload (for
example its own multipart upload, still with bounded memory). This works
for any remote that supports `PutStream`, which is nearly all of them,
including through `crypt`.
The upload is atomic so the destination object only ever changes on a
successful completion. A failed or aborted upload never affects any
object already stored under that name. Remotes that upload atomically
already (object stores such as `s3`) are streamed straight to the
destination. On remotes where a partial upload would otherwise be visible
(such as `local`), the parts are streamed to a temporary object that is
moved into place, server-side, on completion; these remotes therefore
also need to support a server-side move or copy.
**Features**
- The whole object is never buffered in memory; memory use is bounded by
the parts in flight, not the upload size.
- Parts can be any size. Clients that don't produce uniform-sized parts
work fine - for example PostgreSQL backup tools such as **pgBarman**
and **pgBackRest**, which flush an upload buffer once it grows past
the chunk size, so each part is the chunk size plus a variable
overshoot.
- Works through `crypt` for any part size, since the object is encrypted
as one continuous stream.
- The destination object only ever changes atomically, on completion: an
aborted or failed upload leaves any pre-existing object of the same
name untouched, and a partly-uploaded object never becomes visible.
- Backend-agnostic - it only needs the remote to support `PutStream`
(plus a server-side move or copy on remotes that don't upload
atomically).
**Limitations**
- Parts must arrive in ascending, contiguous part-number order
(1, 2, 3, ...). Parts the client uploads concurrently or out of order
are buffered until their turn. The memory used for this buffering is
capped, per upload, by `--multipart-streaming-buffer-limit` (default
`256M`, `0` for no limit): a part that would take the buffer over the
limit is stalled until the stream drains, so a client that uploads
faster than the remote can accept sees backpressure rather than
unbounded server memory use. Since a stalled part holds its HTTP
request open, clients whose upload concurrency times chunk size
exceeds the limit may need a longer read timeout when the remote is
slow. Non-contiguous part numbers are rejected on completion.
Configure the client to upload in part order, ideally with low
concurrency, for the lowest memory use.
- A part uploaded again before completion - typically a client retrying
after a timeout - is accepted: if the earlier copy is still buffered
it is replaced, and if it has already been streamed an identical
re-upload is a no-op. What isn't possible is replacing a part that has
already been streamed with *different* content - that is rejected. A
failure in the stream to the remote itself still aborts the whole
upload and the client must start it again. (The remote's own upload
still retries its internal chunks.)
- Parts are serialised into one stream, so ingest from the client is
effectively single-threaded, although the remote's own upload still
runs concurrently.
- On remotes that don't upload atomically (such as `local`), the
completed object is moved into place with a server-side operation.
This is a cheap rename on most such remotes. On these remotes, if
`serve s3` is killed part-way through an upload the temporary object
(named with a leading `.rclone_multipart_upload_`) may be left behind;
it is hidden from S3 listings but must be removed manually.
### Disabling streaming
If you pass `--disable-multipart-streaming`, or the remote doesn't
support `PutStream` (or doesn't upload atomically and can't move or copy
server-side), multipart uploads are instead **buffered in memory**
by the underlying S3 library: every part is held in memory and the whole
object is written out in one go when the upload completes (the previous
behaviour). This removes the in-order/contiguous-part restriction above,
so parts can be uploaded in any order, but **memory use grows with the
size of the upload**, so it is only suitable for small objects. A one-off
`NOTICE` is logged the first time this happens.
Alternatively, if the client is an rclone `s3` remote (like the
`[serves3]` example above), you can set `use_multipart_uploads = false`
on it so it uploads each object as a single stream and skips multipart
uploads altogether.
## Bugs
When uploading multipart files `serve s3` holds all the parts in
memory (see [#7453](https://github.com/rclone/rclone/issues/7453)).
This is a limitaton of the library rclone uses for serving S3 and will
hopefully be fixed at some point.
Multipart server side copies do not work (see
[#7454](https://github.com/rclone/rclone/issues/7454)). These take a
very long time and eventually fail. The default threshold for
@@ -144,6 +222,17 @@ Versioning is not currently supported.
Metadata will only be saved in memory other than the rclone `mtime`
metadata which will be set as the modification time of the file.
## Object names
`serve s3` stores objects as files in the backend, so object keys are
mapped to file paths rather than treated as the opaque strings AWS S3
allows. Keys must be in canonical path form: keys that contain `..` or
`.` path segments, repeated slashes (`//`), or a leading or trailing
slash are rejected with a `400 Bad Request` (`InvalidArgument`)
instead of being normalised, since normalising them could alias two
distinct keys to the same file or resolve a key outside its bucket.
This matches the behaviour of other S3 servers such as MinIO.
## Supported operations
`serve s3` currently supports the following operations.
@@ -224,6 +313,10 @@ for a transfer.
`--max-header-bytes` controls the maximum number of bytes the server will
accept in the HTTP header.
`--response-header` can be used to set an HTTP header for all responses,
will overriding existing values. The flag may be repeated to add multiple
headers. Use the format `Header-Name: value`.
`--baseurl` controls the URL prefix that rclone serves from. By default
rclone will serve from the root. If you used `--baseurl "/rclone"` then
rclone would serve from a URL starting with "/rclone/". This is
@@ -247,6 +340,11 @@ https. You will need to supply the `--cert` and `--key` flags.
If you wish to do client side certificate validation then you will need to
supply `--client-ca` also.
When TLS is configured every listener given with `--addr` serves TLS.
An individual listener can be prefixed with `http://` to serve unencrypted
HTTP on that address, or with `tls://` to state explicitly that it must serve
TLS. Using a `tls://` address without `--cert` and `--key` is an error.
`--cert` must be set to the path of a file containing
either a PEM encoded certificate, or a concatenation of that with the CA
certificate. `--key` must be set to the path of a file
@@ -771,61 +869,64 @@ rclone serve s3 remote:path [flags]
## Options
```
--addr stringArray IPaddress:Port or :Port to bind server to (default 127.0.0.1:8080)
--allow-origin string Origin which cross-domain request (CORS) can be executed from
--auth-key stringArray Set key pair for v4 authorization: access_key_id,secret_access_key
--auth-proxy string A program to use to create the backend from the auth
--baseurl string Prefix for URLs - leave blank for root
--cert string TLS PEM key (concatenation of certificate and CA certificate)
--client-ca string Client certificate authority to verify clients with
--dir-cache-time Duration Time to cache directory entries for (default 5m0s)
--dir-perms FileMode Directory permissions (default 777)
--etag-hash string Which hash to use for the ETag, or auto or blank for off (default "MD5")
--file-perms FileMode File permissions (default 666)
--force-path-style If true use path style access if false use virtual hosted style (default true)
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
-h, --help help for s3
--htpasswd string A htpasswd file - if not provided no authentication is done
--key string TLS PEM Private key
--link-perms FileMode Link permissions (default 666)
--max-header-bytes int Maximum size of request header (default 4096)
--min-tls-version string Minimum TLS version that is acceptable (default "tls1.0")
--no-checksum Don't compare checksums on up/download
--no-cleanup Not to cleanup empty folder after object is deleted
--no-modtime Don't read/write the modification time (can speed things up)
--no-seek Don't allow seeking in files
--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
--realm string Realm for authentication
--salt string Password hashing salt (default "dlPL2MqE")
--server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
--server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
--umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002)
--user string User name for authentication
--user-from-header string User name from a defined HTTP header
--vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
--vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s)
--vfs-case-insensitive If a file name not found, find a case insensitive match
--vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off)
--vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection
--vfs-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
--vfs-read-chunk-streams int The number of parallel streams to read at once
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
--vfs-refresh Refreshes the directory cache recursively in the background on start
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
--addr stringArray IPaddress:Port or :Port to bind server to (default 127.0.0.1:8080)
--allow-origin string Origin which cross-domain request (CORS) can be executed from
--auth-key stringArray Set key pair for v4 authorization: access_key_id,secret_access_key
--auth-proxy string A program to use to create the backend from the auth
--baseurl string Prefix for URLs - leave blank for root
--cert string TLS PEM key (concatenation of certificate and CA certificate)
--client-ca string Client certificate authority to verify clients with
--dir-cache-time Duration Time to cache directory entries for (default 5m0s)
--dir-perms FileMode Directory permissions (default 777)
--disable-multipart-streaming Buffer multipart uploads in memory instead of streaming them to the backend (see the Multipart uploads docs section)
--etag-hash string Which hash to use for the ETag, or auto or blank for off (default "MD5")
--file-perms FileMode File permissions (default 666)
--force-path-style If true use path style access if false use virtual hosted style (default true)
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
-h, --help help for s3
--htpasswd string A htpasswd file - if not provided no authentication is done
--key string TLS PEM Private key
--link-perms FileMode Link permissions (default 666)
--max-header-bytes int Maximum size of request header (default 4096)
--min-tls-version string Minimum TLS version that is acceptable (default "tls1.0")
--multipart-streaming-buffer-limit SizeSuffix Maximum memory buffered per streamed multipart upload for parts arriving out of order, 0 for unlimited (see the Multipart uploads docs section) (default 256Mi)
--no-checksum Don't compare checksums on up/download
--no-cleanup Not to cleanup empty folder after object is deleted
--no-modtime Don't read/write the modification time (can speed things up)
--no-seek Don't allow seeking in files
--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
--realm string Realm for authentication
--response-header stringArray Set HTTP header for all responses, overriding existing values
--salt string Password hashing salt (default "dlPL2MqE")
--server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
--server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
--umask FileMode Override the permission bits set by the filesystem (not supported on Windows) (default 002)
--user string User name for authentication
--user-from-header string User name from a defined HTTP header
--vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost)
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
--vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off)
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
--vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s)
--vfs-case-insensitive If a file name not found, find a case insensitive match
--vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off)
--vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection
--vfs-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi)
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached ('off' is unlimited) (default off)
--vfs-read-chunk-streams int The number of parallel streams to read at once
--vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms)
--vfs-refresh Refreshes the directory cache recursively in the background on start
--vfs-used-is-size rclone size Use the rclone size algorithm for Used size
--vfs-write-back Duration Time to writeback files after last use when using cache (default 5s)
--vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)
```
Options shared with other commands are described next.
@@ -842,6 +943,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_serve_sftp.md
+6 -4
View File
@@ -641,10 +641,11 @@ to make proxy to many different sftp backends, you could make the
in the output and the user to `user`. For security you'd probably want
to restrict the `host` to a limited list.
Note that an internal cache is keyed on `user` so only use that for
configuration, don't use `pass` or `public_key`. This also means that if a user's
password or public-key is changed the cache will need to expire (which takes 5 mins)
before it takes effect.
An internal cache of backends is keyed on the `user` and a hash of the
`pass` or `public_key`. This means that if a user's password or
public-key changes, or the proxy returns different config parameters
(eg a rotated `api_key`), a fresh backend will be created on the next
request rather than the cached one being reused.
This can be used to build general purpose proxies to any kind of
backend that rclone supports.
@@ -714,6 +715,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_serve_webdav.md
+23 -4
View File
@@ -26,6 +26,13 @@ supported hash on the backend or you can use a named hash such as
"MD5" or "SHA-1". Use the [hashsum](/commands/rclone_hashsum/) command
to see the full list.
## Gzip compression
The server will compress certain response bodies (text and XML, including
WebDAV PROPFIND responses) using gzip when the client advertises gzip
support via the `Accept-Encoding: gzip` request header. This reduces
bandwidth usage.
## Access WebDAV on Windows
WebDAV shared folder can be mapped as a drive on Windows, however the default
@@ -115,6 +122,10 @@ for a transfer.
`--max-header-bytes` controls the maximum number of bytes the server will
accept in the HTTP header.
`--response-header` can be used to set an HTTP header for all responses,
will overriding existing values. The flag may be repeated to add multiple
headers. Use the format `Header-Name: value`.
`--baseurl` controls the URL prefix that rclone serves from. By default
rclone will serve from the root. If you used `--baseurl "/rclone"` then
rclone would serve from a URL starting with "/rclone/". This is
@@ -138,6 +149,11 @@ https. You will need to supply the `--cert` and `--key` flags.
If you wish to do client side certificate validation then you will need to
supply `--client-ca` also.
When TLS is configured every listener given with `--addr` serves TLS.
An individual listener can be prefixed with `http://` to serve unencrypted
HTTP on that address, or with `tls://` to state explicitly that it must serve
TLS. Using a `tls://` address without `--cert` and `--key` is an error.
`--cert` must be set to the path of a file containing
either a PEM encoded certificate, or a concatenation of that with the CA
certificate. `--key` must be set to the path of a file
@@ -798,10 +814,11 @@ to make proxy to many different sftp backends, you could make the
in the output and the user to `user`. For security you'd probably want
to restrict the `host` to a limited list.
Note that an internal cache is keyed on `user` so only use that for
configuration, don't use `pass` or `public_key`. This also means that if a user's
password or public-key is changed the cache will need to expire (which takes 5 mins)
before it takes effect.
An internal cache of backends is keyed on the `user` and a hash of the
`pass` or `public_key`. This means that if a user's password or
public-key changes, or the proxy returns different config parameters
(eg a rotated `api_key`), a fresh backend will be created on the next
request rather than the cached one being reused.
This can be used to build general purpose proxies to any kind of
backend that rclone supports.
@@ -839,6 +856,7 @@ rclone serve webdav remote:path [flags]
--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
--realm string Realm for authentication
--response-header stringArray Set HTTP header for all responses, overriding existing values
--salt string Password hashing salt (default "dlPL2MqE")
--server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
--server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
@@ -884,6 +902,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_sha1sum.md
+1
View File
@@ -58,6 +58,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_size.md
+1
View File
@@ -53,6 +53,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_sync.md
+1
View File
@@ -211,6 +211,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_touch.md
+1
View File
@@ -73,6 +73,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/commands/rclone_tree.md
+1
View File
@@ -80,6 +80,7 @@ Flags for filtering directory listings
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
docs/content/drime.md
+1 -1
View File
@@ -234,7 +234,7 @@ Properties:
- Config: upload_cutoff
- Env Var: RCLONE_DRIME_UPLOAD_CUTOFF
- Type: SizeSuffix
- Default: 200Mi
- Default: 5Mi
#### --drime-chunk-size
docs/content/drive.md
-11
View File
@@ -702,17 +702,6 @@ Properties:
- Type: string
- Required: false
#### --drive-alternate-export
Deprecated: No longer needed.
Properties:
- Config: alternate_export
- Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT
- Type: bool
- Default: false
### Advanced options
Here are the Advanced options specific to drive (Google Drive).
docs/content/dropbox.md
+70 -11
View File
@@ -368,6 +368,34 @@ Properties:
- Type: string
- Required: false
#### --dropbox-impersonate-admin
Team admin ID to use when performing actions as a team administrator.
This sets the Dropbox-API-Select-Admin header with the given team
member ID (for example "dbmid:...").
This takes a team member ID directly rather than an email address.
Note that if you want to use impersonate_admin, you should make sure this
flag is set when running "rclone config" as this will cause rclone to
request the "team_data.member" scope which it won't normally.
Using the "team_data.member" scope will require a Dropbox Team Admin
to approve during the OAuth flow.
You will have to use your own App (setting your own client_id and
client_secret) to use this option as currently rclone's default set of
permissions doesn't include "team_data.member".
Properties:
- Config: impersonate_admin
- Env Var: RCLONE_DROPBOX_IMPERSONATE_ADMIN
- Type: string
- Required: false
#### --dropbox-shared-files
Instructs rclone to work on individual shared files.
@@ -408,6 +436,48 @@ Properties:
- Type: bool
- Default: false
#### --dropbox-skip-shared-folders
Instructs rclone to skip all shared folders.
When set, any folder that is a shared folder mount point will be
excluded from directory listings, regardless of ownership.
This is useful if you prefer to back up shared folders separately
using a separate remote configured with the shared folder namespace.
Properties:
- Config: skip_shared_folders
- Env Var: RCLONE_DROPBOX_SKIP_SHARED_FOLDERS
- Type: bool
- Default: false
#### --dropbox-skip-unowned-folders
Instructs rclone to skip shared folders not owned by the current user.
When set, any folder that is a shared folder mount point and not
owned by the current user will be excluded from directory listings.
This is useful when backing up multiple Dropbox accounts that share
common folders, to avoid duplicating the shared data across accounts.
Note: In Dropbox Business, 'Team Folders' are owned by the Team.
For standard team members, these folders evaluate as 'unowned'
(editor/viewer access) and will be excluded by this flag. To back up
Team Folders, do not use this flag or run the backup using a Team Admin
account.
If --dropbox-skip-shared-folders is also enabled, this flag has no effect.
This makes an extra API call per shared folder mount point.
Properties:
- Config: skip_unowned_folders
- Env Var: RCLONE_DROPBOX_SKIP_UNOWNED_FOLDERS
- Type: bool
- Default: false
#### --dropbox-pacer-min-sleep
Minimum time to sleep between API calls.
@@ -568,17 +638,6 @@ Properties:
- Type: Duration
- Default: 0s
#### --dropbox-batch-commit-timeout
Max time to wait for a batch to finish committing. (no longer used)
Properties:
- Config: batch_commit_timeout
- Env Var: RCLONE_DROPBOX_BATCH_COMMIT_TIMEOUT
- Type: Duration
- Default: 10m0s
#### --dropbox-description
Description of the remote.
docs/content/flags.md
+25 -5
View File
@@ -121,7 +121,7 @@ Flags for general networking and HTTP stuff.
--tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar
--user-agent string Set the user-agent to a specified string (default "rclone/v1.74.0")
--user-agent string Set the user-agent to a specified string (default "rclone/v1.75.0")
```
@@ -174,7 +174,7 @@ Flags for developers.
```
--cpuprofile string Write cpu profile to file
--dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper, curl
--dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper, curl, errors, trace
--dump-bodies Dump HTTP headers and bodies - may contain sensitive info
--dump-headers Dump HTTP headers - may contain sensitive info
--memprofile string Write memory profile to file
@@ -192,6 +192,7 @@ Flags for filtering directory listings.
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
--files-from0 stringArray Read list of source-file names from file using NUL as separator (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--hash-filter string Partition filenames by hash k/n or randomly @/n
@@ -292,6 +293,7 @@ Flags to control the Remote Control API.
--rc-no-auth Don't require auth for certain methods
--rc-pass string Password for authentication
--rc-realm string Realm for authentication
--rc-response-header stringArray Set HTTP header for all responses, overriding existing values
--rc-salt string Password hashing salt (default "dlPL2MqE")
--rc-serve Enable the serving of remote objects
--rc-serve-no-modtime Don't read the modification time (can speed things up)
@@ -313,7 +315,7 @@ Flags to control the Remote Control API.
Flags to control the Metrics HTTP endpoint..
```
--metrics-addr stringArray IPaddress:Port or :Port to bind metrics server to
--metrics-addr stringArray IPaddress:Port or :Port to bind server to
--metrics-allow-origin string Origin which cross-domain request (CORS) can be executed from
--metrics-baseurl string Prefix for URLs - leave blank for root
--metrics-cert string TLS PEM key (concatenation of certificate and CA certificate)
@@ -324,6 +326,7 @@ Flags to control the Metrics HTTP endpoint..
--metrics-min-tls-version string Minimum TLS version that is acceptable (default "tls1.0")
--metrics-pass string Password for authentication
--metrics-realm string Realm for authentication
--metrics-response-header stringArray Set HTTP header for all responses, overriding existing values
--metrics-salt string Password hashing salt (default "dlPL2MqE")
--metrics-server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
--metrics-server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
@@ -519,7 +522,7 @@ Backend-only flags (these can be set in the config file also).
--drime-list-chunk int Number of items to list in each call (default 1000)
--drime-root-folder-id string ID of the root folder
--drime-upload-concurrency int Concurrency for multipart uploads and copies (default 4)
--drime-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
--drime-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 5Mi)
--drime-workspace-id string Account ID
--drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded
--drive-allow-import-name-change Allow the filetype to change when uploading Google docs
@@ -528,7 +531,7 @@ Backend-only flags (these can be set in the config file also).
--drive-chunk-size SizeSuffix Upload chunk size (default 8Mi)
--drive-client-credentials Use client credentials OAuth flow
--drive-client-id string Google Application Client Id
--drive-client-secret string OAuth Client Secret
--drive-client-secret string Google Application Client Secret
--drive-copy-shortcut-content Server side copy contents of shortcuts instead of the shortcut
--drive-description string Description of the remote
--drive-disable-http2 Disable drive using http2 (default true)
@@ -584,12 +587,15 @@ Backend-only flags (these can be set in the config file also).
--dropbox-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot)
--dropbox-export-formats CommaSepList Comma separated list of preferred formats for exporting files (default html,md)
--dropbox-impersonate string Impersonate this user when using a business account
--dropbox-impersonate-admin string Team admin ID to use when performing actions as a team administrator
--dropbox-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms)
--dropbox-root-namespace string Specify a different Dropbox namespace ID to use as the root for all paths
--dropbox-shared-files Instructs rclone to work on individual shared files
--dropbox-shared-folders Instructs rclone to work on shared folders
--dropbox-show-all-exports Show all exportable files in listings
--dropbox-skip-exports Skip exportable files in all listings
--dropbox-skip-shared-folders Instructs rclone to skip all shared folders
--dropbox-skip-unowned-folders Instructs rclone to skip shared folders not owned by the current user
--dropbox-token string OAuth Access Token as a JSON blob
--dropbox-token-url string Token server url
--fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl
@@ -805,8 +811,10 @@ Backend-only flags (these can be set in the config file also).
--local-case-sensitive Force the filesystem to report itself as case sensitive
--local-description string Description of the remote
--local-encoding Encoding The encoding for the backend (default Slash,Dot)
--local-fatal-if-no-space Make out-of-space errors fatal during transfers
--local-hashes CommaSepList Comma separated list of supported checksum types
--local-links Translate symlinks to/from regular files with a '.rclonelink' extension for the local backend
--local-metadata-restore-special-bits Restore the setuid, setgid and sticky bits from metadata
--local-no-check-updated Don't check to see if the files change during upload
--local-no-clone Disable reflink cloning for server-side copies
--local-no-preallocate Disable preallocation of disk space for transferred files
@@ -872,6 +880,7 @@ Backend-only flags (these can be set in the config file also).
--onedrive-root-folder-id string ID of the root folder
--onedrive-server-side-across-configs Deprecated: use --server-side-across-configs instead
--onedrive-tenant string ID of the service principal's tenant. Also called its directory ID
--onedrive-tenant-url string The tenant URL for non-admin OneDrive access
--onedrive-token string OAuth Access Token as a JSON blob
--onedrive-token-url string Token server url
--onedrive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default off)
@@ -882,6 +891,7 @@ Backend-only flags (these can be set in the config file also).
--oos-config-profile string Profile name inside the oci config file (default "Default")
--oos-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi)
--oos-copy-timeout Duration Timeout for copy (default 1m0s)
--oos-decompress If set this will decompress gzip encoded objects
--oos-description string Description of the remote
--oos-disable-checksum Don't store MD5 checksum with object metadata
--oos-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot)
@@ -1079,9 +1089,11 @@ Backend-only flags (these can be set in the config file also).
--sftp-disable-concurrent-reads If set don't use concurrent reads
--sftp-disable-concurrent-writes If set don't use concurrent writes
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available
--sftp-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,Dot)
--sftp-hashes CommaSepList Comma separated list of supported checksum types
--sftp-host string SSH host to connect to
--sftp-host-key-algorithms SpaceSepList Space separated list of host key algorithms, ordered by preference
--sftp-host-keys CommaSepList Pinned host keys for this remote, used to verify the server
--sftp-http-proxy string URL for HTTP CONNECT proxy
--sftp-idle-timeout Duration Max time before closing idle connections (default 1m0s)
--sftp-key-exchange SpaceSepList Space separated list of key exchange algorithms, ordered by preference
@@ -1094,6 +1106,7 @@ Backend-only flags (these can be set in the config file also).
--sftp-md5sum-command string The command used to read MD5 hashes
--sftp-pass string SSH password, leave blank to use ssh-agent (obscured)
--sftp-path-override string Override path used by SSH shell commands
--sftp-pin-host-key Pin the server host key on first connection (Trust On First Use)
--sftp-port int SSH port number (default 22)
--sftp-pubkey string SSH public certificate for public certificate based authentication
--sftp-pubkey-file string Optional path to public key file
@@ -1238,15 +1251,22 @@ Backend-only flags (these can be set in the config file also).
--yandex-spoof-ua Set the user agent to match an official version of the yandex disk client. May help with upload performance (default true)
--yandex-token string OAuth Access Token as a JSON blob
--yandex-token-url string Token server url
--yandex-upload-wait Duration Wait this long after an upload before setting the modification time (default 0s)
--zoho-auth-url string Auth server URL
--zoho-client-credentials Use client credentials OAuth flow
--zoho-client-id string OAuth Client Id
--zoho-client-secret string OAuth Client Secret
--zoho-description string Description of the remote
--zoho-encoding Encoding The encoding for the backend (default Del,Ctl,InvalidUtf8)
--zoho-list-folder-burst int Same-folder listings allowed back-to-back before --zoho-list-folder-limit paces them (default 6)
--zoho-list-folder-limit int Max listings of the SAME folder allowed per --zoho-list-folder-window (default 19)
--zoho-list-folder-window Duration The window for --zoho-list-folder-limit (default 1m0s)
--zoho-region string Zoho region to connect to
--zoho-root-folder-id string ID of the root folder
--zoho-token string OAuth Access Token as a JSON blob
--zoho-token-url string Token server url
--zoho-tpslimit float Max number of API transactions per second (default 6)
--zoho-tpslimit-burst int Number of API calls to allow back-to-back without sleeping, for --zoho-tpslimit (default 1)
--zoho-upload-cutoff SizeSuffix Cutoff for switching to large file upload api (>= 10 MiB) (default 10Mi)
```
docs/content/googlecloudstorage.md
-14
View File
@@ -428,20 +428,6 @@ Properties:
- Type: string
- Required: false
#### --gcs-service-account-credentials
Service Account Credentials JSON blob.
Leave blank normally.
Needed only if you want use SA instead of interactive login.
Properties:
- Config: service_account_credentials
- Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS
- Type: string
- Required: false
#### --gcs-anonymous
Access public buckets and objects without credentials.
docs/content/googlephotos.md
-11
View File
@@ -533,17 +533,6 @@ Properties:
- Type: Duration
- Default: 0s
#### --gphotos-batch-commit-timeout
Max time to wait for a batch to finish committing. (no longer used)
Properties:
- Config: batch_commit_timeout
- Env Var: RCLONE_GPHOTOS_BATCH_COMMIT_TIMEOUT
- Type: Duration
- Default: 10m0s
#### --gphotos-description
Description of the remote.
docs/content/iclouddrive.md
-22
View File
@@ -274,28 +274,6 @@ Properties:
- Type: string
- Required: true
#### --iclouddrive-trust-token
Trust token for session authentication.
Properties:
- Config: trust_token
- Env Var: RCLONE_ICLOUDDRIVE_TRUST_TOKEN
- Type: string
- Required: false
#### --iclouddrive-cookies
Session cookies.
Properties:
- Config: cookies
- Env Var: RCLONE_ICLOUDDRIVE_COOKIES
- Type: string
- Required: false
### Advanced options
Here are the Advanced options specific to iclouddrive (iCloud Drive and Photos).
docs/content/imagekit.md
+1
View File
@@ -227,6 +227,7 @@ Here are the possible system metadata items for the imagekit backend.
| has-alpha | Whether the image has alpha channel or not | bool | | **Y** |
| height | Height of the image or video in pixels | int | | **Y** |
| is-private-file | Whether the file is private or not | bool | | **Y** |
| mtime | Time of last modification, read from the file's updatedAt field | RFC 3339 | 2006-01-02T15:04:05.999999999Z07:00 | **Y** |
| size | Size of the object in bytes | int64 | | **Y** |
| tags | Tags associated with the file | string | tag1,tag2 | **Y** |
| width | Width of the image or video in pixels | int | | **Y** |
docs/content/internxt.md
-11
View File
@@ -137,17 +137,6 @@ Properties:
Here are the Advanced options specific to internxt (Internxt Drive).
#### --internxt-mnemonic
Mnemonic (internal use only)
Properties:
- Config: mnemonic
- Env Var: RCLONE_INTERNXT_MNEMONIC
- Type: string
- Required: false
#### --internxt-skip-hash-validation
Skip hash validation when downloading files.
docs/content/linkbox.md
-11
View File
@@ -117,17 +117,6 @@ Properties:
- Type: string
- Required: true
#### --linkbox-web-token
Web API login token - set automatically.
Properties:
- Config: web_token
- Env Var: RCLONE_LINKBOX_WEB_TOKEN
- Type: string
- Required: false
### Advanced options
Here are the Advanced options specific to linkbox (Linkbox).
docs/content/local.md
+48
View File
@@ -637,6 +637,47 @@ Properties:
- Type: bool
- Default: false
#### --local-metadata-restore-special-bits
Restore the setuid, setgid and sticky bits from metadata.
When restoring metadata with --metadata rclone applies the "mode" from
the source. By default rclone applies only the permission bits and
strips the setuid, setgid and sticky bits.
The "mode" comes from the source remote which may not be trusted.
Restoring a setuid or setgid bit onto freshly written,
source-controlled content can plant a setuid binary, which is dangerous
in particular when restoring from an untrusted source while running as
root. For this reason these bits are not restored by default.
If you trust the source and want the setuid, setgid and sticky bits
restored - for example when restoring a system backup made by rclone -
set this flag.
Properties:
- Config: metadata_restore_special_bits
- Env Var: RCLONE_LOCAL_METADATA_RESTORE_SPECIAL_BITS
- Type: bool
- Default: false
#### --local-fatal-if-no-space
Make out-of-space errors fatal during transfers.
When enabled, an ENOSPC error during a write returns a fatal error so
that rclone aborts rather than retrying the operation. Useful for
backup scripts that should halt loudly on a full disk rather than spin
retrying.
Properties:
- Config: fatal_if_no_space
- Env Var: RCLONE_LOCAL_FATAL_IF_NO_SPACE
- Type: bool
- Default: false
#### --local-time-type
Set what kind of time is returned.
@@ -723,6 +764,13 @@ supported by all file systems) under the "user.*" prefix.
Metadata is supported on files and directories.
When restoring metadata with `--metadata` rclone applies the
"mode", "uid" and "gid" from the source. These come from the source
remote which may not be trusted, so restoring metadata as root from an
untrusted source can change file ownership and is not recommended. The
setuid, setgid and sticky bits are not restored by default - see the
`--local-metadata-restore-special-bits` flag.
Here are the possible system metadata items for the local backend.
| Name | Help | Type | Example | Read Only |
docs/content/mailru.md
-30
View File
@@ -403,36 +403,6 @@ Properties:
- "false"
- Ignore and continue.
#### --mailru-user-agent
HTTP user agent used internally by client.
Defaults to "rclone/VERSION" or "--user-agent" provided on command line.
Properties:
- Config: user_agent
- Env Var: RCLONE_MAILRU_USER_AGENT
- Type: string
- Required: false
#### --mailru-quirks
Comma separated list of internal maintenance flags.
This option must not be used by an ordinary user. It is intended only to
facilitate remote troubleshooting of backend issues. Strict meaning of
flags is not documented and not guaranteed to persist between releases.
Quirks will be removed when the backend grows stable.
Supported quirks: atomicmkdir binlist unknowndirs
Properties:
- Config: quirks
- Env Var: RCLONE_MAILRU_QUIRKS
- Type: string
- Required: false
#### --mailru-encoding
The encoding for the backend.
docs/content/mega.md
-22
View File
@@ -247,28 +247,6 @@ Properties:
Here are the Advanced options specific to mega (Mega).
#### --mega-session-id
Session (internal use only)
Properties:
- Config: session_id
- Env Var: RCLONE_MEGA_SESSION_ID
- Type: string
- Required: false
#### --mega-master-key
Master key (internal use only)
Properties:
- Config: master_key
- Env Var: RCLONE_MEGA_MASTER_KEY
- Type: string
- Required: false
#### --mega-debug
Output more debug from Mega.
docs/content/onedrive.md
+31 -17
View File
@@ -504,6 +504,27 @@ Properties:
- Type: SizeSuffix
- Default: off
#### --onedrive-tenant-url
The tenant URL for non-admin OneDrive access.
Set this to your SharePoint tenant URL to use the SharePoint v2.0 API
endpoint instead of the standard Microsoft Graph API. This allows
accessing business OneDrive without admin consent.
The URL can be found in your browser's developer tools by searching
for "driveAccessToken" in the network requests. Look for the
".driveUrl" field which contains the tenant URL and drive ID.
Example: https://your-tenant.sharepoint.com/_api
Properties:
- Config: tenant_url
- Env Var: RCLONE_ONEDRIVE_TENANT_URL
- Type: string
- Required: false
#### --onedrive-chunk-size
Chunk size to upload files with - must be multiple of 320k (327,680 bytes).
@@ -579,23 +600,6 @@ Properties:
- Read and write access to all resources, without the ability to browse SharePoint sites.
- Same as if disable_site_permission was set to true
#### --onedrive-disable-site-permission
Disable the request for Sites.Read.All permission.
If set to true, you will no longer be able to search for a SharePoint site when
configuring drive ID, because rclone will not request Sites.Read.All permission.
Set it to true if your organization didn't assign Sites.Read.All permission to the
application, and your organization disallows users to consent app permission
request on their own.
Properties:
- Config: disable_site_permission
- Env Var: RCLONE_ONEDRIVE_DISABLE_SITE_PERMISSION
- Type: bool
- Default: false
#### --onedrive-expose-onenote-files
Set to make OneNote files show up in directory listings.
@@ -793,6 +797,16 @@ If you are 100% sure you want to download this file anyway then use
the --onedrive-av-override flag, or av_override = true in the config
file.
When set, malware-flagged files are downloaded via Microsoft Graph
beta APIs with Prefer: forceInfectedDownload (contentStream, then
/content). Clean files continue to use the stable v1.0 endpoint.
This is a beta API and may change. It works reliably with application
permissions (client_credentials). With delegated (user) login on
OneDrive for Business, Microsoft often still blocks the download.
tenant_url configurations fall back to the legacy AVOverride query
parameter.
Properties:
docs/content/oracleobjectstorage/_index.md
+21
View File
@@ -748,6 +748,27 @@ Properties:
- "AES256"
- AES256
#### --oos-decompress
If set this will decompress gzip encoded objects.
It is possible to upload objects to object storage with
"Content-Encoding: gzip" set. Normally rclone will download these
files as compressed objects.
If this flag is set then rclone will decompress these files with
"Content-Encoding: gzip" as they are received. This means that rclone
can't check the size and hash but the file contents will be
decompressed.
Properties:
- Config: decompress
- Env Var: RCLONE_OOS_DECOMPRESS
- Type: bool
- Default: false
#### --oos-description
Description of the remote.
docs/content/premiumizeme.md
-14
View File
@@ -144,20 +144,6 @@ Properties:
- Type: string
- Required: false
#### --premiumizeme-api-key
API Key.
This is not normally used - use oauth instead.
Properties:
- Config: api_key
- Env Var: RCLONE_PREMIUMIZEME_API_KEY
- Type: string
- Required: false
### Advanced options
Here are the Advanced options specific to premiumizeme (premiumize.me).
docs/content/protondrive.md
-44
View File
@@ -218,50 +218,6 @@ Properties:
- Type: string
- Required: false
#### --protondrive-client-uid
Client uid key (internal use only)
Properties:
- Config: client_uid
- Env Var: RCLONE_PROTONDRIVE_CLIENT_UID
- Type: string
- Required: false
#### --protondrive-client-access-token
Client access token key (internal use only)
Properties:
- Config: client_access_token
- Env Var: RCLONE_PROTONDRIVE_CLIENT_ACCESS_TOKEN
- Type: string
- Required: false
#### --protondrive-client-refresh-token
Client refresh token key (internal use only)
Properties:
- Config: client_refresh_token
- Env Var: RCLONE_PROTONDRIVE_CLIENT_REFRESH_TOKEN
- Type: string
- Required: false
#### --protondrive-client-salted-key-pass
Client salted key pass key (internal use only)
Properties:
- Config: client_salted_key_pass
- Env Var: RCLONE_PROTONDRIVE_CLIENT_SALTED_KEY_PASS
- Type: string
- Required: false
#### --protondrive-encoding
The encoding for the backend.
docs/content/rc.md
+45 -9
View File
@@ -847,6 +847,29 @@ Returns
See the [listremotes](/commands/rclone_listremotes/) command for more information on the above.
### config/oauthstatus: Get the status of the OAuth authentication server. {#config-oauthstatus}
Returns the current status of the OAuth authentication server.
Returns a JSON object:
- status - "running" or "stopped"
- authUrl - URL for the authorization (only if status is "running")
Eg
{
"status": "running",
"authUrl": "http://127.0.0.1:53682/auth?state=..."
}
### config/oauthstop: Stop any running OAuth authentication server. {#config-oauthstop}
Stops the OAuth authentication server if one is running.
This can be used to recover from an interrupted OAuth flow without
restarting rclone. If no OAuth authentication is in progress, an error
is returned.
### config/password: password the config for a remote. {#config-password}
This takes the following parameters:
@@ -903,6 +926,19 @@ Parameters:
A good idea is to disable AskPassword before making this call
### config/unset: Unset keys in a remote in the config file. {#config-unset}
Parameters:
- name - name of remote
- keys - a list of key names to remove
Returns:
- removed - a list of the keys that were actually removed
See the [config unset](/commands/rclone_config_unset/) command for more information on the above.
### config/update: update the config for a remote. {#config-update}
This takes the following parameters:
@@ -922,13 +958,6 @@ This takes the following parameters:
See the [config update](/commands/rclone_config_update/) command for more information on the above.
**Reconnecting a remote:** Calling `config/update` with empty
`parameters` runs the post-config / authorize flow, equivalent to
`rclone config reconnect`. This can be used to re-authenticate a
remote (e.g. refresh an OAuth token):
rclone rc config/update name=myremote parameters={} opt={"nonInteractive": true}
### core/bwlimit: Set the bandwidth limit. {#core-bwlimit}
This sets the bandwidth limit to the string passed in. This should be
@@ -1476,6 +1505,10 @@ This takes the following parameters:
- mountOpt: a JSON object with Mount options in.
- vfsOpt: a JSON object with VFS options in.
Alternatively, you can pass VFS and Mount options flat at the top level of the parameter map. The option names are the same as their CLI flags without '--' and with '-' replaced by '_' (e.g. 'vfs_cache_mode' instead of 'CacheMode' inside 'vfsOpt', and 'volname' instead of 'VolName' inside 'mountOpt').
If both flat parameters and nested 'vfsOpt'/'mountOpt' blocks are supplied, the parameters in the nested blocks will take precedence.
On Windows mountPoint may be set to "*" to assign the next available
drive letter automatically, or a network share UNC path (e.g.
"\\server\share") to mount as a network drive. In these cases the
@@ -1493,6 +1526,7 @@ Example:
rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint
rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint mountType=mount
rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}'
rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfs_cache_mode=writes volname=MyTestVolume
rclone rc mount/mount fs=mydrive: mountPoint=* mountType=cmount
```
@@ -2226,13 +2260,15 @@ Other parameters are as described in the documentation for the
relevant [rclone serve](/commands/rclone_serve/) command line options.
To translate a command line option to an rc parameter, remove the
leading `--` and replace `-` with `_`, so `--vfs-cache-mode` becomes
`vfs_cache_mode`. Note that global parameters must be set with
`_config` and `_filter` as described above.
`vfs_cache_mode`.
Option parameters (such as VFS, proxy, and protocol-specific options) can be passed flat at the top level of the parameter map or inside nested JSON objects under the `vfsOpt`, `proxyOpt`, and `opt` keys (e.g. `vfsOpt='{"CacheMode": 2}'`, `proxyOpt='{"AuthProxy": "http://127.0.0.1:8080"}'`). If both flat parameters and nested blocks are supplied, the parameters in the nested blocks will take precedence. Note that global parameters must be set with `_config` and `_filter` as described above.
Examples:
rclone rc serve/start type=nfs fs=remote: addr=:4321 vfs_cache_mode=full
rclone rc serve/start --json '{"type":"nfs","fs":"remote:","addr":":1234","vfs_cache_mode":"full"}'
rclone rc serve/start type=webdav fs=remote: vfsOpt='{"CacheMode": 2}' proxyOpt='{"AuthProxy": "http://127.0.0.1:8080"}'
This will give the reply
docs/content/s3.md
+82 -57
View File
@@ -967,7 +967,7 @@ mode from COMPLIANCE to GOVERNANCE while preserving the original retention date:
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/s3/s3.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options
Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly, FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata, Other).
Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly, FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, Scality, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata, ZeroServices, Other).
#### --s3-provider
@@ -1058,6 +1058,8 @@ Properties:
- Rclone S3 Server
- "Scaleway"
- Scaleway Object Storage
- "Scality"
- Scality (RING / ARTESCA)
- "SeaweedFS"
- SeaweedFS S3
- "Selectel"
@@ -1080,6 +1082,8 @@ Properties:
- Zadara Object Storage
- "Zata"
- Zata (S3 compatible Gateway)
- "ZeroServices"
- Zero Services GmbH (ZERO-Z3)
- "Other"
- Any other S3 compatible provider
@@ -1137,7 +1141,7 @@ Properties:
- Config: region
- Env Var: RCLONE_S3_REGION
- Provider: AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,LyveCloud,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Scaleway,SeaweedFS,Selectel,Servercore,Synology,Wasabi,Zadara,Zata,Other
- Provider: AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,LyveCloud,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Scaleway,Scality,SeaweedFS,Selectel,Servercore,Synology,Wasabi,Zadara,Zata,ZeroServices,Other
- Type: string
- Required: false
- Examples:
@@ -1255,11 +1259,11 @@ Properties:
- ""
- Use this if unsure.
- Will use v4 signatures and an empty region.
- Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other
- Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,Scality,SeaweedFS,Wasabi,Other
- "other-v2-signature"
- Use this only if v4 signatures don't work.
- E.g. pre Jewel/v10 CEPH.
- Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other
- Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,Scality,SeaweedFS,Wasabi,Other
- "auto"
- R2 buckets are automatically distributed across Cloudflare's data centers for low latency.
- Provider: Cloudflare
@@ -1275,6 +1279,9 @@ Properties:
- "eu-south-1"
- EU South 1
- Provider: Fastly
- "eu-west-1"
- EU West 1
- Provider: Fastly
- "jp-central-1"
- JP Central 1
- Provider: Fastly
@@ -1287,9 +1294,15 @@ Properties:
- "us-east"
- US East
- Provider: Fastly
- "us-east-1"
- US East 1
- Provider: Fastly
- "us-west"
- US West
- Provider: Fastly
- "us-west-1"
- US West 1
- Provider: Fastly
- "global"
- Global
- Provider: FileLu
@@ -1620,6 +1633,15 @@ Properties:
- "us-east-1"
- Indore, Madhya Pradesh, India
- Provider: Zata
- "zero-fra1"
- Frankfurt 1
- Provider: ZeroServices
- "zero-fra2"
- Frankfurt 2
- Provider: ZeroServices
- "zero-eyl1"
- Eyl 1
- Provider: ZeroServices
#### --s3-endpoint
@@ -1631,7 +1653,7 @@ Properties:
- Config: endpoint
- Env Var: RCLONE_S3_ENDPOINT
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,FlashBlade,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Rclone,Scaleway,SeaweedFS,Selectel,Servercore,SpectraLogic,Storj,Synology,TencentCOS,US3,Wasabi,Zadara,Zata,Other
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,FlashBlade,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Rclone,Scaleway,Scality,SeaweedFS,Selectel,Servercore,SpectraLogic,Storj,Synology,TencentCOS,US3,Wasabi,Zadara,Zata,ZeroServices,Other
- Type: string
- Required: false
- Examples:
@@ -1862,6 +1884,9 @@ Properties:
- "eu-south-1.object.fastlystorage.app"
- EU South 1
- Provider: Fastly
- "eu-west-1.object.fastlystorage.app"
- EU West 1
- Provider: Fastly
- "jp-central-1.object.fastlystorage.app"
- JP Central 1
- Provider: Fastly
@@ -1874,9 +1899,15 @@ Properties:
- "us-east.object.fastlystorage.app"
- US East
- Provider: Fastly
- "us-east-1.object.fastlystorage.app"
- US East 1
- Provider: Fastly
- "us-west.object.fastlystorage.app"
- US West
- Provider: Fastly
- "us-west-1.object.fastlystorage.app"
- US West 1
- Provider: Fastly
- "s5lu.com"
- Global FileLu S5 endpoint
- Provider: FileLu
@@ -2260,17 +2291,38 @@ Properties:
- "br-ne1.magaluobjects.com"
- Fortaleza, CE (BR), br-ne1
- Provider: Magalu
- "s3.eu-amsterdam.megas4.com"
- Mega S4 Amsterdam
- Provider: Mega
- "s3.eu-luxembourg.megas4.com"
- Mega S4 Luxembourg
- Provider: Mega
- "s3.eu-paris.megas4.com"
- Mega S4 Paris
- Provider: Mega
- "s3.eu-barcelona.megas4.com"
- Mega S4 Barcelona
- Provider: Mega
- "s3.ca-montreal.megas4.com"
- Mega S4 Montreal
- Provider: Mega
- "s3.ca-vancouver.megas4.com"
- Mega S4 Vancouver
- Provider: Mega
- "s3.ap-tokyo.megas4.com"
- Mega S4 Tokyo
- Provider: Mega
- "s3.eu-central-1.s4.mega.io"
- Mega S4 eu-central-1 (Amsterdam)
- Mega S4 eu-central-1 (Amsterdam, legacy)
- Provider: Mega
- "s3.eu-central-2.s4.mega.io"
- Mega S4 eu-central-2 (Bettembourg)
- Mega S4 eu-central-2 (Bettembourg, legacy)
- Provider: Mega
- "s3.ca-central-1.s4.mega.io"
- Mega S4 ca-central-1 (Montreal)
- Mega S4 ca-central-1 (Montreal, legacy)
- Provider: Mega
- "s3.ca-west-1.s4.mega.io"
- Mega S4 ca-west-1 (Vancouver)
- Mega S4 ca-west-1 (Vancouver, legacy)
- Provider: Mega
- "oos.eu-west-2.outscale.com"
- Outscale EU West 2 (Paris)
@@ -2662,6 +2714,15 @@ Properties:
- "idr01.zata.ai"
- South Asia Endpoint
- Provider: Zata
- "fra1.s3.zeroservices.eu"
- Frankfurt 1
- Provider: ZeroServices
- "fra.s3.zeroservices.eu"
- Frankfurt 2
- Provider: ZeroServices
- "eyl1.s3.zeroservices.eu"
- Eyl 1
- Provider: ZeroServices
#### --s3-location-constraint
@@ -2673,7 +2734,7 @@ Properties:
- Config: location_constraint
- Env Var: RCLONE_S3_LOCATION_CONSTRAINT
- Provider: AWS,ArvanCloud,Ceph,ChinaMobile,DigitalOcean,Dreamhost,Exaba,GCS,HCP,Hetzner,IBMCOS,ImpossibleCloud,LyveCloud,Minio,Netease,Qiniu,Rabata,RackCorp,SeaweedFS,Synology,Wasabi,Zata,Other
- Provider: AWS,ArvanCloud,Ceph,ChinaMobile,DigitalOcean,Dreamhost,Exaba,GCS,HCP,Hetzner,IBMCOS,ImpossibleCloud,LyveCloud,Minio,Netease,Qiniu,Rabata,RackCorp,Scality,SeaweedFS,Synology,Wasabi,Zata,ZeroServices,Other
- Type: string
- Required: false
- Examples:
@@ -3054,36 +3115,36 @@ Properties:
- Config: acl
- Env Var: RCLONE_S3_ACL
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,US3,Wasabi,Zata,Other
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,Scality,SeaweedFS,TencentCOS,US3,Wasabi,Zata,ZeroServices,Other
- Type: string
- Required: false
- Examples:
- "private"
- Owner gets FULL_CONTROL.
- No one else has access rights (default).
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,US3,Wasabi,Zata,Other
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,Scality,SeaweedFS,US3,Wasabi,Zata,ZeroServices,Other
- "public-read"
- Owner gets FULL_CONTROL.
- The AllUsers group gets READ access.
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,US3,Wasabi,Zata,Other
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,Scality,SeaweedFS,TencentCOS,US3,Wasabi,Zata,ZeroServices,Other
- "public-read-write"
- Owner gets FULL_CONTROL.
- The AllUsers group gets READ and WRITE access.
- Granting this on a bucket is generally not recommended.
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,Scality,SeaweedFS,TencentCOS,Wasabi,Zata,ZeroServices,Other
- "authenticated-read"
- Owner gets FULL_CONTROL.
- The AuthenticatedUsers group gets READ access.
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,Scality,SeaweedFS,TencentCOS,Wasabi,Zata,ZeroServices,Other
- "bucket-owner-read"
- Object owner gets FULL_CONTROL.
- Bucket owner gets READ access.
- If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,Scality,SeaweedFS,TencentCOS,Wasabi,Zata,ZeroServices,Other
- "bucket-owner-full-control"
- Both the object owner and the bucket owner get FULL_CONTROL over the object.
- If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,Scality,SeaweedFS,TencentCOS,Wasabi,Zata,ZeroServices,Other
- "private"
- Owner gets FULL_CONTROL.
- No one else has access rights (default).
@@ -3277,7 +3338,7 @@ Properties:
### Advanced options
Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly, FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata, Other).
Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly, FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, Scality, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata, ZeroServices, Other).
#### --s3-bucket-acl
@@ -3296,7 +3357,7 @@ Properties:
- Config: bucket_acl
- Env Var: RCLONE_S3_BUCKET_ACL
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Servercore,TencentCOS,US3,Wasabi,Zata,Other
- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Servercore,TencentCOS,US3,Wasabi,Zata,ZeroServices,Other
- Type: string
- Required: false
- Examples:
@@ -3475,7 +3536,7 @@ Cutoff for switching to multipart copy.
Any files larger than this that need to be server-side copied will be
copied in chunks of this size.
The minimum is 0 and the maximum is 5 GiB.
The minimum is 1 byte and the maximum is 5 GiB.
Properties:
@@ -3626,7 +3687,7 @@ If true use path style access if false use virtual hosted style.
If this is true (the default) then rclone will use path style access,
if false then rclone will use virtual path style. See [the AWS S3
docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro)
docs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html)
for more info.
Some providers (e.g. AWS, Aliyun OSS, Netease COS, or Tencent COS) require this set to
@@ -3854,28 +3915,6 @@ Properties:
- Type: Encoding
- Default: Slash,InvalidUtf8,Dot
#### --s3-memory-pool-flush-time
How often internal memory buffer pools will be flushed. (no longer used)
Properties:
- Config: memory_pool_flush_time
- Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME
- Type: Duration
- Default: 1m0s
#### --s3-memory-pool-use-mmap
Whether to use mmap buffers in internal memory pool. (no longer used)
Properties:
- Config: memory_pool_use_mmap
- Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP
- Type: bool
- Default: false
#### --s3-disable-http2
Disable usage of http2 for S3 backends.
@@ -4123,20 +4162,6 @@ Properties:
- Type: bool
- Default: false
#### --s3-sts-endpoint
Endpoint for STS (deprecated).
Leave blank if using AWS to use the default endpoint for the region.
Properties:
- Config: sts_endpoint
- Env Var: RCLONE_S3_STS_ENDPOINT
- Provider: AWS
- Type: string
- Required: false
#### --s3-use-already-exists
Set if rclone should report BucketAlreadyExists errors on bucket creation.
docs/content/seafile.md
-11
View File
@@ -378,17 +378,6 @@ Properties:
- Type: string
- Required: false
#### --seafile-auth-token
Authentication token.
Properties:
- Config: auth_token
- Env Var: RCLONE_SEAFILE_AUTH_TOKEN
- Type: string
- Required: false
### Advanced options
Here are the Advanced options specific to seafile (seafile).
docs/content/sftp.md
+74 -1
View File
@@ -773,7 +773,7 @@ Here are the Advanced options specific to sftp (SSH/SFTP).
Optional path to known_hosts file.
Set this value to enable server host key validation.
Set this value to enable server host key validation. Set to `none` to silence the "No host key validation" notice.
Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.
@@ -787,6 +787,60 @@ Properties:
- "~/.ssh/known_hosts"
- Use OpenSSH's known_hosts file.
#### --sftp-pin-host-key
Pin the server host key on first connection (Trust On First Use).
Intended for one-time use as the `--sftp-pin-host-key` command-line
flag. Run rclone once with the flag and the server's host key will be
recorded into the host_keys config option. On subsequent runs (without
the flag) host_keys is consulted and any mismatch is refused.
Setting this option persistently in the config file is not
recommended. While it is set, rclone will also accept any new
host key algorithm the server later presents, which widens the trust
surface beyond the initial pin. To pin a new key after a legitimate
key change, re-run with the flag.
The first connection is unauthenticated, so ideally do it over a
trusted network or cross-check the fingerprint rclone logs against
one provided out of band.
If known_hosts_file is also set, that takes precedence and this option
is ignored.
Properties:
- Config: pin_host_key
- Env Var: RCLONE_SFTP_PIN_HOST_KEY
- Type: bool
- Default: false
#### --sftp-host-keys
Pinned host keys for this remote, used to verify the server.
Comma-separated list of "algo base64-key" entries (the same format as
the second and third fields of an OpenSSH known_hosts line). Usually
populated automatically by running once with --sftp-pin-host-key, but
can be set by hand to pin a server's public key obtained out of band.
Note that each entry is the complete public key, not its SHA256
fingerprint.
When non-empty, the offered host key must match one of the entries or
the connection is refused. To re-pin after a legitimate key change,
clear this option and reconnect with --sftp-pin-host-key, or edit the
value directly.
At most 16 entries may be pinned.
Properties:
- Config: host_keys
- Env Var: RCLONE_SFTP_HOST_KEYS
- Type: CommaSepList
- Default:
#### --sftp-ask-password
Allow asking for SFTP password when needed.
@@ -837,6 +891,19 @@ Properties:
- Type: string
- Required: false
#### --sftp-encoding
The encoding for the backend.
See the [encoding section in the overview](/overview/#encoding) for more info.
Properties:
- Config: encoding
- Env Var: RCLONE_SFTP_ENCODING
- Type: Encoding
- Default: Slash,Del,Ctl,Dot
#### --sftp-set-modtime
Set the modified time on the remote if set.
@@ -976,6 +1043,12 @@ Properties:
Set to skip any symlinks and any other non regular files.
This only affects listing: symlinks and other non regular files are
omitted from directory listings. It is not a security control and does
not prevent writes from following symlinks on the server - confining an
SFTP account to a directory must be enforced server side (for example
with a chroot jail or restricted permissions).
Properties:
- Config: skip_links
docs/content/webdav.md
+4
View File
@@ -331,6 +331,10 @@ However this is desirable in some circumstances. If you are getting
an error like "401 Unauthorized" when rclone is attempting to read
files from the webdav server then you can try this option.
Note that enabling this also permits sending your credentials over a
plaintext HTTP connection if the server redirects from HTTPS to HTTP,
which rclone otherwise refuses to do.
Properties:
docs/content/yandex.md
+21
View File
@@ -247,6 +247,27 @@ Properties:
- Type: bool
- Default: true
#### --yandex-upload-wait
Wait this long after an upload before setting the modification time.
Yandex Disk finalizes an upload asynchronously on its servers after
the upload has completed. If the modification time is set while this
finalization is still in progress the server returns 500 Internal
Server Error errors.
If you are getting 500 errors on upload then setting this to 2s is
normally enough to stop them, at the cost of slowing down uploads.
Yandex support recommend a value of 1.5s - 3s.
Properties:
- Config: upload_wait
- Env Var: RCLONE_YANDEX_UPLOAD_WAIT
- Type: Duration
- Default: 0s
#### --yandex-description
Description of the remote.
docs/content/zoho.md
+127
View File
@@ -251,6 +251,21 @@ Properties:
- Type: bool
- Default: false
#### --zoho-root-folder-id
ID of the root folder.
Leave blank normally.
Fill in to make rclone use a non root folder as its starting point.
Properties:
- Config: root_folder_id
- Env Var: RCLONE_ZOHO_ROOT_FOLDER_ID
- Type: string
- Required: false
#### --zoho-upload-cutoff
Cutoff for switching to large file upload api (>= 10 MiB).
@@ -262,6 +277,118 @@ Properties:
- Type: SizeSuffix
- Default: 10Mi
#### --zoho-tpslimit
Max number of API transactions per second.
Zoho WorkDrive rate limits its API and returns HTTP 429 (error F7008,
"Request rate limit exceeded") when called too quickly, so the data API
calls (list, upload, download, copy, move, delete) are paced to this rate.
Set to 0 to disable the cap, matching the global --tpslimit; pacing still
can't be turned off entirely because backoff and Retry-After always apply.
The default of 6 is a safe sustainable rate. Higher values can trigger long
429 Retry-After stalls that make throughput WORSE, so raise it only if your
account tolerates more.
Properties:
- Config: tpslimit
- Env Var: RCLONE_ZOHO_TPSLIMIT
- Type: float64
- Default: 6
#### --zoho-tpslimit-burst
Number of API calls to allow back-to-back without sleeping, for --zoho-tpslimit.
This is the token-bucket capacity. Keep at 1 for Zoho: a burst > 1
lets several calls fire at once after an idle gap, which can trigger
synchronized clusters of 429 errors.
Properties:
- Config: tpslimit_burst
- Env Var: RCLONE_ZOHO_TPSLIMIT_BURST
- Type: int
- Default: 1
#### --zoho-list-folder-limit
Max listings of the SAME folder allowed per --zoho-list-folder-window.
Zoho WorkDrive rate limits its listing API (GET files/{id}/files) PER
folder, independently of --zoho-tpslimit: listing one folder too often in a
short time returns HTTP 429 (error F7008) with a multi-minute Retry-After
penalty, which a tight polling loop can hit even at a low overall rate.
Measured live, Zoho allows ~19 listings of one folder in any rolling ~60s
window and the 20th fails, which the defaults (19 per 60s) model exactly.
This is a true per-window cap for any traffic pattern: each window starts
with --zoho-list-folder-burst listings passing back-to-back (the burst
re-arms at every window boundary) and the rest are spaced
--zoho-list-folder-window/(limit - burst) apart (the defaults give ~4.6s),
while a sliding log of recent listings enforces the cap across window
boundaries. 0 disables the limiter. Only REPEATED listings of one folder are
delayed; different folders, or a folder listed fewer than
--zoho-list-folder-burst times, never are.
A HIGHER value means MORE listings per window, not more safety: raising it
above 19 trips F7008. Lower it for a wider margin at the cost of listing
responsiveness.
Properties:
- Config: list_folder_limit
- Env Var: RCLONE_ZOHO_LIST_FOLDER_LIMIT
- Type: int
- Default: 19
#### --zoho-list-folder-window
The window for --zoho-list-folder-limit.
The default of 60s (shown as 1m0s) matches Zoho's real sliding window: at
most --zoho-list-folder-limit listings of one folder are allowed in any
window of this length. A bare number is parsed as seconds ("60" = "60s").
Widen it (or lower the limit) for a bigger safety margin; the sustained
spacing between same-folder listings is window/(limit - burst).
Properties:
- Config: list_folder_window
- Env Var: RCLONE_ZOHO_LIST_FOLDER_WINDOW
- Type: Duration
- Default: 1m0s
#### --zoho-list-folder-burst
Same-folder listings allowed back-to-back before --zoho-list-folder-limit paces them.
The burst is carved out of --zoho-list-folder-limit, so raising it never
raises the per-window total: this many listings may fire immediately and the
remaining limit - burst are spaced window/(limit - burst) apart. The burst
RE-ARMS at every window boundary, so sustained re-listing gets a fresh burst
each window while a sliding log of recent listings still enforces the
per-window cap. A folder listed only a handful of times (the common case - a
sync re-listing one directory a few times then moving on) never waits.
The default 6 is the largest burst validated live under the default 19-per-60s
cap (bursts of 4, 5 and 6 all ran clean; an over-cap probe tripped F7008
exactly at the 20th listing in a window). Keep it well below ~15 - Zoho also
has an instantaneous back-to-back cap around 15-16 regardless of the window.
Set to 1 to pace from the second listing. Values >= the limit are clamped to
limit - 1.
Properties:
- Config: list_folder_burst
- Env Var: RCLONE_ZOHO_LIST_FOLDER_BURST
- Type: int
- Default: 6
#### --zoho-encoding
The encoding for the backend.
lib/transform/transform.md
+2 -2
View File
@@ -218,12 +218,12 @@ rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,command=e
```console
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}"
// Output: stories/The Quick Brown Fox!-20260501
// Output: stories/The Quick Brown Fox!-20260731
```
```console
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}"
// Output: stories/The Quick Brown Fox!-2026-05-01 0355PM
// Output: stories/The Quick Brown Fox!-2026-07-31 0455PM
```
```console
rclone.1
Generated
+3469 -643
View File
File diff suppressed because it is too large Load Diff