mirror of
https://github.com/rclone/rclone
synced 2025-02-20 16:52:03 +01:00
Version v1.69.0
This commit is contained in:
parent
009660a489
commit
cd3b08d8cf
MANUAL.htmlMANUAL.mdMANUAL.txt
docs/content
azureblob.mdb2.mdbox.mdchangelog.mdcloudinary.md
rclone.1commands
rclone.mdrclone_bisync.mdrclone_copy.mdrclone_copyto.mdrclone_mount.mdrclone_move.mdrclone_moveto.mdrclone_nfsmount.mdrclone_rcd.mdrclone_serve_dlna.mdrclone_serve_docker.mdrclone_serve_ftp.mdrclone_serve_http.mdrclone_serve_nfs.mdrclone_serve_restic.mdrclone_serve_s3.mdrclone_serve_sftp.mdrclone_serve_webdav.mdrclone_sync.mdrclone_test_makefiles.md
drive.mddropbox.mdflags.mdftp.mdgooglecloudstorage.mdgooglephotos.mdhidrive.mdiclouddrive.mdjottacloud.mdmailru.mdonedrive.mdoracleobjectstorage
pcloud.mdpikpak.mdpremiumizeme.mdputio.mdrc.mds3.mdsharefile.mdwebdav.mdyandex.mdzoho.md
2431
MANUAL.html
generated
2431
MANUAL.html
generated
File diff suppressed because it is too large
Load Diff
2523
MANUAL.txt
generated
2523
MANUAL.txt
generated
File diff suppressed because it is too large
Load Diff
@ -540,6 +540,28 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --azureblob-disable-instance-discovery
|
||||
|
||||
Skip requesting Microsoft Entra instance metadata
|
||||
|
||||
This should be set true only by applications authenticating in
|
||||
disconnected clouds, or private clouds such as Azure Stack.
|
||||
|
||||
It determines whether rclone requests Microsoft Entra instance
|
||||
metadata from `https://login.microsoft.com/` before
|
||||
authenticating.
|
||||
|
||||
Setting this to true will skip this request, making you responsible
|
||||
for ensuring the configured authority is valid and trustworthy.
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: disable_instance_discovery
|
||||
- Env Var: RCLONE_AZUREBLOB_DISABLE_INSTANCE_DISCOVERY
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --azureblob-use-msi
|
||||
|
||||
Use a managed service identity to authenticate (only works in Azure).
|
||||
@ -612,6 +634,26 @@ Properties:
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --azureblob-use-az
|
||||
|
||||
Use Azure CLI tool az for authentication
|
||||
|
||||
Set to use the [Azure CLI tool az](https://learn.microsoft.com/en-us/cli/azure/)
|
||||
as the sole means of authentication.
|
||||
|
||||
Setting this can be useful if you wish to use the az CLI on a host with
|
||||
a System Managed Identity that you do not want to use.
|
||||
|
||||
Don't set env_auth at the same time.
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: use_az
|
||||
- Env Var: RCLONE_AZUREBLOB_USE_AZ
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --azureblob-endpoint
|
||||
|
||||
Endpoint for the service.
|
||||
|
@ -702,6 +702,7 @@ This will dump something like this showing the lifecycle rules.
|
||||
{
|
||||
"daysFromHidingToDeleting": 1,
|
||||
"daysFromUploadingToHiding": null,
|
||||
"daysFromStartingToCancelingUnfinishedLargeFiles": null,
|
||||
"fileNamePrefix": ""
|
||||
}
|
||||
]
|
||||
@ -731,6 +732,7 @@ See: https://www.backblaze.com/docs/cloud-storage-lifecycle-rules
|
||||
Options:
|
||||
|
||||
- "daysFromHidingToDeleting": After a file has been hidden for this many days it is deleted. 0 is off.
|
||||
- "daysFromStartingToCancelingUnfinishedLargeFiles": Cancels any unfinished large file versions after this many days
|
||||
- "daysFromUploadingToHiding": This many days after uploading a file is hidden
|
||||
|
||||
### cleanup
|
||||
|
@ -384,6 +384,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --box-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_BOX_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --box-root-folder-id
|
||||
|
||||
Fill in for rclone to use a non root folder as its starting point.
|
||||
|
@ -5,6 +5,139 @@ description: "Rclone Changelog"
|
||||
|
||||
# Changelog
|
||||
|
||||
## v1.69.0 - 2025-01-12
|
||||
|
||||
[See commits](https://github.com/rclone/rclone/compare/v1.68.0...v1.69.0)
|
||||
|
||||
* New backends
|
||||
* [ICloud Drive](/iclouddrive/) (lostb1t)
|
||||
* [Cloudinary](/cloudinary/) (yuval-cloudinary)
|
||||
* New S3 providers:
|
||||
* [Outscale](/s3/#outscale) (Matthias Gatto)
|
||||
* [Selectel](/s3/#selectel) (Nick Craig-Wood)
|
||||
* Security fixes
|
||||
* serve sftp: Resolve CVE-2024-45337 - Misuse of ServerConfig.PublicKeyCallback may cause authorization bypass (dependabot)
|
||||
* Rclone was **not** vulnerable to this.
|
||||
* See https://github.com/advisories/GHSA-v778-237x-gjrc
|
||||
* build: Update golang.org/x/net to v0.33.0 to fix CVE-2024-45338 - Non-linear parsing of case-insensitive content (Nick Craig-Wood)
|
||||
* Rclone was **not** vulnerable to this.
|
||||
* See https://github.com/advisories/GHSA-w32m-9786-jp63
|
||||
* New Features
|
||||
* accounting: Write the current bwlimit to the log on SIGUSR2 (Nick Craig-Wood)
|
||||
* bisync: Change exit code from 2 to 7 for critically aborted run (albertony)
|
||||
* build
|
||||
* Update all dependencies (Nick Craig-Wood)
|
||||
* Replace Windows-specific `NewLazyDLL` with `NewLazySystemDLL` (albertony)
|
||||
* cmd: Change exit code from 1 to 2 for syntax and usage errors (albertony)
|
||||
* docker serve: make sure all mount and VFS options are parsed (Nick Craig-Wood)
|
||||
* doc fixes (albertony, Alexandre Hamez, Anthony Metzidis, buengese, Dan McArdle, David Seifert, Francesco Frassinelli, Michael R. Davis, Nick Craig-Wood, Pawel Palucha, Randy Bush, remygrandin, Sam Harrison, shenpengfeng, tgfisher, Thomas ten Cate, ToM, Tony Metzidis, vintagefuture, Yxxx)
|
||||
* fs: Make `--links` flag global and add new `--local-links` and `--vfs-links` flags (Nick Craig-Wood)
|
||||
* http servers: Disable automatic authentication skipping for unix sockets in http servers (Moises Lima)
|
||||
* This was making it impossible to use unix sockets with an proxy
|
||||
* This might now cause rclone to need authenticaton where it didn't before
|
||||
* oauthutil: add support for OAuth client credential flow (Martin Hassack, Nick Craig-Wood)
|
||||
* operations: make log messages consistent for mkdir/rmdir at INFO level (Nick Craig-Wood)
|
||||
* rc: Add `relative` to [vfs/queue-set-expiry](/rc/#vfs-queue-set-expiry) (Nick Craig-Wood)
|
||||
* serve dlna: Sort the directory entries by directories first then alphabetically by name (Nick Craig-Wood)
|
||||
* serve nfs
|
||||
* Introduce symlink support (Nick Craig-Wood)
|
||||
* Implement `--nfs-cache-type` symlink (Nick Craig-Wood)
|
||||
* size: Make output compatible with `-P` (Nick Craig-Wood)
|
||||
* test makefiles: Add `--flat` flag for making directories with many entries (Nick Craig-Wood)
|
||||
* Bug Fixes
|
||||
* accounting
|
||||
* Fix global error acounting (Benjamin Legrand)
|
||||
* Fix debug printing when debug wasn't set (Nick Craig-Wood)
|
||||
* Fix race stopping/starting the stats counter (Nick Craig-Wood)
|
||||
* rc/job: Use mutex for adding listeners thread safety (hayden.pan)
|
||||
* serve docker: Fix incorrect GID assignment (TAKEI Yuya)
|
||||
* serve nfs: Fix missing inode numbers which was messing up `ls -laR` (Nick Craig-Wood)
|
||||
* serve s3: Fix `Last-Modified` timestamp (Nick Craig-Wood)
|
||||
* serve sftp: Fix loading of authorized keys file with comment on last line (albertony)
|
||||
* Mount
|
||||
* Introduce symlink support (Filipe Azevedo, Nick Craig-Wood)
|
||||
* Better snap mount error message (divinity76)
|
||||
* mount2: Fix missing `.` and `..` entries (Filipe Azevedo)
|
||||
* VFS
|
||||
* With `--vfs-used-is-size` value is calculated and then thrown away (Ilias Ozgur Can Leonard)
|
||||
* Add symlink support to VFS (Filipe Azevedo, Nick Craig-Wood)
|
||||
* This can be enabled with the specific `--vfs-links` flag or the global `--links` flag
|
||||
* Fix open files disappearing from directory listings (Nick Craig-Wood)
|
||||
* Add remote name to vfs cache log messages (Nick Craig-Wood)
|
||||
* Cache
|
||||
* Fix parent not getting pinned when remote is a file (nielash)
|
||||
* Azure Blob
|
||||
* Add `--azureblob-disable-instance-discovery` (Nick Craig-Wood)
|
||||
* Add `--azureblob-use-az` to force the use of the Azure CLI for auth (Nick Craig-Wood)
|
||||
* Quit multipart uploads if the context is cancelled (Nick Craig-Wood)
|
||||
* Azurefiles
|
||||
* Fix missing x-ms-file-request-intent header (Nick Craig-Wood)
|
||||
* B2
|
||||
* Add `daysFromStartingToCancelingUnfinishedLargeFiles` to `backend lifecycle` command (Louis Laureys)
|
||||
* Box
|
||||
* Fix server-side copying a file over existing dst (nielash)
|
||||
* Fix panic when decoding corrupted PEM from JWT file (Nick Craig-Wood)
|
||||
* Drive
|
||||
* Add support for markdown format (Noam Ross)
|
||||
* Implement `rclone backend rescue` to rescue orphaned files (Nick Craig-Wood)
|
||||
* Dropbox
|
||||
* Fix server side copying over existing object (Nick Craig-Wood)
|
||||
* Fix return status when full to be fatal error (Nick Craig-Wood)
|
||||
* FTP
|
||||
* Implement `--ftp-no-check-upload` to allow upload to write only dirs (Nick Craig-Wood)
|
||||
* Fix ls commands returning empty on "Microsoft FTP Service" servers (Francesco Frassinelli)
|
||||
* Gofile
|
||||
* Fix server side copying over existing object (Nick Craig-Wood)
|
||||
* Google Cloud Storage
|
||||
* Add access token auth with `--gcs-access-token` (Leandro Piccilli)
|
||||
* Update docs on service account access tokens (Anthony Metzidis)
|
||||
* Googlephotos
|
||||
* Implement `--gphotos-proxy` to allow download of full resolution media (Nick Craig-Wood)
|
||||
* Fix nil pointer crash on upload (Nick Craig-Wood)
|
||||
* HTTP
|
||||
* Fix incorrect URLs with initial slash (Oleg Kunitsyn)
|
||||
* Onedrive
|
||||
* Add support for OAuth client credential flow (Martin Hassack, Nick Craig-Wood)
|
||||
* Fix time precision for OneDrive personal (Nick Craig-Wood)
|
||||
* Fix server side copying over existing object (Nick Craig-Wood)
|
||||
* Opendrive
|
||||
* Add `rclone about` support to backend (quiescens)
|
||||
* Oracle Object Storage
|
||||
* Make specifying `compartmentid` optional (Manoj Ghosh)
|
||||
* Quit multipart uploads if the context is cancelled (Nick Craig-Wood)
|
||||
* Pikpak
|
||||
* Add option to use original file links (wiserain)
|
||||
* Protondrive
|
||||
* Improve performance of Proton Drive backend (Lawrence Murray)
|
||||
* Putio
|
||||
* Fix server side copying over existing object (Nick Craig-Wood)
|
||||
* S3
|
||||
* Add initial `--s3-directory-bucket` to support AWS Directory Buckets (Nick Craig-Wood)
|
||||
* Add Wasabi `eu-south-1` region (Diego Monti)
|
||||
* Fix download of compressed files from Cloudflare R2 (Nick Craig-Wood)
|
||||
* Rename glacier storage class to flexible retrieval (Henry Lee)
|
||||
* Quit multipart uploads if the context is cancelled (Nick Craig-Wood)
|
||||
* SFTP
|
||||
* Allow inline ssh public certificate for sftp (Dimitar Ivanov)
|
||||
* Fix nil check when using auth proxy (Nick Craig-Wood)
|
||||
* Smb
|
||||
* Add initial support for Kerberos authentication (more work needed). (Francesco Frassinelli)
|
||||
* Fix panic if stat fails (Nick Craig-Wood)
|
||||
* Sugarsync
|
||||
* Fix server side copying over existing object (Nick Craig-Wood)
|
||||
* WebDAV
|
||||
* Nextcloud: implement backoff and retry for 423 LOCKED errors (Nick Craig-Wood)
|
||||
* Make `--webdav-auth-redirect` to fix 401 unauthorized on redirect (Nick Craig-Wood)
|
||||
* Yandex
|
||||
* Fix server side copying over existing object (Nick Craig-Wood)
|
||||
* Zoho
|
||||
* Use download server to accelerate downloads (buengese)
|
||||
* Switch to large file upload API for larger files, fix missing URL encoding of filenames for the upload API (buengese)
|
||||
* Print clear error message when missing oauth scope (buengese)
|
||||
* Try to handle rate limits a bit better (buengese)
|
||||
* Add support for private spaces (buengese)
|
||||
* Make upload cutoff configurable (buengese)
|
||||
|
||||
## v1.68.2 - 2024-11-15
|
||||
|
||||
[See commits](https://github.com/rclone/rclone/compare/v1.68.1...v1.68.2)
|
||||
@ -145,6 +278,7 @@ description: "Rclone Changelog"
|
||||
* Pcloud
|
||||
* Implement `SetModTime` (Georg Welzel)
|
||||
* Implement `OpenWriterAt` feature to enable multipart uploads (Georg Welzel)
|
||||
* Fix failing large file uploads (Georg Welzel)
|
||||
* Pikpak
|
||||
* Improve data consistency by ensuring async tasks complete (wiserain)
|
||||
* Implement custom hash to replace wrong sha1 (wiserain)
|
||||
|
@ -149,8 +149,6 @@ Properties:
|
||||
|
||||
Cloudinary API Secret
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: api_secret
|
||||
|
@ -41,6 +41,7 @@ rclone [flags]
|
||||
--azureblob-description string Description of the remote
|
||||
--azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
||||
--azureblob-disable-checksum Don't store MD5 checksum with object metadata
|
||||
--azureblob-disable-instance-discovery Skip requesting Microsoft Entra instance metadata
|
||||
--azureblob-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
|
||||
--azureblob-endpoint string Endpoint for the service
|
||||
--azureblob-env-auth Read credentials from runtime (environment variables, CLI or MSI)
|
||||
@ -58,6 +59,7 @@ rclone [flags]
|
||||
--azureblob-tenant string ID of the service principal's tenant. Also called its directory ID
|
||||
--azureblob-upload-concurrency int Concurrency for multipart uploads (default 16)
|
||||
--azureblob-upload-cutoff string Cutoff for switching to chunked upload (<= 256 MiB) (deprecated)
|
||||
--azureblob-use-az Use Azure CLI tool az for authentication
|
||||
--azureblob-use-emulator Uses local storage emulator if provided as 'true'
|
||||
--azureblob-use-msi Use a managed service identity to authenticate (only works in Azure)
|
||||
--azureblob-username string User name (usually an email address)
|
||||
@ -109,6 +111,7 @@ rclone [flags]
|
||||
--box-auth-url string Auth server URL
|
||||
--box-box-config-file string Box App config.json location
|
||||
--box-box-sub-type string (default "user")
|
||||
--box-client-credentials Use client credentials OAuth flow
|
||||
--box-client-id string OAuth Client Id
|
||||
--box-client-secret string OAuth Client Secret
|
||||
--box-commit-retries int Max number of times to try committing a multipart file (default 100)
|
||||
@ -157,6 +160,14 @@ rclone [flags]
|
||||
--chunker-remote string Remote to chunk/unchunk
|
||||
--client-cert string Client SSL certificate (PEM) for mutual TLS auth
|
||||
--client-key string Client SSL private key (PEM) for mutual TLS auth
|
||||
--cloudinary-api-key string Cloudinary API Key
|
||||
--cloudinary-api-secret string Cloudinary API Secret
|
||||
--cloudinary-cloud-name string Cloudinary Environment Name
|
||||
--cloudinary-description string Description of the remote
|
||||
--cloudinary-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
|
||||
--cloudinary-eventually-consistent-delay Duration Wait N seconds for eventual consistency of the databases that support the backend operation (default 0s)
|
||||
--cloudinary-upload-prefix string Specify the API endpoint for environments out of the US
|
||||
--cloudinary-upload-preset string Upload Preset to select asset manipulation on upload
|
||||
--color AUTO|NEVER|ALWAYS When to show colors (and other ANSI codes) AUTO|NEVER|ALWAYS (default AUTO)
|
||||
--combine-description string Description of the remote
|
||||
--combine-upstreams SpaceSepList Upstreams for combining
|
||||
@ -198,6 +209,7 @@ rclone [flags]
|
||||
--drive-auth-owner-only Only consider files owned by the authenticated user
|
||||
--drive-auth-url string Auth server URL
|
||||
--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-copy-shortcut-content Server side copy contents of shortcuts instead of the shortcut
|
||||
@ -248,6 +260,7 @@ rclone [flags]
|
||||
--dropbox-batch-size int Max number of files in upload batch
|
||||
--dropbox-batch-timeout Duration Max time to allow an idle upload batch before uploading (default 0s)
|
||||
--dropbox-chunk-size SizeSuffix Upload chunk size (< 150Mi) (default 48Mi)
|
||||
--dropbox-client-credentials Use client credentials OAuth flow
|
||||
--dropbox-client-id string OAuth Client Id
|
||||
--dropbox-client-secret string OAuth Client Secret
|
||||
--dropbox-description string Description of the remote
|
||||
@ -312,6 +325,7 @@ rclone [flags]
|
||||
--ftp-host string FTP host to connect to
|
||||
--ftp-idle-timeout Duration Max time before closing idle connections (default 1m0s)
|
||||
--ftp-no-check-certificate Do not verify the TLS certificate of the server
|
||||
--ftp-no-check-upload Don't check the upload is OK
|
||||
--ftp-pass string FTP password (obscured)
|
||||
--ftp-port int FTP port number (default 21)
|
||||
--ftp-shut-timeout Duration Maximum time to wait for data connection closing status (default 1m0s)
|
||||
@ -320,10 +334,12 @@ rclone [flags]
|
||||
--ftp-tls-cache-size int Size of TLS session cache for all control and data connections (default 32)
|
||||
--ftp-user string FTP username (default "$USER")
|
||||
--ftp-writing-mdtm Use MDTM to set modification time (VsFtpd quirk)
|
||||
--gcs-access-token string Short-lived access token
|
||||
--gcs-anonymous Access public buckets and objects without credentials
|
||||
--gcs-auth-url string Auth server URL
|
||||
--gcs-bucket-acl string Access Control List for new buckets
|
||||
--gcs-bucket-policy-only Access checks should use bucket-level IAM policies
|
||||
--gcs-client-credentials Use client credentials OAuth flow
|
||||
--gcs-client-id string OAuth Client Id
|
||||
--gcs-client-secret string OAuth Client Secret
|
||||
--gcs-decompress If set this will decompress gzip encoded objects
|
||||
@ -352,11 +368,13 @@ rclone [flags]
|
||||
--gphotos-batch-mode string Upload file batching sync|async|off (default "sync")
|
||||
--gphotos-batch-size int Max number of files in upload batch
|
||||
--gphotos-batch-timeout Duration Max time to allow an idle upload batch before uploading (default 0s)
|
||||
--gphotos-client-credentials Use client credentials OAuth flow
|
||||
--gphotos-client-id string OAuth Client Id
|
||||
--gphotos-client-secret string OAuth Client Secret
|
||||
--gphotos-description string Description of the remote
|
||||
--gphotos-encoding Encoding The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
|
||||
--gphotos-include-archived Also view and download archived media
|
||||
--gphotos-proxy string Use the gphotosdl proxy for downloading the full resolution images
|
||||
--gphotos-read-only Set to make the Google Photos backend read only
|
||||
--gphotos-read-size Set to read the size of media items
|
||||
--gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000)
|
||||
@ -379,6 +397,7 @@ rclone [flags]
|
||||
-h, --help help for rclone
|
||||
--hidrive-auth-url string Auth server URL
|
||||
--hidrive-chunk-size SizeSuffix Chunksize for chunked uploads (default 48Mi)
|
||||
--hidrive-client-credentials Use client credentials OAuth flow
|
||||
--hidrive-client-id string OAuth Client Id
|
||||
--hidrive-client-secret string OAuth Client Secret
|
||||
--hidrive-description string Description of the remote
|
||||
@ -399,6 +418,11 @@ rclone [flags]
|
||||
--http-no-slash Set this if the site doesn't end directories with /
|
||||
--http-url string URL of HTTP host to connect to
|
||||
--human-readable Print numbers in a human-readable format, sizes with suffix Ki|Mi|Gi|Ti|Pi
|
||||
--iclouddrive-apple-id string Apple ID
|
||||
--iclouddrive-client-id string Client id (default "d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d")
|
||||
--iclouddrive-description string Description of the remote
|
||||
--iclouddrive-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||
--iclouddrive-password string Password (obscured)
|
||||
--ignore-case Ignore case in filters (case insensitive)
|
||||
--ignore-case-sync Ignore case when synchronizing
|
||||
--ignore-checksum Skip post copy check of checksums
|
||||
@ -428,6 +452,7 @@ rclone [flags]
|
||||
--internetarchive-secret-access-key string IAS3 Secret Key (password)
|
||||
--internetarchive-wait-archive Duration Timeout for waiting the server's processing tasks (specifically archive and book_op) to finish (default 0s)
|
||||
--jottacloud-auth-url string Auth server URL
|
||||
--jottacloud-client-credentials Use client credentials OAuth flow
|
||||
--jottacloud-client-id string OAuth Client Id
|
||||
--jottacloud-client-secret string OAuth Client Secret
|
||||
--jottacloud-description string Description of the remote
|
||||
@ -455,6 +480,7 @@ 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-links Translate symlinks to/from regular files with a '.rclonelink' extension for the local backend
|
||||
--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
|
||||
@ -471,6 +497,7 @@ rclone [flags]
|
||||
--low-level-retries int Number of low level retries to do (default 10)
|
||||
--mailru-auth-url string Auth server URL
|
||||
--mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true)
|
||||
--mailru-client-credentials Use client credentials OAuth flow
|
||||
--mailru-client-id string OAuth Client Id
|
||||
--mailru-client-secret string OAuth Client Secret
|
||||
--mailru-description string Description of the remote
|
||||
@ -510,7 +537,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 (default [""])
|
||||
--metrics-addr stringArray IPaddress:Port or :Port to bind metrics 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)
|
||||
@ -551,6 +578,7 @@ rclone [flags]
|
||||
--onedrive-auth-url string Auth server URL
|
||||
--onedrive-av-override Allows download of files the server thinks has a virus
|
||||
--onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes) (default 10Mi)
|
||||
--onedrive-client-credentials Use client credentials OAuth flow
|
||||
--onedrive-client-id string OAuth Client Id
|
||||
--onedrive-client-secret string OAuth Client Secret
|
||||
--onedrive-delta If set rclone will use delta listing to implement recursive listings
|
||||
@ -570,11 +598,12 @@ rclone [flags]
|
||||
--onedrive-region string Choose national cloud region for OneDrive (default "global")
|
||||
--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-token string OAuth Access Token as a JSON blob
|
||||
--onedrive-token-url string Token server url
|
||||
--oos-attempt-resume-upload If true attempt to resume previously started multipart upload for the object
|
||||
--oos-chunk-size SizeSuffix Chunk size to use for uploading (default 5Mi)
|
||||
--oos-compartment string Object storage compartment OCID
|
||||
--oos-compartment string Specify compartment OCID, if you need to list buckets
|
||||
--oos-config-file string Path to OCI config file (default "~/.oci/config")
|
||||
--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)
|
||||
@ -606,6 +635,7 @@ rclone [flags]
|
||||
--partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial")
|
||||
--password-command SpaceSepList Command for supplying password for encrypted configuration
|
||||
--pcloud-auth-url string Auth server URL
|
||||
--pcloud-client-credentials Use client credentials OAuth flow
|
||||
--pcloud-client-id string OAuth Client Id
|
||||
--pcloud-client-secret string OAuth Client Secret
|
||||
--pcloud-description string Description of the remote
|
||||
@ -616,26 +646,25 @@ rclone [flags]
|
||||
--pcloud-token string OAuth Access Token as a JSON blob
|
||||
--pcloud-token-url string Token server url
|
||||
--pcloud-username string Your pcloud username
|
||||
--pikpak-auth-url string Auth server URL
|
||||
--pikpak-chunk-size SizeSuffix Chunk size for multipart uploads (default 5Mi)
|
||||
--pikpak-client-id string OAuth Client Id
|
||||
--pikpak-client-secret string OAuth Client Secret
|
||||
--pikpak-description string Description of the remote
|
||||
--pikpak-device-id string Device ID used for authorization
|
||||
--pikpak-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
||||
--pikpak-hash-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate hash if required (default 10Mi)
|
||||
--pikpak-no-media-link Use original file links instead of media links
|
||||
--pikpak-pass string Pikpak password (obscured)
|
||||
--pikpak-root-folder-id string ID of the root folder
|
||||
--pikpak-token string OAuth Access Token as a JSON blob
|
||||
--pikpak-token-url string Token server url
|
||||
--pikpak-trashed-only Only show files that are in the trash
|
||||
--pikpak-upload-concurrency int Concurrency for multipart uploads (default 5)
|
||||
--pikpak-use-trash Send files to the trash instead of deleting permanently (default true)
|
||||
--pikpak-user string Pikpak username
|
||||
--pikpak-user-agent string HTTP user agent for pikpak (default "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0")
|
||||
--pixeldrain-api-key string API key for your pixeldrain account
|
||||
--pixeldrain-api-url string The API endpoint to connect to. In the vast majority of cases it's fine to leave (default "https://pixeldrain.com/api")
|
||||
--pixeldrain-description string Description of the remote
|
||||
--pixeldrain-root-folder-id string Root of the filesystem to use (default "me")
|
||||
--premiumizeme-auth-url string Auth server URL
|
||||
--premiumizeme-client-credentials Use client credentials OAuth flow
|
||||
--premiumizeme-client-id string OAuth Client Id
|
||||
--premiumizeme-client-secret string OAuth Client Secret
|
||||
--premiumizeme-description string Description of the remote
|
||||
@ -655,6 +684,7 @@ rclone [flags]
|
||||
--protondrive-replace-existing-draft Create a new revision when filename conflict is detected
|
||||
--protondrive-username string The username of your proton account
|
||||
--putio-auth-url string Auth server URL
|
||||
--putio-client-credentials Use client credentials OAuth flow
|
||||
--putio-client-id string OAuth Client Id
|
||||
--putio-client-secret string OAuth Client Secret
|
||||
--putio-description string Description of the remote
|
||||
@ -683,7 +713,7 @@ rclone [flags]
|
||||
--quatrix-skip-project-folders Skip project folders in operations
|
||||
-q, --quiet Print as little stuff as possible
|
||||
--rc Enable the remote control server
|
||||
--rc-addr stringArray IPaddress:Port or :Port to bind server to (default ["localhost:5572"])
|
||||
--rc-addr stringArray IPaddress:Port or :Port to bind server to (default localhost:5572)
|
||||
--rc-allow-origin string Origin which cross-domain request (CORS) can be executed from
|
||||
--rc-baseurl string Prefix for URLs - leave blank for root
|
||||
--rc-cert string TLS PEM key (concatenation of certificate and CA certificate)
|
||||
@ -721,6 +751,7 @@ rclone [flags]
|
||||
--s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi)
|
||||
--s3-decompress If set this will decompress gzip encoded objects
|
||||
--s3-description string Description of the remote
|
||||
--s3-directory-bucket Set to use AWS Directory Buckets
|
||||
--s3-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
||||
--s3-disable-checksum Don't store MD5 checksum with object metadata
|
||||
--s3-disable-http2 Disable usage of http2 for S3 backends
|
||||
@ -803,6 +834,7 @@ rclone [flags]
|
||||
--sftp-pass string SSH password, leave blank to use ssh-agent (obscured)
|
||||
--sftp-path-override string Override path used by SSH shell commands
|
||||
--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
|
||||
--sftp-server-command string Specifies the path or command to run a sftp server on the remote host
|
||||
--sftp-set-env SpaceSepList Environment variables to pass to sftp and commands
|
||||
@ -818,6 +850,7 @@ rclone [flags]
|
||||
--sftp-user string SSH username (default "$USER")
|
||||
--sharefile-auth-url string Auth server URL
|
||||
--sharefile-chunk-size SizeSuffix Upload chunk size (default 64Mi)
|
||||
--sharefile-client-credentials Use client credentials OAuth flow
|
||||
--sharefile-client-id string OAuth Client Id
|
||||
--sharefile-client-secret string OAuth Client Secret
|
||||
--sharefile-description string Description of the remote
|
||||
@ -932,9 +965,10 @@ 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.68.0")
|
||||
--user-agent string Set the user-agent to a specified string (default "rclone/v1.69.0")
|
||||
-v, --verbose count Print lots more stuff (repeat for more)
|
||||
-V, --version Print the version number
|
||||
--webdav-auth-redirect Preserve authentication on redirect
|
||||
--webdav-bearer-token string Bearer token instead of user/pass (e.g. a Macaroon)
|
||||
--webdav-bearer-token-command string Command to run to get a bearer token
|
||||
--webdav-description string Description of the remote
|
||||
@ -950,6 +984,7 @@ rclone [flags]
|
||||
--webdav-user string User name
|
||||
--webdav-vendor string Name of the WebDAV site/service/software you are using
|
||||
--yandex-auth-url string Auth server URL
|
||||
--yandex-client-credentials Use client credentials OAuth flow
|
||||
--yandex-client-id string OAuth Client Id
|
||||
--yandex-client-secret string OAuth Client Secret
|
||||
--yandex-description string Description of the remote
|
||||
@ -959,6 +994,7 @@ rclone [flags]
|
||||
--yandex-token string OAuth Access Token as a JSON blob
|
||||
--yandex-token-url string Token server url
|
||||
--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
|
||||
@ -966,6 +1002,7 @@ rclone [flags]
|
||||
--zoho-region string Zoho region to connect to
|
||||
--zoho-token string OAuth Access Token as a JSON blob
|
||||
--zoho-token-url string Token server url
|
||||
--zoho-upload-cutoff SizeSuffix Cutoff for switching to large file upload api (>= 10 MiB) (default 10Mi)
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
@ -83,6 +83,7 @@ Flags for anything which can copy a file
|
||||
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||
--immutable Do not modify files, fail if existing files have been modified
|
||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
|
||||
--max-backlog int Maximum number of objects in sync or check backlog (default 10000)
|
||||
--max-duration Duration Maximum duration rclone will transfer data for (default 0s)
|
||||
--max-transfer SizeSuffix Maximum size of data to transfer (default off)
|
||||
|
@ -106,6 +106,7 @@ Flags for anything which can copy a file
|
||||
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||
--immutable Do not modify files, fail if existing files have been modified
|
||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
|
||||
--max-backlog int Maximum number of objects in sync or check backlog (default 10000)
|
||||
--max-duration Duration Maximum duration rclone will transfer data for (default 0s)
|
||||
--max-transfer SizeSuffix Maximum size of data to transfer (default off)
|
||||
|
@ -69,6 +69,7 @@ Flags for anything which can copy a file
|
||||
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||
--immutable Do not modify files, fail if existing files have been modified
|
||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
|
||||
--max-backlog int Maximum number of objects in sync or check backlog (default 10000)
|
||||
--max-duration Duration Maximum duration rclone will transfer data for (default 0s)
|
||||
--max-transfer SizeSuffix Maximum size of data to transfer (default off)
|
||||
|
@ -54,7 +54,9 @@ When running in background mode the user will have to stop the mount manually:
|
||||
|
||||
# Linux
|
||||
fusermount -u /path/to/local/mount
|
||||
# OS X
|
||||
#... or on some systems
|
||||
fusermount3 -u /path/to/local/mount
|
||||
# OS X or Linux when using nfsmount
|
||||
umount /path/to/local/mount
|
||||
|
||||
The umount operation can fail, for example when the mountpoint is busy.
|
||||
@ -398,9 +400,9 @@ Note that systemd runs mount units without any environment variables including
|
||||
`PATH` or `HOME`. This means that tilde (`~`) expansion will not work
|
||||
and you should provide `--config` and `--cache-dir` explicitly as absolute
|
||||
paths via rclone arguments.
|
||||
Since mounting requires the `fusermount` program, rclone will use the fallback
|
||||
PATH of `/bin:/usr/bin` in this scenario. Please ensure that `fusermount`
|
||||
is present on this PATH.
|
||||
Since mounting requires the `fusermount` or `fusermount3` program,
|
||||
rclone will use the fallback PATH of `/bin:/usr/bin` in this scenario.
|
||||
Please ensure that `fusermount`/`fusermount3` is present on this PATH.
|
||||
|
||||
## Rclone as Unix mount helper
|
||||
|
||||
@ -777,6 +779,50 @@ modified files from the cache (the related global flag `--checkers` has no effec
|
||||
|
||||
--transfers int Number of file transfers to run in parallel (default 4)
|
||||
|
||||
## Symlinks
|
||||
|
||||
By default the VFS does not support symlinks. However this may be
|
||||
enabled with either of the following flags:
|
||||
|
||||
--links Translate symlinks to/from regular files with a '.rclonelink' extension.
|
||||
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
|
||||
As most cloud storage systems do not support symlinks directly, rclone
|
||||
stores the symlink as a normal file with a special extension. So a
|
||||
file which appears as a symlink `link-to-file.txt` would be stored on
|
||||
cloud storage as `link-to-file.txt.rclonelink` and the contents would
|
||||
be the path to the symlink destination.
|
||||
|
||||
Note that `--links` enables symlink translation globally in rclone -
|
||||
this includes any backend which supports the concept (for example the
|
||||
local backend). `--vfs-links` just enables it for the VFS layer.
|
||||
|
||||
This scheme is compatible with that used by the [local backend with the --local-links flag](/local/#symlinks-junction-points).
|
||||
|
||||
The `--vfs-links` flag has been designed for `rclone mount`, `rclone
|
||||
nfsmount` and `rclone serve nfs`.
|
||||
|
||||
It hasn't been tested with the other `rclone serve` commands yet.
|
||||
|
||||
A limitation of the current implementation is that it expects the
|
||||
caller to resolve sub-symlinks. For example given this directory tree
|
||||
|
||||
```
|
||||
.
|
||||
├── dir
|
||||
│ └── file.txt
|
||||
└── linked-dir -> dir
|
||||
```
|
||||
|
||||
The VFS will correctly resolve `linked-dir` but not
|
||||
`linked-dir/file.txt`. This is not a problem for the tested commands
|
||||
but may be for other commands.
|
||||
|
||||
**Note** that there is an outstanding issue with symlink support
|
||||
[issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate
|
||||
files being created when symlinks are moved into directories where
|
||||
there is a file of the same name (or vice versa).
|
||||
|
||||
## VFS Case Sensitivity
|
||||
|
||||
Linux file systems are case-sensitive: two files can differ only
|
||||
@ -881,6 +927,7 @@ rclone mount remote:path /path/to/mountpoint [flags]
|
||||
--fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required)
|
||||
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
-h, --help help for mount
|
||||
--link-perms FileMode Link permissions (default 666)
|
||||
--max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki)
|
||||
--mount-case-insensitive Tristate Tell the OS the mount is case insensitive (true) or sensitive (false) regardless of the backend (auto) (default unset)
|
||||
--network-mode Mount as remote network drive, instead of fixed disk drive (supported on Windows only)
|
||||
@ -903,6 +950,7 @@ rclone mount remote:path /path/to/mountpoint [flags]
|
||||
--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-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
--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)
|
||||
|
@ -81,6 +81,7 @@ Flags for anything which can copy a file
|
||||
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||
--immutable Do not modify files, fail if existing files have been modified
|
||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
|
||||
--max-backlog int Maximum number of objects in sync or check backlog (default 10000)
|
||||
--max-duration Duration Maximum duration rclone will transfer data for (default 0s)
|
||||
--max-transfer SizeSuffix Maximum size of data to transfer (default off)
|
||||
|
@ -72,6 +72,7 @@ Flags for anything which can copy a file
|
||||
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||
--immutable Do not modify files, fail if existing files have been modified
|
||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
|
||||
--max-backlog int Maximum number of objects in sync or check backlog (default 10000)
|
||||
--max-duration Duration Maximum duration rclone will transfer data for (default 0s)
|
||||
--max-transfer SizeSuffix Maximum size of data to transfer (default off)
|
||||
|
@ -55,7 +55,9 @@ When running in background mode the user will have to stop the mount manually:
|
||||
|
||||
# Linux
|
||||
fusermount -u /path/to/local/mount
|
||||
# OS X
|
||||
#... or on some systems
|
||||
fusermount3 -u /path/to/local/mount
|
||||
# OS X or Linux when using nfsmount
|
||||
umount /path/to/local/mount
|
||||
|
||||
The umount operation can fail, for example when the mountpoint is busy.
|
||||
@ -399,9 +401,9 @@ Note that systemd runs mount units without any environment variables including
|
||||
`PATH` or `HOME`. This means that tilde (`~`) expansion will not work
|
||||
and you should provide `--config` and `--cache-dir` explicitly as absolute
|
||||
paths via rclone arguments.
|
||||
Since mounting requires the `fusermount` program, rclone will use the fallback
|
||||
PATH of `/bin:/usr/bin` in this scenario. Please ensure that `fusermount`
|
||||
is present on this PATH.
|
||||
Since mounting requires the `fusermount` or `fusermount3` program,
|
||||
rclone will use the fallback PATH of `/bin:/usr/bin` in this scenario.
|
||||
Please ensure that `fusermount`/`fusermount3` is present on this PATH.
|
||||
|
||||
## Rclone as Unix mount helper
|
||||
|
||||
@ -778,6 +780,50 @@ modified files from the cache (the related global flag `--checkers` has no effec
|
||||
|
||||
--transfers int Number of file transfers to run in parallel (default 4)
|
||||
|
||||
## Symlinks
|
||||
|
||||
By default the VFS does not support symlinks. However this may be
|
||||
enabled with either of the following flags:
|
||||
|
||||
--links Translate symlinks to/from regular files with a '.rclonelink' extension.
|
||||
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
|
||||
As most cloud storage systems do not support symlinks directly, rclone
|
||||
stores the symlink as a normal file with a special extension. So a
|
||||
file which appears as a symlink `link-to-file.txt` would be stored on
|
||||
cloud storage as `link-to-file.txt.rclonelink` and the contents would
|
||||
be the path to the symlink destination.
|
||||
|
||||
Note that `--links` enables symlink translation globally in rclone -
|
||||
this includes any backend which supports the concept (for example the
|
||||
local backend). `--vfs-links` just enables it for the VFS layer.
|
||||
|
||||
This scheme is compatible with that used by the [local backend with the --local-links flag](/local/#symlinks-junction-points).
|
||||
|
||||
The `--vfs-links` flag has been designed for `rclone mount`, `rclone
|
||||
nfsmount` and `rclone serve nfs`.
|
||||
|
||||
It hasn't been tested with the other `rclone serve` commands yet.
|
||||
|
||||
A limitation of the current implementation is that it expects the
|
||||
caller to resolve sub-symlinks. For example given this directory tree
|
||||
|
||||
```
|
||||
.
|
||||
├── dir
|
||||
│ └── file.txt
|
||||
└── linked-dir -> dir
|
||||
```
|
||||
|
||||
The VFS will correctly resolve `linked-dir` but not
|
||||
`linked-dir/file.txt`. This is not a problem for the tested commands
|
||||
but may be for other commands.
|
||||
|
||||
**Note** that there is an outstanding issue with symlink support
|
||||
[issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate
|
||||
files being created when symlinks are moved into directories where
|
||||
there is a file of the same name (or vice versa).
|
||||
|
||||
## VFS Case Sensitivity
|
||||
|
||||
Linux file systems are case-sensitive: two files can differ only
|
||||
@ -883,6 +929,7 @@ rclone nfsmount remote:path /path/to/mountpoint [flags]
|
||||
--fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required)
|
||||
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
-h, --help help for nfsmount
|
||||
--link-perms FileMode Link permissions (default 666)
|
||||
--max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki)
|
||||
--mount-case-insensitive Tristate Tell the OS the mount is case insensitive (true) or sensitive (false) regardless of the backend (auto) (default unset)
|
||||
--network-mode Mount as remote network drive, instead of fixed disk drive (supported on Windows only)
|
||||
@ -909,6 +956,7 @@ rclone nfsmount remote:path /path/to/mountpoint [flags]
|
||||
--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-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
--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)
|
||||
|
@ -31,8 +31,7 @@ If you set `--rc-addr` to listen on a public or LAN accessible IP address
|
||||
then using Authentication is advised - see the next section for info.
|
||||
|
||||
You can use a unix socket by setting the url to `unix:///path/to/socket`
|
||||
or just by using an absolute path name. Note that unix sockets bypass the
|
||||
authentication - this is expected to be done with file system permissions.
|
||||
or just by using an absolute path name.
|
||||
|
||||
`--rc-addr` may be repeated to listen on multiple IPs/ports/sockets.
|
||||
Socket activation, described further below, can also be used to accomplish the same.
|
||||
@ -59,19 +58,21 @@ 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.
|
||||
|
||||
`--rc-cert` should be a either a PEM encoded certificate or a concatenation
|
||||
of that with the CA certificate. `--krc-ey` should be the PEM encoded
|
||||
private key and `--rc-client-ca` should be the PEM encoded client
|
||||
certificate authority certificate.
|
||||
`--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
|
||||
with the PEM encoded private key. If setting `--rc-client-ca`,
|
||||
it should be set to the path of a file with PEM encoded client certificate
|
||||
authority certificates.
|
||||
|
||||
`--rc-min-tls-version` is minimum TLS version that is acceptable. Valid
|
||||
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default
|
||||
"tls1.0").
|
||||
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0").
|
||||
|
||||
## Socket activation
|
||||
|
||||
Instead of the listening addresses specified above, rclone will listen to all
|
||||
FDs passed by the service manager, if any (and ignore any arguments passed by --rc-addr`).
|
||||
FDs passed by the service manager, if any (and ignore any arguments passed
|
||||
by `--rc-addr`).
|
||||
|
||||
This allows rclone to be a socket-activated service.
|
||||
It can be configured with .socket and .service unit files as described in
|
||||
@ -166,7 +167,7 @@ Flags to control the Remote Control API
|
||||
|
||||
```
|
||||
--rc Enable the remote control server
|
||||
--rc-addr stringArray IPaddress:Port or :Port to bind server to (default ["localhost:5572"])
|
||||
--rc-addr stringArray IPaddress:Port or :Port to bind server to (default localhost:5572)
|
||||
--rc-allow-origin string Origin which cross-domain request (CORS) can be executed from
|
||||
--rc-baseurl string Prefix for URLs - leave blank for root
|
||||
--rc-cert string TLS PEM key (concatenation of certificate and CA certificate)
|
||||
|
@ -342,6 +342,50 @@ modified files from the cache (the related global flag `--checkers` has no effec
|
||||
|
||||
--transfers int Number of file transfers to run in parallel (default 4)
|
||||
|
||||
## Symlinks
|
||||
|
||||
By default the VFS does not support symlinks. However this may be
|
||||
enabled with either of the following flags:
|
||||
|
||||
--links Translate symlinks to/from regular files with a '.rclonelink' extension.
|
||||
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
|
||||
As most cloud storage systems do not support symlinks directly, rclone
|
||||
stores the symlink as a normal file with a special extension. So a
|
||||
file which appears as a symlink `link-to-file.txt` would be stored on
|
||||
cloud storage as `link-to-file.txt.rclonelink` and the contents would
|
||||
be the path to the symlink destination.
|
||||
|
||||
Note that `--links` enables symlink translation globally in rclone -
|
||||
this includes any backend which supports the concept (for example the
|
||||
local backend). `--vfs-links` just enables it for the VFS layer.
|
||||
|
||||
This scheme is compatible with that used by the [local backend with the --local-links flag](/local/#symlinks-junction-points).
|
||||
|
||||
The `--vfs-links` flag has been designed for `rclone mount`, `rclone
|
||||
nfsmount` and `rclone serve nfs`.
|
||||
|
||||
It hasn't been tested with the other `rclone serve` commands yet.
|
||||
|
||||
A limitation of the current implementation is that it expects the
|
||||
caller to resolve sub-symlinks. For example given this directory tree
|
||||
|
||||
```
|
||||
.
|
||||
├── dir
|
||||
│ └── file.txt
|
||||
└── linked-dir -> dir
|
||||
```
|
||||
|
||||
The VFS will correctly resolve `linked-dir` but not
|
||||
`linked-dir/file.txt`. This is not a problem for the tested commands
|
||||
but may be for other commands.
|
||||
|
||||
**Note** that there is an outstanding issue with symlink support
|
||||
[issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate
|
||||
files being created when symlinks are moved into directories where
|
||||
there is a file of the same name (or vice versa).
|
||||
|
||||
## VFS Case Sensitivity
|
||||
|
||||
Linux file systems are case-sensitive: two files can differ only
|
||||
@ -436,6 +480,7 @@ rclone serve dlna remote:path [flags]
|
||||
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
-h, --help help for dlna
|
||||
--interface stringArray The interface to use for SSDP (repeat as necessary)
|
||||
--link-perms FileMode Link permissions (default 666)
|
||||
--log-trace Enable trace logging of SOAP traffic
|
||||
--name string Name of DLNA server
|
||||
--no-checksum Don't compare checksums on up/download
|
||||
@ -454,6 +499,7 @@ rclone serve dlna remote:path [flags]
|
||||
--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-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
--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)
|
||||
|
@ -354,6 +354,50 @@ modified files from the cache (the related global flag `--checkers` has no effec
|
||||
|
||||
--transfers int Number of file transfers to run in parallel (default 4)
|
||||
|
||||
## Symlinks
|
||||
|
||||
By default the VFS does not support symlinks. However this may be
|
||||
enabled with either of the following flags:
|
||||
|
||||
--links Translate symlinks to/from regular files with a '.rclonelink' extension.
|
||||
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
|
||||
As most cloud storage systems do not support symlinks directly, rclone
|
||||
stores the symlink as a normal file with a special extension. So a
|
||||
file which appears as a symlink `link-to-file.txt` would be stored on
|
||||
cloud storage as `link-to-file.txt.rclonelink` and the contents would
|
||||
be the path to the symlink destination.
|
||||
|
||||
Note that `--links` enables symlink translation globally in rclone -
|
||||
this includes any backend which supports the concept (for example the
|
||||
local backend). `--vfs-links` just enables it for the VFS layer.
|
||||
|
||||
This scheme is compatible with that used by the [local backend with the --local-links flag](/local/#symlinks-junction-points).
|
||||
|
||||
The `--vfs-links` flag has been designed for `rclone mount`, `rclone
|
||||
nfsmount` and `rclone serve nfs`.
|
||||
|
||||
It hasn't been tested with the other `rclone serve` commands yet.
|
||||
|
||||
A limitation of the current implementation is that it expects the
|
||||
caller to resolve sub-symlinks. For example given this directory tree
|
||||
|
||||
```
|
||||
.
|
||||
├── dir
|
||||
│ └── file.txt
|
||||
└── linked-dir -> dir
|
||||
```
|
||||
|
||||
The VFS will correctly resolve `linked-dir` but not
|
||||
`linked-dir/file.txt`. This is not a problem for the tested commands
|
||||
but may be for other commands.
|
||||
|
||||
**Note** that there is an outstanding issue with symlink support
|
||||
[issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate
|
||||
files being created when symlinks are moved into directories where
|
||||
there is a file of the same name (or vice versa).
|
||||
|
||||
## VFS Case Sensitivity
|
||||
|
||||
Linux file systems are case-sensitive: two files can differ only
|
||||
@ -460,6 +504,7 @@ rclone serve docker [flags]
|
||||
--fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required)
|
||||
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
-h, --help help for docker
|
||||
--link-perms FileMode Link permissions (default 666)
|
||||
--max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki)
|
||||
--mount-case-insensitive Tristate Tell the OS the mount is case insensitive (true) or sensitive (false) regardless of the backend (auto) (default unset)
|
||||
--network-mode Mount as remote network drive, instead of fixed disk drive (supported on Windows only)
|
||||
@ -485,6 +530,7 @@ rclone serve docker [flags]
|
||||
--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-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
--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)
|
||||
|
@ -335,6 +335,50 @@ modified files from the cache (the related global flag `--checkers` has no effec
|
||||
|
||||
--transfers int Number of file transfers to run in parallel (default 4)
|
||||
|
||||
## Symlinks
|
||||
|
||||
By default the VFS does not support symlinks. However this may be
|
||||
enabled with either of the following flags:
|
||||
|
||||
--links Translate symlinks to/from regular files with a '.rclonelink' extension.
|
||||
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
|
||||
As most cloud storage systems do not support symlinks directly, rclone
|
||||
stores the symlink as a normal file with a special extension. So a
|
||||
file which appears as a symlink `link-to-file.txt` would be stored on
|
||||
cloud storage as `link-to-file.txt.rclonelink` and the contents would
|
||||
be the path to the symlink destination.
|
||||
|
||||
Note that `--links` enables symlink translation globally in rclone -
|
||||
this includes any backend which supports the concept (for example the
|
||||
local backend). `--vfs-links` just enables it for the VFS layer.
|
||||
|
||||
This scheme is compatible with that used by the [local backend with the --local-links flag](/local/#symlinks-junction-points).
|
||||
|
||||
The `--vfs-links` flag has been designed for `rclone mount`, `rclone
|
||||
nfsmount` and `rclone serve nfs`.
|
||||
|
||||
It hasn't been tested with the other `rclone serve` commands yet.
|
||||
|
||||
A limitation of the current implementation is that it expects the
|
||||
caller to resolve sub-symlinks. For example given this directory tree
|
||||
|
||||
```
|
||||
.
|
||||
├── dir
|
||||
│ └── file.txt
|
||||
└── linked-dir -> dir
|
||||
```
|
||||
|
||||
The VFS will correctly resolve `linked-dir` but not
|
||||
`linked-dir/file.txt`. This is not a problem for the tested commands
|
||||
but may be for other commands.
|
||||
|
||||
**Note** that there is an outstanding issue with symlink support
|
||||
[issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate
|
||||
files being created when symlinks are moved into directories where
|
||||
there is a file of the same name (or vice versa).
|
||||
|
||||
## VFS Case Sensitivity
|
||||
|
||||
Linux file systems are case-sensitive: two files can differ only
|
||||
@ -511,6 +555,7 @@ rclone serve ftp remote:path [flags]
|
||||
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
-h, --help help for ftp
|
||||
--key string TLS PEM Private key
|
||||
--link-perms FileMode Link permissions (default 666)
|
||||
--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
|
||||
@ -531,6 +576,7 @@ rclone serve ftp remote:path [flags]
|
||||
--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-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
--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)
|
||||
|
@ -33,8 +33,7 @@ If you set `--addr` to listen on a public or LAN accessible IP address
|
||||
then using Authentication is advised - see the next section for info.
|
||||
|
||||
You can use a unix socket by setting the url to `unix:///path/to/socket`
|
||||
or just by using an absolute path name. Note that unix sockets bypass the
|
||||
authentication - this is expected to be done with file system permissions.
|
||||
or just by using an absolute path name.
|
||||
|
||||
`--addr` may be repeated to listen on multiple IPs/ports/sockets.
|
||||
Socket activation, described further below, can also be used to accomplish the same.
|
||||
@ -61,19 +60,21 @@ 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.
|
||||
|
||||
`--cert` should be a either a PEM encoded certificate or a concatenation
|
||||
of that with the CA certificate. `--key` should be the PEM encoded
|
||||
private key and `--client-ca` should be the PEM encoded client
|
||||
certificate authority certificate.
|
||||
`--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
|
||||
with the PEM encoded private key. If setting `--client-ca`,
|
||||
it should be set to the path of a file with PEM encoded client certificate
|
||||
authority certificates.
|
||||
|
||||
`--min-tls-version` is minimum TLS version that is acceptable. Valid
|
||||
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default
|
||||
"tls1.0").
|
||||
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0").
|
||||
|
||||
## Socket activation
|
||||
|
||||
Instead of the listening addresses specified above, rclone will listen to all
|
||||
FDs passed by the service manager, if any (and ignore any arguments passed by --addr`).
|
||||
FDs passed by the service manager, if any (and ignore any arguments passed
|
||||
by `--addr`).
|
||||
|
||||
This allows rclone to be a socket-activated service.
|
||||
It can be configured with .socket and .service unit files as described in
|
||||
@ -452,6 +453,50 @@ modified files from the cache (the related global flag `--checkers` has no effec
|
||||
|
||||
--transfers int Number of file transfers to run in parallel (default 4)
|
||||
|
||||
## Symlinks
|
||||
|
||||
By default the VFS does not support symlinks. However this may be
|
||||
enabled with either of the following flags:
|
||||
|
||||
--links Translate symlinks to/from regular files with a '.rclonelink' extension.
|
||||
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
|
||||
As most cloud storage systems do not support symlinks directly, rclone
|
||||
stores the symlink as a normal file with a special extension. So a
|
||||
file which appears as a symlink `link-to-file.txt` would be stored on
|
||||
cloud storage as `link-to-file.txt.rclonelink` and the contents would
|
||||
be the path to the symlink destination.
|
||||
|
||||
Note that `--links` enables symlink translation globally in rclone -
|
||||
this includes any backend which supports the concept (for example the
|
||||
local backend). `--vfs-links` just enables it for the VFS layer.
|
||||
|
||||
This scheme is compatible with that used by the [local backend with the --local-links flag](/local/#symlinks-junction-points).
|
||||
|
||||
The `--vfs-links` flag has been designed for `rclone mount`, `rclone
|
||||
nfsmount` and `rclone serve nfs`.
|
||||
|
||||
It hasn't been tested with the other `rclone serve` commands yet.
|
||||
|
||||
A limitation of the current implementation is that it expects the
|
||||
caller to resolve sub-symlinks. For example given this directory tree
|
||||
|
||||
```
|
||||
.
|
||||
├── dir
|
||||
│ └── file.txt
|
||||
└── linked-dir -> dir
|
||||
```
|
||||
|
||||
The VFS will correctly resolve `linked-dir` but not
|
||||
`linked-dir/file.txt`. This is not a problem for the tested commands
|
||||
but may be for other commands.
|
||||
|
||||
**Note** that there is an outstanding issue with symlink support
|
||||
[issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate
|
||||
files being created when symlinks are moved into directories where
|
||||
there is a file of the same name (or vice versa).
|
||||
|
||||
## VFS Case Sensitivity
|
||||
|
||||
Linux file systems are case-sensitive: two files can differ only
|
||||
@ -623,15 +668,16 @@ rclone serve http remote:path [flags]
|
||||
--allow-origin string Origin which cross-domain request (CORS) can be executed from
|
||||
--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
|
||||
--cert string Path to TLS PEM public key certificate file (can also include intermediate/CA certificates)
|
||||
--client-ca string Path to TLS PEM CA file with certificate authorities to verify clients with
|
||||
--dir-cache-time Duration Time to cache directory entries for (default 5m0s)
|
||||
--dir-perms FileMode Directory permissions (default 777)
|
||||
--file-perms FileMode File permissions (default 666)
|
||||
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
-h, --help help for http
|
||||
--htpasswd string A htpasswd file - if not provided no authentication is done
|
||||
--key string TLS PEM Private key
|
||||
--key string Path to TLS PEM private key file
|
||||
--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
|
||||
@ -657,6 +703,7 @@ rclone serve http remote:path [flags]
|
||||
--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-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
--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)
|
||||
|
@ -53,7 +53,9 @@ that it uses an on disk cache, but the cache entries are held as
|
||||
symlinks. Rclone will use the handle of the underlying file as the NFS
|
||||
handle which improves performance. This sort of cache can't be backed
|
||||
up and restored as the underlying handles will change. This is Linux
|
||||
only.
|
||||
only. It requres running rclone as root or with `CAP_DAC_READ_SEARCH`.
|
||||
You can run rclone with this extra permission by doing this to the
|
||||
rclone binary `sudo setcap cap_dac_read_search+ep /path/to/rclone`.
|
||||
|
||||
`--nfs-cache-handle-limit` controls the maximum number of cached NFS
|
||||
handles stored by the caching handler. This should not be set too low
|
||||
@ -382,6 +384,50 @@ modified files from the cache (the related global flag `--checkers` has no effec
|
||||
|
||||
--transfers int Number of file transfers to run in parallel (default 4)
|
||||
|
||||
## Symlinks
|
||||
|
||||
By default the VFS does not support symlinks. However this may be
|
||||
enabled with either of the following flags:
|
||||
|
||||
--links Translate symlinks to/from regular files with a '.rclonelink' extension.
|
||||
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
|
||||
As most cloud storage systems do not support symlinks directly, rclone
|
||||
stores the symlink as a normal file with a special extension. So a
|
||||
file which appears as a symlink `link-to-file.txt` would be stored on
|
||||
cloud storage as `link-to-file.txt.rclonelink` and the contents would
|
||||
be the path to the symlink destination.
|
||||
|
||||
Note that `--links` enables symlink translation globally in rclone -
|
||||
this includes any backend which supports the concept (for example the
|
||||
local backend). `--vfs-links` just enables it for the VFS layer.
|
||||
|
||||
This scheme is compatible with that used by the [local backend with the --local-links flag](/local/#symlinks-junction-points).
|
||||
|
||||
The `--vfs-links` flag has been designed for `rclone mount`, `rclone
|
||||
nfsmount` and `rclone serve nfs`.
|
||||
|
||||
It hasn't been tested with the other `rclone serve` commands yet.
|
||||
|
||||
A limitation of the current implementation is that it expects the
|
||||
caller to resolve sub-symlinks. For example given this directory tree
|
||||
|
||||
```
|
||||
.
|
||||
├── dir
|
||||
│ └── file.txt
|
||||
└── linked-dir -> dir
|
||||
```
|
||||
|
||||
The VFS will correctly resolve `linked-dir` but not
|
||||
`linked-dir/file.txt`. This is not a problem for the tested commands
|
||||
but may be for other commands.
|
||||
|
||||
**Note** that there is an outstanding issue with symlink support
|
||||
[issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate
|
||||
files being created when symlinks are moved into directories where
|
||||
there is a file of the same name (or vice versa).
|
||||
|
||||
## VFS Case Sensitivity
|
||||
|
||||
Linux file systems are case-sensitive: two files can differ only
|
||||
@ -474,6 +520,7 @@ rclone serve nfs remote:path [flags]
|
||||
--file-perms FileMode File permissions (default 666)
|
||||
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
-h, --help help for nfs
|
||||
--link-perms FileMode Link permissions (default 666)
|
||||
--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)
|
||||
@ -493,6 +540,7 @@ rclone serve nfs remote:path [flags]
|
||||
--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-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
--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)
|
||||
|
@ -103,8 +103,7 @@ If you set `--addr` to listen on a public or LAN accessible IP address
|
||||
then using Authentication is advised - see the next section for info.
|
||||
|
||||
You can use a unix socket by setting the url to `unix:///path/to/socket`
|
||||
or just by using an absolute path name. Note that unix sockets bypass the
|
||||
authentication - this is expected to be done with file system permissions.
|
||||
or just by using an absolute path name.
|
||||
|
||||
`--addr` may be repeated to listen on multiple IPs/ports/sockets.
|
||||
Socket activation, described further below, can also be used to accomplish the same.
|
||||
@ -131,19 +130,21 @@ 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.
|
||||
|
||||
`--cert` should be a either a PEM encoded certificate or a concatenation
|
||||
of that with the CA certificate. `--key` should be the PEM encoded
|
||||
private key and `--client-ca` should be the PEM encoded client
|
||||
certificate authority certificate.
|
||||
`--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
|
||||
with the PEM encoded private key. If setting `--client-ca`,
|
||||
it should be set to the path of a file with PEM encoded client certificate
|
||||
authority certificates.
|
||||
|
||||
`--min-tls-version` is minimum TLS version that is acceptable. Valid
|
||||
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default
|
||||
"tls1.0").
|
||||
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0").
|
||||
|
||||
## Socket activation
|
||||
|
||||
Instead of the listening addresses specified above, rclone will listen to all
|
||||
FDs passed by the service manager, if any (and ignore any arguments passed by --addr`).
|
||||
FDs passed by the service manager, if any (and ignore any arguments passed
|
||||
by `--addr`).
|
||||
|
||||
This allows rclone to be a socket-activated service.
|
||||
It can be configured with .socket and .service unit files as described in
|
||||
@ -195,11 +196,11 @@ rclone serve restic remote:path [flags]
|
||||
--append-only Disallow deletion of repository data
|
||||
--baseurl string Prefix for URLs - leave blank for root
|
||||
--cache-objects Cache listed objects (default true)
|
||||
--cert string TLS PEM key (concatenation of certificate and CA certificate)
|
||||
--client-ca string Client certificate authority to verify clients with
|
||||
--cert string Path to TLS PEM public key certificate file (can also include intermediate/CA certificates)
|
||||
--client-ca string Path to TLS PEM CA file with certificate authorities to verify clients with
|
||||
-h, --help help for restic
|
||||
--htpasswd string A htpasswd file - if not provided no authentication is done
|
||||
--key string TLS PEM Private key
|
||||
--key string Path to TLS PEM private key file
|
||||
--max-header-bytes int Maximum size of request header (default 4096)
|
||||
--min-tls-version string Minimum TLS version that is acceptable (default "tls1.0")
|
||||
--pass string Password for authentication
|
||||
|
@ -185,8 +185,7 @@ If you set `--addr` to listen on a public or LAN accessible IP address
|
||||
then using Authentication is advised - see the next section for info.
|
||||
|
||||
You can use a unix socket by setting the url to `unix:///path/to/socket`
|
||||
or just by using an absolute path name. Note that unix sockets bypass the
|
||||
authentication - this is expected to be done with file system permissions.
|
||||
or just by using an absolute path name.
|
||||
|
||||
`--addr` may be repeated to listen on multiple IPs/ports/sockets.
|
||||
Socket activation, described further below, can also be used to accomplish the same.
|
||||
@ -213,19 +212,21 @@ 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.
|
||||
|
||||
`--cert` should be a either a PEM encoded certificate or a concatenation
|
||||
of that with the CA certificate. `--key` should be the PEM encoded
|
||||
private key and `--client-ca` should be the PEM encoded client
|
||||
certificate authority certificate.
|
||||
`--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
|
||||
with the PEM encoded private key. If setting `--client-ca`,
|
||||
it should be set to the path of a file with PEM encoded client certificate
|
||||
authority certificates.
|
||||
|
||||
`--min-tls-version` is minimum TLS version that is acceptable. Valid
|
||||
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default
|
||||
"tls1.0").
|
||||
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0").
|
||||
|
||||
## Socket activation
|
||||
|
||||
Instead of the listening addresses specified above, rclone will listen to all
|
||||
FDs passed by the service manager, if any (and ignore any arguments passed by --addr`).
|
||||
FDs passed by the service manager, if any (and ignore any arguments passed
|
||||
by `--addr`).
|
||||
|
||||
This allows rclone to be a socket-activated service.
|
||||
It can be configured with .socket and .service unit files as described in
|
||||
@ -541,6 +542,50 @@ modified files from the cache (the related global flag `--checkers` has no effec
|
||||
|
||||
--transfers int Number of file transfers to run in parallel (default 4)
|
||||
|
||||
## Symlinks
|
||||
|
||||
By default the VFS does not support symlinks. However this may be
|
||||
enabled with either of the following flags:
|
||||
|
||||
--links Translate symlinks to/from regular files with a '.rclonelink' extension.
|
||||
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
|
||||
As most cloud storage systems do not support symlinks directly, rclone
|
||||
stores the symlink as a normal file with a special extension. So a
|
||||
file which appears as a symlink `link-to-file.txt` would be stored on
|
||||
cloud storage as `link-to-file.txt.rclonelink` and the contents would
|
||||
be the path to the symlink destination.
|
||||
|
||||
Note that `--links` enables symlink translation globally in rclone -
|
||||
this includes any backend which supports the concept (for example the
|
||||
local backend). `--vfs-links` just enables it for the VFS layer.
|
||||
|
||||
This scheme is compatible with that used by the [local backend with the --local-links flag](/local/#symlinks-junction-points).
|
||||
|
||||
The `--vfs-links` flag has been designed for `rclone mount`, `rclone
|
||||
nfsmount` and `rclone serve nfs`.
|
||||
|
||||
It hasn't been tested with the other `rclone serve` commands yet.
|
||||
|
||||
A limitation of the current implementation is that it expects the
|
||||
caller to resolve sub-symlinks. For example given this directory tree
|
||||
|
||||
```
|
||||
.
|
||||
├── dir
|
||||
│ └── file.txt
|
||||
└── linked-dir -> dir
|
||||
```
|
||||
|
||||
The VFS will correctly resolve `linked-dir` but not
|
||||
`linked-dir/file.txt`. This is not a problem for the tested commands
|
||||
but may be for other commands.
|
||||
|
||||
**Note** that there is an outstanding issue with symlink support
|
||||
[issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate
|
||||
files being created when symlinks are moved into directories where
|
||||
there is a file of the same name (or vice versa).
|
||||
|
||||
## VFS Case Sensitivity
|
||||
|
||||
Linux file systems are case-sensitive: two files can differ only
|
||||
@ -632,8 +677,8 @@ rclone serve s3 remote:path [flags]
|
||||
--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
|
||||
--cert string Path to TLS PEM public key certificate file (can also include intermediate/CA certificates)
|
||||
--client-ca string Path to TLS PEM CA file with certificate authorities 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")
|
||||
@ -642,7 +687,8 @@ rclone serve s3 remote:path [flags]
|
||||
--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
|
||||
--key string Path to TLS PEM private key file
|
||||
--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
|
||||
@ -668,6 +714,7 @@ rclone serve s3 remote:path [flags]
|
||||
--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-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
--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)
|
||||
|
@ -378,6 +378,50 @@ modified files from the cache (the related global flag `--checkers` has no effec
|
||||
|
||||
--transfers int Number of file transfers to run in parallel (default 4)
|
||||
|
||||
## Symlinks
|
||||
|
||||
By default the VFS does not support symlinks. However this may be
|
||||
enabled with either of the following flags:
|
||||
|
||||
--links Translate symlinks to/from regular files with a '.rclonelink' extension.
|
||||
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
|
||||
As most cloud storage systems do not support symlinks directly, rclone
|
||||
stores the symlink as a normal file with a special extension. So a
|
||||
file which appears as a symlink `link-to-file.txt` would be stored on
|
||||
cloud storage as `link-to-file.txt.rclonelink` and the contents would
|
||||
be the path to the symlink destination.
|
||||
|
||||
Note that `--links` enables symlink translation globally in rclone -
|
||||
this includes any backend which supports the concept (for example the
|
||||
local backend). `--vfs-links` just enables it for the VFS layer.
|
||||
|
||||
This scheme is compatible with that used by the [local backend with the --local-links flag](/local/#symlinks-junction-points).
|
||||
|
||||
The `--vfs-links` flag has been designed for `rclone mount`, `rclone
|
||||
nfsmount` and `rclone serve nfs`.
|
||||
|
||||
It hasn't been tested with the other `rclone serve` commands yet.
|
||||
|
||||
A limitation of the current implementation is that it expects the
|
||||
caller to resolve sub-symlinks. For example given this directory tree
|
||||
|
||||
```
|
||||
.
|
||||
├── dir
|
||||
│ └── file.txt
|
||||
└── linked-dir -> dir
|
||||
```
|
||||
|
||||
The VFS will correctly resolve `linked-dir` but not
|
||||
`linked-dir/file.txt`. This is not a problem for the tested commands
|
||||
but may be for other commands.
|
||||
|
||||
**Note** that there is an outstanding issue with symlink support
|
||||
[issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate
|
||||
files being created when symlinks are moved into directories where
|
||||
there is a file of the same name (or vice versa).
|
||||
|
||||
## VFS Case Sensitivity
|
||||
|
||||
Linux file systems are case-sensitive: two files can differ only
|
||||
@ -554,6 +598,7 @@ rclone serve sftp remote:path [flags]
|
||||
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
-h, --help help for sftp
|
||||
--key stringArray SSH private host key file (Can be multi-valued, leave blank to auto generate)
|
||||
--link-perms FileMode Link permissions (default 666)
|
||||
--no-auth Allow connections with no authentication if set
|
||||
--no-checksum Don't compare checksums on up/download
|
||||
--no-modtime Don't read/write the modification time (can speed things up)
|
||||
@ -574,6 +619,7 @@ rclone serve sftp remote:path [flags]
|
||||
--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-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
--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)
|
||||
|
@ -76,8 +76,7 @@ If you set `--addr` to listen on a public or LAN accessible IP address
|
||||
then using Authentication is advised - see the next section for info.
|
||||
|
||||
You can use a unix socket by setting the url to `unix:///path/to/socket`
|
||||
or just by using an absolute path name. Note that unix sockets bypass the
|
||||
authentication - this is expected to be done with file system permissions.
|
||||
or just by using an absolute path name.
|
||||
|
||||
`--addr` may be repeated to listen on multiple IPs/ports/sockets.
|
||||
Socket activation, described further below, can also be used to accomplish the same.
|
||||
@ -104,19 +103,21 @@ 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.
|
||||
|
||||
`--cert` should be a either a PEM encoded certificate or a concatenation
|
||||
of that with the CA certificate. `--key` should be the PEM encoded
|
||||
private key and `--client-ca` should be the PEM encoded client
|
||||
certificate authority certificate.
|
||||
`--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
|
||||
with the PEM encoded private key. If setting `--client-ca`,
|
||||
it should be set to the path of a file with PEM encoded client certificate
|
||||
authority certificates.
|
||||
|
||||
`--min-tls-version` is minimum TLS version that is acceptable. Valid
|
||||
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default
|
||||
"tls1.0").
|
||||
values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0").
|
||||
|
||||
## Socket activation
|
||||
|
||||
Instead of the listening addresses specified above, rclone will listen to all
|
||||
FDs passed by the service manager, if any (and ignore any arguments passed by --addr`).
|
||||
FDs passed by the service manager, if any (and ignore any arguments passed
|
||||
by `--addr`).
|
||||
|
||||
This allows rclone to be a socket-activated service.
|
||||
It can be configured with .socket and .service unit files as described in
|
||||
@ -495,6 +496,50 @@ modified files from the cache (the related global flag `--checkers` has no effec
|
||||
|
||||
--transfers int Number of file transfers to run in parallel (default 4)
|
||||
|
||||
## Symlinks
|
||||
|
||||
By default the VFS does not support symlinks. However this may be
|
||||
enabled with either of the following flags:
|
||||
|
||||
--links Translate symlinks to/from regular files with a '.rclonelink' extension.
|
||||
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
|
||||
As most cloud storage systems do not support symlinks directly, rclone
|
||||
stores the symlink as a normal file with a special extension. So a
|
||||
file which appears as a symlink `link-to-file.txt` would be stored on
|
||||
cloud storage as `link-to-file.txt.rclonelink` and the contents would
|
||||
be the path to the symlink destination.
|
||||
|
||||
Note that `--links` enables symlink translation globally in rclone -
|
||||
this includes any backend which supports the concept (for example the
|
||||
local backend). `--vfs-links` just enables it for the VFS layer.
|
||||
|
||||
This scheme is compatible with that used by the [local backend with the --local-links flag](/local/#symlinks-junction-points).
|
||||
|
||||
The `--vfs-links` flag has been designed for `rclone mount`, `rclone
|
||||
nfsmount` and `rclone serve nfs`.
|
||||
|
||||
It hasn't been tested with the other `rclone serve` commands yet.
|
||||
|
||||
A limitation of the current implementation is that it expects the
|
||||
caller to resolve sub-symlinks. For example given this directory tree
|
||||
|
||||
```
|
||||
.
|
||||
├── dir
|
||||
│ └── file.txt
|
||||
└── linked-dir -> dir
|
||||
```
|
||||
|
||||
The VFS will correctly resolve `linked-dir` but not
|
||||
`linked-dir/file.txt`. This is not a problem for the tested commands
|
||||
but may be for other commands.
|
||||
|
||||
**Note** that there is an outstanding issue with symlink support
|
||||
[issue #8245](https://github.com/rclone/rclone/issues/8245) with duplicate
|
||||
files being created when symlinks are moved into directories where
|
||||
there is a file of the same name (or vice versa).
|
||||
|
||||
## VFS Case Sensitivity
|
||||
|
||||
Linux file systems are case-sensitive: two files can differ only
|
||||
@ -666,8 +711,8 @@ rclone serve webdav remote:path [flags]
|
||||
--allow-origin string Origin which cross-domain request (CORS) can be executed from
|
||||
--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
|
||||
--cert string Path to TLS PEM public key certificate file (can also include intermediate/CA certificates)
|
||||
--client-ca string Path to TLS PEM CA file with certificate authorities 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
|
||||
@ -676,7 +721,8 @@ rclone serve webdav remote:path [flags]
|
||||
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
-h, --help help for webdav
|
||||
--htpasswd string A htpasswd file - if not provided no authentication is done
|
||||
--key string TLS PEM Private key
|
||||
--key string Path to TLS PEM private key file
|
||||
--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
|
||||
@ -702,6 +748,7 @@ rclone serve webdav remote:path [flags]
|
||||
--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-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
|
||||
--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)
|
||||
|
@ -137,6 +137,7 @@ Flags for anything which can copy a file
|
||||
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||
--immutable Do not modify files, fail if existing files have been modified
|
||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
|
||||
--max-backlog int Maximum number of objects in sync or check backlog (default 10000)
|
||||
--max-duration Duration Maximum duration rclone will transfer data for (default 0s)
|
||||
--max-transfer SizeSuffix Maximum size of data to transfer (default off)
|
||||
|
@ -19,6 +19,7 @@ rclone test makefiles <dir> [flags]
|
||||
--chargen Fill files with a ASCII chargen pattern
|
||||
--files int Number of files to create (default 1000)
|
||||
--files-per-directory int Average number of files per directory (default 10)
|
||||
--flat If set create all files in the root directory
|
||||
-h, --help help for makefiles
|
||||
--max-depth int Maximum depth of directory hierarchy (default 10)
|
||||
--max-file-size SizeSuffix Maximum size of files to create (default 100)
|
||||
|
@ -693,6 +693,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --drive-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_DRIVE_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --drive-root-folder-id
|
||||
|
||||
ID of the root folder.
|
||||
@ -1685,6 +1698,41 @@ The result is a JSON array of matches, for example:
|
||||
}
|
||||
]
|
||||
|
||||
### rescue
|
||||
|
||||
Rescue or delete any orphaned files
|
||||
|
||||
rclone backend rescue remote: [options] [<arguments>+]
|
||||
|
||||
This command rescues or deletes any orphaned files or directories.
|
||||
|
||||
Sometimes files can get orphaned in Google Drive. This means that they
|
||||
are no longer in any folder in Google Drive.
|
||||
|
||||
This command finds those files and either rescues them to a directory
|
||||
you specify or deletes them.
|
||||
|
||||
Usage:
|
||||
|
||||
This can be used in 3 ways.
|
||||
|
||||
First, list all orphaned files
|
||||
|
||||
rclone backend rescue drive:
|
||||
|
||||
Second rescue all orphaned files to the directory indicated
|
||||
|
||||
rclone backend rescue drive: "relative/path/to/rescue/directory"
|
||||
|
||||
e.g. To rescue all orphans to a directory called "Orphans" in the top level
|
||||
|
||||
rclone backend rescue drive: Orphans
|
||||
|
||||
Third delete all orphaned files to the trash
|
||||
|
||||
rclone backend rescue drive: -o delete
|
||||
|
||||
|
||||
{{< rem autogenerated options stop >}}
|
||||
|
||||
## Limitations
|
||||
|
@ -263,6 +263,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --dropbox-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_DROPBOX_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --dropbox-chunk-size
|
||||
|
||||
Upload chunk size (< 150Mi).
|
||||
|
@ -27,6 +27,7 @@ Flags for anything which can copy a file.
|
||||
-I, --ignore-times Don't skip items that match size and time - transfer all unconditionally
|
||||
--immutable Do not modify files, fail if existing files have been modified
|
||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
|
||||
--max-backlog int Maximum number of objects in sync or check backlog (default 10000)
|
||||
--max-duration Duration Maximum duration rclone will transfer data for (default 0s)
|
||||
--max-transfer SizeSuffix Maximum size of data to transfer (default off)
|
||||
@ -115,7 +116,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.68.0")
|
||||
--user-agent string Set the user-agent to a specified string (default "rclone/v1.69.0")
|
||||
```
|
||||
|
||||
|
||||
@ -264,7 +265,7 @@ Flags to control the Remote Control API.
|
||||
|
||||
```
|
||||
--rc Enable the remote control server
|
||||
--rc-addr stringArray IPaddress:Port or :Port to bind server to (default ["localhost:5572"])
|
||||
--rc-addr stringArray IPaddress:Port or :Port to bind server to (default localhost:5572)
|
||||
--rc-allow-origin string Origin which cross-domain request (CORS) can be executed from
|
||||
--rc-baseurl string Prefix for URLs - leave blank for root
|
||||
--rc-cert string TLS PEM key (concatenation of certificate and CA certificate)
|
||||
@ -300,7 +301,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 (default [""])
|
||||
--metrics-addr stringArray IPaddress:Port or :Port to bind metrics 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)
|
||||
@ -340,6 +341,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--azureblob-description string Description of the remote
|
||||
--azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
||||
--azureblob-disable-checksum Don't store MD5 checksum with object metadata
|
||||
--azureblob-disable-instance-discovery Skip requesting Microsoft Entra instance metadata
|
||||
--azureblob-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
|
||||
--azureblob-endpoint string Endpoint for the service
|
||||
--azureblob-env-auth Read credentials from runtime (environment variables, CLI or MSI)
|
||||
@ -357,6 +359,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--azureblob-tenant string ID of the service principal's tenant. Also called its directory ID
|
||||
--azureblob-upload-concurrency int Concurrency for multipart uploads (default 16)
|
||||
--azureblob-upload-cutoff string Cutoff for switching to chunked upload (<= 256 MiB) (deprecated)
|
||||
--azureblob-use-az Use Azure CLI tool az for authentication
|
||||
--azureblob-use-emulator Uses local storage emulator if provided as 'true'
|
||||
--azureblob-use-msi Use a managed service identity to authenticate (only works in Azure)
|
||||
--azureblob-username string User name (usually an email address)
|
||||
@ -406,6 +409,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--box-auth-url string Auth server URL
|
||||
--box-box-config-file string Box App config.json location
|
||||
--box-box-sub-type string (default "user")
|
||||
--box-client-credentials Use client credentials OAuth flow
|
||||
--box-client-id string OAuth Client Id
|
||||
--box-client-secret string OAuth Client Secret
|
||||
--box-commit-retries int Max number of times to try committing a multipart file (default 100)
|
||||
@ -444,6 +448,14 @@ Backend-only flags (these can be set in the config file also).
|
||||
--chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks
|
||||
--chunker-hash-type string Choose how chunker handles hash sums (default "md5")
|
||||
--chunker-remote string Remote to chunk/unchunk
|
||||
--cloudinary-api-key string Cloudinary API Key
|
||||
--cloudinary-api-secret string Cloudinary API Secret
|
||||
--cloudinary-cloud-name string Cloudinary Environment Name
|
||||
--cloudinary-description string Description of the remote
|
||||
--cloudinary-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
|
||||
--cloudinary-eventually-consistent-delay Duration Wait N seconds for eventual consistency of the databases that support the backend operation (default 0s)
|
||||
--cloudinary-upload-prefix string Specify the API endpoint for environments out of the US
|
||||
--cloudinary-upload-preset string Upload Preset to select asset manipulation on upload
|
||||
--combine-description string Description of the remote
|
||||
--combine-upstreams SpaceSepList Upstreams for combining
|
||||
--compress-description string Description of the remote
|
||||
@ -470,6 +482,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--drive-auth-owner-only Only consider files owned by the authenticated user
|
||||
--drive-auth-url string Auth server URL
|
||||
--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-copy-shortcut-content Server side copy contents of shortcuts instead of the shortcut
|
||||
@ -520,6 +533,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--dropbox-batch-size int Max number of files in upload batch
|
||||
--dropbox-batch-timeout Duration Max time to allow an idle upload batch before uploading (default 0s)
|
||||
--dropbox-chunk-size SizeSuffix Upload chunk size (< 150Mi) (default 48Mi)
|
||||
--dropbox-client-credentials Use client credentials OAuth flow
|
||||
--dropbox-client-id string OAuth Client Id
|
||||
--dropbox-client-secret string OAuth Client Secret
|
||||
--dropbox-description string Description of the remote
|
||||
@ -566,6 +580,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--ftp-host string FTP host to connect to
|
||||
--ftp-idle-timeout Duration Max time before closing idle connections (default 1m0s)
|
||||
--ftp-no-check-certificate Do not verify the TLS certificate of the server
|
||||
--ftp-no-check-upload Don't check the upload is OK
|
||||
--ftp-pass string FTP password (obscured)
|
||||
--ftp-port int FTP port number (default 21)
|
||||
--ftp-shut-timeout Duration Maximum time to wait for data connection closing status (default 1m0s)
|
||||
@ -574,10 +589,12 @@ Backend-only flags (these can be set in the config file also).
|
||||
--ftp-tls-cache-size int Size of TLS session cache for all control and data connections (default 32)
|
||||
--ftp-user string FTP username (default "$USER")
|
||||
--ftp-writing-mdtm Use MDTM to set modification time (VsFtpd quirk)
|
||||
--gcs-access-token string Short-lived access token
|
||||
--gcs-anonymous Access public buckets and objects without credentials
|
||||
--gcs-auth-url string Auth server URL
|
||||
--gcs-bucket-acl string Access Control List for new buckets
|
||||
--gcs-bucket-policy-only Access checks should use bucket-level IAM policies
|
||||
--gcs-client-credentials Use client credentials OAuth flow
|
||||
--gcs-client-id string OAuth Client Id
|
||||
--gcs-client-secret string OAuth Client Secret
|
||||
--gcs-decompress If set this will decompress gzip encoded objects
|
||||
@ -606,11 +623,13 @@ Backend-only flags (these can be set in the config file also).
|
||||
--gphotos-batch-mode string Upload file batching sync|async|off (default "sync")
|
||||
--gphotos-batch-size int Max number of files in upload batch
|
||||
--gphotos-batch-timeout Duration Max time to allow an idle upload batch before uploading (default 0s)
|
||||
--gphotos-client-credentials Use client credentials OAuth flow
|
||||
--gphotos-client-id string OAuth Client Id
|
||||
--gphotos-client-secret string OAuth Client Secret
|
||||
--gphotos-description string Description of the remote
|
||||
--gphotos-encoding Encoding The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
|
||||
--gphotos-include-archived Also view and download archived media
|
||||
--gphotos-proxy string Use the gphotosdl proxy for downloading the full resolution images
|
||||
--gphotos-read-only Set to make the Google Photos backend read only
|
||||
--gphotos-read-size Set to read the size of media items
|
||||
--gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000)
|
||||
@ -629,6 +648,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--hdfs-username string Hadoop user name
|
||||
--hidrive-auth-url string Auth server URL
|
||||
--hidrive-chunk-size SizeSuffix Chunksize for chunked uploads (default 48Mi)
|
||||
--hidrive-client-credentials Use client credentials OAuth flow
|
||||
--hidrive-client-id string OAuth Client Id
|
||||
--hidrive-client-secret string OAuth Client Secret
|
||||
--hidrive-description string Description of the remote
|
||||
@ -648,6 +668,11 @@ Backend-only flags (these can be set in the config file also).
|
||||
--http-no-head Don't use HEAD requests
|
||||
--http-no-slash Set this if the site doesn't end directories with /
|
||||
--http-url string URL of HTTP host to connect to
|
||||
--iclouddrive-apple-id string Apple ID
|
||||
--iclouddrive-client-id string Client id (default "d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d")
|
||||
--iclouddrive-description string Description of the remote
|
||||
--iclouddrive-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||
--iclouddrive-password string Password (obscured)
|
||||
--imagekit-description string Description of the remote
|
||||
--imagekit-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket)
|
||||
--imagekit-endpoint string You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)
|
||||
@ -665,6 +690,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--internetarchive-secret-access-key string IAS3 Secret Key (password)
|
||||
--internetarchive-wait-archive Duration Timeout for waiting the server's processing tasks (specifically archive and book_op) to finish (default 0s)
|
||||
--jottacloud-auth-url string Auth server URL
|
||||
--jottacloud-client-credentials Use client credentials OAuth flow
|
||||
--jottacloud-client-id string OAuth Client Id
|
||||
--jottacloud-client-secret string OAuth Client Secret
|
||||
--jottacloud-description string Description of the remote
|
||||
@ -686,11 +712,11 @@ Backend-only flags (these can be set in the config file also).
|
||||
--koofr-user string Your user name
|
||||
--linkbox-description string Description of the remote
|
||||
--linkbox-token string Token from https://www.linkbox.to/admin/account
|
||||
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
|
||||
--local-case-insensitive Force the filesystem to report itself as case insensitive
|
||||
--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-links Translate symlinks to/from regular files with a '.rclonelink' extension for the local backend
|
||||
--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
|
||||
@ -702,6 +728,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--local-zero-size-links Assume the Stat size of links is zero (and read them instead) (deprecated)
|
||||
--mailru-auth-url string Auth server URL
|
||||
--mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true)
|
||||
--mailru-client-credentials Use client credentials OAuth flow
|
||||
--mailru-client-id string OAuth Client Id
|
||||
--mailru-client-secret string OAuth Client Secret
|
||||
--mailru-description string Description of the remote
|
||||
@ -732,6 +759,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--onedrive-auth-url string Auth server URL
|
||||
--onedrive-av-override Allows download of files the server thinks has a virus
|
||||
--onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes) (default 10Mi)
|
||||
--onedrive-client-credentials Use client credentials OAuth flow
|
||||
--onedrive-client-id string OAuth Client Id
|
||||
--onedrive-client-secret string OAuth Client Secret
|
||||
--onedrive-delta If set rclone will use delta listing to implement recursive listings
|
||||
@ -751,11 +779,12 @@ Backend-only flags (these can be set in the config file also).
|
||||
--onedrive-region string Choose national cloud region for OneDrive (default "global")
|
||||
--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-token string OAuth Access Token as a JSON blob
|
||||
--onedrive-token-url string Token server url
|
||||
--oos-attempt-resume-upload If true attempt to resume previously started multipart upload for the object
|
||||
--oos-chunk-size SizeSuffix Chunk size to use for uploading (default 5Mi)
|
||||
--oos-compartment string Object storage compartment OCID
|
||||
--oos-compartment string Specify compartment OCID, if you need to list buckets
|
||||
--oos-config-file string Path to OCI config file (default "~/.oci/config")
|
||||
--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)
|
||||
@ -784,6 +813,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--opendrive-password string Password (obscured)
|
||||
--opendrive-username string Username
|
||||
--pcloud-auth-url string Auth server URL
|
||||
--pcloud-client-credentials Use client credentials OAuth flow
|
||||
--pcloud-client-id string OAuth Client Id
|
||||
--pcloud-client-secret string OAuth Client Secret
|
||||
--pcloud-description string Description of the remote
|
||||
@ -794,26 +824,25 @@ Backend-only flags (these can be set in the config file also).
|
||||
--pcloud-token string OAuth Access Token as a JSON blob
|
||||
--pcloud-token-url string Token server url
|
||||
--pcloud-username string Your pcloud username
|
||||
--pikpak-auth-url string Auth server URL
|
||||
--pikpak-chunk-size SizeSuffix Chunk size for multipart uploads (default 5Mi)
|
||||
--pikpak-client-id string OAuth Client Id
|
||||
--pikpak-client-secret string OAuth Client Secret
|
||||
--pikpak-description string Description of the remote
|
||||
--pikpak-device-id string Device ID used for authorization
|
||||
--pikpak-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot)
|
||||
--pikpak-hash-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate hash if required (default 10Mi)
|
||||
--pikpak-no-media-link Use original file links instead of media links
|
||||
--pikpak-pass string Pikpak password (obscured)
|
||||
--pikpak-root-folder-id string ID of the root folder
|
||||
--pikpak-token string OAuth Access Token as a JSON blob
|
||||
--pikpak-token-url string Token server url
|
||||
--pikpak-trashed-only Only show files that are in the trash
|
||||
--pikpak-upload-concurrency int Concurrency for multipart uploads (default 5)
|
||||
--pikpak-use-trash Send files to the trash instead of deleting permanently (default true)
|
||||
--pikpak-user string Pikpak username
|
||||
--pikpak-user-agent string HTTP user agent for pikpak (default "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0")
|
||||
--pixeldrain-api-key string API key for your pixeldrain account
|
||||
--pixeldrain-api-url string The API endpoint to connect to. In the vast majority of cases it's fine to leave (default "https://pixeldrain.com/api")
|
||||
--pixeldrain-description string Description of the remote
|
||||
--pixeldrain-root-folder-id string Root of the filesystem to use (default "me")
|
||||
--premiumizeme-auth-url string Auth server URL
|
||||
--premiumizeme-client-credentials Use client credentials OAuth flow
|
||||
--premiumizeme-client-id string OAuth Client Id
|
||||
--premiumizeme-client-secret string OAuth Client Secret
|
||||
--premiumizeme-description string Description of the remote
|
||||
@ -831,6 +860,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--protondrive-replace-existing-draft Create a new revision when filename conflict is detected
|
||||
--protondrive-username string The username of your proton account
|
||||
--putio-auth-url string Auth server URL
|
||||
--putio-client-credentials Use client credentials OAuth flow
|
||||
--putio-client-id string OAuth Client Id
|
||||
--putio-client-secret string OAuth Client Secret
|
||||
--putio-description string Description of the remote
|
||||
@ -864,6 +894,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi)
|
||||
--s3-decompress If set this will decompress gzip encoded objects
|
||||
--s3-description string Description of the remote
|
||||
--s3-directory-bucket Set to use AWS Directory Buckets
|
||||
--s3-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
||||
--s3-disable-checksum Don't store MD5 checksum with object metadata
|
||||
--s3-disable-http2 Disable usage of http2 for S3 backends
|
||||
@ -945,6 +976,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--sftp-pass string SSH password, leave blank to use ssh-agent (obscured)
|
||||
--sftp-path-override string Override path used by SSH shell commands
|
||||
--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
|
||||
--sftp-server-command string Specifies the path or command to run a sftp server on the remote host
|
||||
--sftp-set-env SpaceSepList Environment variables to pass to sftp and commands
|
||||
@ -960,6 +992,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--sftp-user string SSH username (default "$USER")
|
||||
--sharefile-auth-url string Auth server URL
|
||||
--sharefile-chunk-size SizeSuffix Upload chunk size (default 64Mi)
|
||||
--sharefile-client-credentials Use client credentials OAuth flow
|
||||
--sharefile-client-id string OAuth Client Id
|
||||
--sharefile-client-secret string OAuth Client Secret
|
||||
--sharefile-description string Description of the remote
|
||||
@ -1049,6 +1082,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--uptobox-description string Description of the remote
|
||||
--uptobox-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot)
|
||||
--uptobox-private Set to make uploaded files private
|
||||
--webdav-auth-redirect Preserve authentication on redirect
|
||||
--webdav-bearer-token string Bearer token instead of user/pass (e.g. a Macaroon)
|
||||
--webdav-bearer-token-command string Command to run to get a bearer token
|
||||
--webdav-description string Description of the remote
|
||||
@ -1064,6 +1098,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--webdav-user string User name
|
||||
--webdav-vendor string Name of the WebDAV site/service/software you are using
|
||||
--yandex-auth-url string Auth server URL
|
||||
--yandex-client-credentials Use client credentials OAuth flow
|
||||
--yandex-client-id string OAuth Client Id
|
||||
--yandex-client-secret string OAuth Client Secret
|
||||
--yandex-description string Description of the remote
|
||||
@ -1073,6 +1108,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--yandex-token string OAuth Access Token as a JSON blob
|
||||
--yandex-token-url string Token server url
|
||||
--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
|
||||
@ -1080,6 +1116,7 @@ Backend-only flags (these can be set in the config file also).
|
||||
--zoho-region string Zoho region to connect to
|
||||
--zoho-token string OAuth Access Token as a JSON blob
|
||||
--zoho-token-url string Token server url
|
||||
--zoho-upload-cutoff SizeSuffix Cutoff for switching to large file upload api (>= 10 MiB) (default 10Mi)
|
||||
```
|
||||
|
||||
|
||||
|
@ -419,12 +419,12 @@ Properties:
|
||||
|
||||
Socks 5 proxy host.
|
||||
|
||||
Supports the format user:pass@host:port, user@host:port, host:port.
|
||||
Supports the format user:pass@host:port, user@host:port, host:port.
|
||||
|
||||
Example:
|
||||
|
||||
myUser:myPass@localhost:9005
|
||||
Example:
|
||||
|
||||
myUser:myPass@localhost:9005
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
@ -433,6 +433,28 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --ftp-no-check-upload
|
||||
|
||||
Don't check the upload is OK
|
||||
|
||||
Normally rclone will try to check the upload exists after it has
|
||||
uploaded a file to make sure the size and modification time are as
|
||||
expected.
|
||||
|
||||
This flag stops rclone doing these checks. This enables uploading to
|
||||
folders which are write only.
|
||||
|
||||
You will likely need to use the --inplace flag also if uploading to
|
||||
a write only folder.
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: no_check_upload
|
||||
- Env Var: RCLONE_FTP_NO_CHECK_UPLOAD
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --ftp-encoding
|
||||
|
||||
The encoding for the backend.
|
||||
|
@ -412,20 +412,6 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --gcs-access-token
|
||||
|
||||
Short-lived access token.
|
||||
|
||||
Leave blank normally.
|
||||
Needed only if you want use short-lived access tokens instead of interactive login.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: access_token
|
||||
- Env Var: RCLONE_GCS_ACCESS_TOKEN
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --gcs-anonymous
|
||||
|
||||
Access public buckets and objects without credentials.
|
||||
@ -687,6 +673,33 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --gcs-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_GCS_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --gcs-access-token
|
||||
|
||||
Short-lived access token.
|
||||
|
||||
Leave blank normally.
|
||||
Needed only if you want use short-lived access token instead of interactive login.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: access_token
|
||||
- Env Var: RCLONE_GCS_ACCESS_TOKEN
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --gcs-directory-markers
|
||||
|
||||
Upload an empty object with a trailing slash when a new directory is created
|
||||
|
@ -313,6 +313,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --gphotos-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_GPHOTOS_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --gphotos-read-size
|
||||
|
||||
Set to read the size of media items.
|
||||
@ -364,6 +377,40 @@ Properties:
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --gphotos-proxy
|
||||
|
||||
Use the gphotosdl proxy for downloading the full resolution images
|
||||
|
||||
The Google API will deliver images and video which aren't full
|
||||
resolution, and/or have EXIF data missing.
|
||||
|
||||
However if you ue the gphotosdl proxy tnen you can download original,
|
||||
unchanged images.
|
||||
|
||||
This runs a headless browser in the background.
|
||||
|
||||
Download the software from [gphotosdl](https://github.com/rclone/gphotosdl)
|
||||
|
||||
First run with
|
||||
|
||||
gphotosdl -login
|
||||
|
||||
Then once you have logged into google photos close the browser window
|
||||
and run
|
||||
|
||||
gphotosdl
|
||||
|
||||
Then supply the parameter `--gphotos-proxy "http://localhost:8282"` to make
|
||||
rclone use the proxy.
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: proxy
|
||||
- Env Var: RCLONE_GPHOTOS_PROXY
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --gphotos-encoding
|
||||
|
||||
The encoding for the backend.
|
||||
|
@ -282,6 +282,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --hidrive-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_HIDRIVE_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --hidrive-scope-role
|
||||
|
||||
User-level that rclone should use when requesting access from HiDrive.
|
||||
|
@ -109,7 +109,7 @@ Properties:
|
||||
|
||||
#### --iclouddrive-trust-token
|
||||
|
||||
trust token (internal use)
|
||||
Trust token (internal use)
|
||||
|
||||
Properties:
|
||||
|
||||
@ -133,6 +133,17 @@ Properties:
|
||||
|
||||
Here are the Advanced options specific to iclouddrive (iCloud Drive).
|
||||
|
||||
#### --iclouddrive-client-id
|
||||
|
||||
Client id
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_id
|
||||
- Env Var: RCLONE_ICLOUDDRIVE_CLIENT_ID
|
||||
- Type: string
|
||||
- Default: "d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d"
|
||||
|
||||
#### --iclouddrive-encoding
|
||||
|
||||
The encoding for the backend.
|
||||
|
@ -377,6 +377,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --jottacloud-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_JOTTACLOUD_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --jottacloud-md5-memory-limit
|
||||
|
||||
Files bigger than this will be cached on disk to calculate the MD5 if required.
|
||||
|
@ -293,6 +293,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --mailru-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_MAILRU_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --mailru-speedup-file-patterns
|
||||
|
||||
Comma separated list of file name patterns eligible for speedup (put by hash).
|
||||
|
@ -323,6 +323,21 @@ Properties:
|
||||
- "cn"
|
||||
- Azure and Office 365 operated by Vnet Group in China
|
||||
|
||||
#### --onedrive-tenant
|
||||
|
||||
ID of the service principal's tenant. Also called its directory ID.
|
||||
|
||||
Set this if using
|
||||
- Client Credential flow
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: tenant
|
||||
- Env Var: RCLONE_ONEDRIVE_TENANT
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
### Advanced options
|
||||
|
||||
Here are the Advanced options specific to onedrive (Microsoft OneDrive).
|
||||
@ -364,6 +379,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --onedrive-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_ONEDRIVE_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --onedrive-chunk-size
|
||||
|
||||
Chunk size to upload files with - must be multiple of 320k (327,680 bytes).
|
||||
|
@ -340,7 +340,9 @@ Properties:
|
||||
|
||||
#### --oos-compartment
|
||||
|
||||
Object storage compartment OCID
|
||||
Specify compartment OCID, if you need to list buckets.
|
||||
|
||||
List objects works without compartment OCID.
|
||||
|
||||
Properties:
|
||||
|
||||
@ -348,7 +350,7 @@ Properties:
|
||||
- Env Var: RCLONE_OOS_COMPARTMENT
|
||||
- Provider: !no_auth
|
||||
- Type: string
|
||||
- Required: true
|
||||
- Required: false
|
||||
|
||||
#### --oos-region
|
||||
|
||||
|
@ -224,6 +224,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --pcloud-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_PCLOUD_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --pcloud-encoding
|
||||
|
||||
The encoding for the backend.
|
||||
|
@ -111,68 +111,29 @@ Properties:
|
||||
|
||||
Here are the Advanced options specific to pikpak (PikPak).
|
||||
|
||||
#### --pikpak-client-id
|
||||
#### --pikpak-device-id
|
||||
|
||||
OAuth Client Id.
|
||||
|
||||
Leave blank normally.
|
||||
Device ID used for authorization.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_id
|
||||
- Env Var: RCLONE_PIKPAK_CLIENT_ID
|
||||
- Config: device_id
|
||||
- Env Var: RCLONE_PIKPAK_DEVICE_ID
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --pikpak-client-secret
|
||||
#### --pikpak-user-agent
|
||||
|
||||
OAuth Client Secret.
|
||||
HTTP user agent for pikpak.
|
||||
|
||||
Leave blank normally.
|
||||
Defaults to "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0" or "--pikpak-user-agent" provided on command line.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_secret
|
||||
- Env Var: RCLONE_PIKPAK_CLIENT_SECRET
|
||||
- Config: user_agent
|
||||
- Env Var: RCLONE_PIKPAK_USER_AGENT
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --pikpak-token
|
||||
|
||||
OAuth Access Token as a JSON blob.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: token
|
||||
- Env Var: RCLONE_PIKPAK_TOKEN
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --pikpak-auth-url
|
||||
|
||||
Auth server URL.
|
||||
|
||||
Leave blank to use the provider defaults.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: auth_url
|
||||
- Env Var: RCLONE_PIKPAK_AUTH_URL
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --pikpak-token-url
|
||||
|
||||
Token server url.
|
||||
|
||||
Leave blank to use the provider defaults.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: token_url
|
||||
- Env Var: RCLONE_PIKPAK_TOKEN_URL
|
||||
- Type: string
|
||||
- Required: false
|
||||
- Default: "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0"
|
||||
|
||||
#### --pikpak-root-folder-id
|
||||
|
||||
@ -216,6 +177,19 @@ Properties:
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --pikpak-no-media-link
|
||||
|
||||
Use original file links instead of media links.
|
||||
|
||||
This avoids issues caused by invalid media links, but may reduce download speeds.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: no_media_link
|
||||
- Env Var: RCLONE_PIKPAK_NO_MEDIA_LINK
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --pikpak-hash-memory-limit
|
||||
|
||||
Files bigger than this will be cached on disk to calculate hash if required.
|
||||
|
@ -189,6 +189,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --premiumizeme-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_PREMIUMIZEME_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --premiumizeme-encoding
|
||||
|
||||
The encoding for the backend.
|
||||
|
@ -186,6 +186,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --putio-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_PUTIO_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --putio-encoding
|
||||
|
||||
The encoding for the backend.
|
||||
|
@ -2104,6 +2104,7 @@ This takes the following parameters
|
||||
- `fs` - select the VFS in use (optional)
|
||||
- `id` - a numeric ID as returned from `vfs/queue`
|
||||
- `expiry` - a new expiry time as floating point seconds
|
||||
- `relative` - if set, expiry is to be treated as relative to the current expiry (optional, boolean)
|
||||
|
||||
This returns an empty result on success, or an error.
|
||||
|
||||
|
@ -789,7 +789,7 @@ A simple solution is to set the `--s3-upload-cutoff 0` and force all the files t
|
||||
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/s3/s3.go then run make backenddocs" >}}
|
||||
### Standard options
|
||||
|
||||
Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others).
|
||||
Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others).
|
||||
|
||||
#### --s3-provider
|
||||
|
||||
@ -842,6 +842,8 @@ Properties:
|
||||
- Minio Object Storage
|
||||
- "Netease"
|
||||
- Netease Object Storage (NOS)
|
||||
- "Outscale"
|
||||
- OUTSCALE Object Storage (OOS)
|
||||
- "Petabox"
|
||||
- Petabox Object Storage
|
||||
- "RackCorp"
|
||||
@ -852,6 +854,8 @@ Properties:
|
||||
- Scaleway Object Storage
|
||||
- "SeaweedFS"
|
||||
- SeaweedFS S3
|
||||
- "Selectel"
|
||||
- Selectel Object Storage
|
||||
- "StackPath"
|
||||
- StackPath Object Storage
|
||||
- "Storj"
|
||||
@ -1103,7 +1107,7 @@ Properties:
|
||||
|
||||
- Config: acl
|
||||
- Env Var: RCLONE_S3_ACL
|
||||
- Provider: !Storj,Synology,Cloudflare
|
||||
- Provider: !Storj,Selectel,Synology,Cloudflare
|
||||
- Type: string
|
||||
- Required: false
|
||||
- Examples:
|
||||
@ -1207,7 +1211,7 @@ Properties:
|
||||
- "ONEZONE_IA"
|
||||
- One Zone Infrequent Access storage class
|
||||
- "GLACIER"
|
||||
- Glacier storage class
|
||||
- Glacier Flexible Retrieval storage class
|
||||
- "DEEP_ARCHIVE"
|
||||
- Glacier Deep Archive storage class
|
||||
- "INTELLIGENT_TIERING"
|
||||
@ -1217,7 +1221,7 @@ Properties:
|
||||
|
||||
### Advanced options
|
||||
|
||||
Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others).
|
||||
Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others).
|
||||
|
||||
#### --s3-bucket-acl
|
||||
|
||||
@ -2051,6 +2055,41 @@ Properties:
|
||||
- Type: Tristate
|
||||
- Default: unset
|
||||
|
||||
#### --s3-directory-bucket
|
||||
|
||||
Set to use AWS Directory Buckets
|
||||
|
||||
If you are using an AWS Directory Bucket then set this flag.
|
||||
|
||||
This will ensure no `Content-Md5` headers are sent and ensure `ETag`
|
||||
headers are not interpreted as MD5 sums. `X-Amz-Meta-Md5chksum` will
|
||||
be set on all objects whether single or multipart uploaded.
|
||||
|
||||
This also sets `no_check_bucket = true`.
|
||||
|
||||
Note that Directory Buckets do not support:
|
||||
|
||||
- Versioning
|
||||
- `Content-Encoding: gzip`
|
||||
|
||||
Rclone limitations with Directory Buckets:
|
||||
|
||||
- rclone does not support creating Directory Buckets with `rclone mkdir`
|
||||
- ... or removing them with `rclone rmdir` yet
|
||||
- Directory Buckets do not appear when doing `rclone lsf` at the top level.
|
||||
- Rclone can't remove auto created directories yet. In theory this should
|
||||
work with `directory_markers = true` but it doesn't.
|
||||
- Directories don't seem to appear in recursive (ListR) listings.
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: directory_bucket
|
||||
- Env Var: RCLONE_S3_DIRECTORY_BUCKET
|
||||
- Provider: AWS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --s3-sdk-log-mode
|
||||
|
||||
Set to debug the SDK
|
||||
|
@ -246,6 +246,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --sharefile-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_SHAREFILE_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --sharefile-upload-cutoff
|
||||
|
||||
Cutoff for switching to multipart upload.
|
||||
|
@ -305,6 +305,29 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --webdav-auth-redirect
|
||||
|
||||
Preserve authentication on redirect.
|
||||
|
||||
If the server redirects rclone to a new domain when it is trying to
|
||||
read a file then normally rclone will drop the Authorization: header
|
||||
from the request.
|
||||
|
||||
This is standard security practice to avoid sending your credentials
|
||||
to an unknown webserver.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: auth_redirect
|
||||
- Env Var: RCLONE_WEBDAV_AUTH_REDIRECT
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --webdav-description
|
||||
|
||||
Description of the remote.
|
||||
|
@ -186,6 +186,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --yandex-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_YANDEX_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --yandex-hard-delete
|
||||
|
||||
Delete files permanently rather than putting them into the trash.
|
||||
|
@ -224,6 +224,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --zoho-client-credentials
|
||||
|
||||
Use client credentials OAuth flow.
|
||||
|
||||
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: client_credentials
|
||||
- Env Var: RCLONE_ZOHO_CLIENT_CREDENTIALS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --zoho-upload-cutoff
|
||||
|
||||
Cutoff for switching to large file upload api (>= 10 MiB).
|
||||
|
Loading…
x
Reference in New Issue
Block a user