mirror of
https://github.com/rclone/rclone.git
synced 2024-11-28 19:34:55 +01:00
Version v1.63.0
This commit is contained in:
Nick Craig-Wood
parent
42c211c6b2
commit
e90537b2e9
1728
MANUAL.html
generated
1728
MANUAL.html
generated
File diff suppressed because it is too large
Load Diff
1883
MANUAL.txt
generated
1883
MANUAL.txt
generated
File diff suppressed because it is too large
Load Diff
@ -792,6 +792,24 @@ Properties:
|
||||
- "container"
|
||||
- Allow full public read access for container and blob data.
|
||||
|
||||
#### --azureblob-directory-markers
|
||||
|
||||
Upload an empty object with a trailing slash when a new directory is created
|
||||
|
||||
Empty folders are unsupported for bucket based remotes, this option
|
||||
creates an empty object ending with "/", to persist the folder.
|
||||
|
||||
This object also has the metadata "hdi_isfolder = true" to conform to
|
||||
the Microsoft standard.
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: directory_markers
|
||||
- Env Var: RCLONE_AZUREBLOB_DIRECTORY_MARKERS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --azureblob-no-check-container
|
||||
|
||||
If set, don't attempt to check the container exists or create it.
|
||||
|
||||
@ -5,6 +5,177 @@ description: "Rclone Changelog"
|
||||
|
||||
# Changelog
|
||||
|
||||
## v1.63.0 - 2023-06-30
|
||||
|
||||
[See commits](https://github.com/rclone/rclone/compare/v1.62.0...v1.63.0)
|
||||
|
||||
* New backends
|
||||
* [Pikpak](/pikpak/) (wiserain)
|
||||
* New S3 providers
|
||||
* [petabox.io](/s3/#petabox) (Andrei Smirnov)
|
||||
* [Google Cloud Storage](/s3/#google-cloud-storage) (Anthony Pessy)
|
||||
* New WebDAV providers
|
||||
* [Fastmail](/webdav/#fastmail-files) (Arnavion)
|
||||
* Major changes
|
||||
* Files will be copied to a temporary name ending in `.partial` when copying to `local`,`ftp`,`sftp` then renamed at the end of the transfer. (Janne Hellsten, Nick Craig-Wood)
|
||||
* This helps with data integrity as we don't delete the existing file until the new one is complete.
|
||||
* It can be disabled with the [--inplace](/docs/#inplace) flag.
|
||||
* This behaviour will also happen if the backend is wrapped, for example `sftp` wrapped with `crypt`.
|
||||
* The [s3](/s3/#s3-directory-markers), [azureblob](/azureblob/#azureblob-directory-markers) and [gcs](/googlecloudstorage/#gcs-directory-markers) backends now support directory markers so empty directories are supported (Jānis Bebrītis, Nick Craig-Wood)
|
||||
* The [--default-time](/docs/#default-time-time) flag now controls the unknown modification time of files/dirs (Nick Craig-Wood)
|
||||
* If a file or directory does not have a modification time rclone can read then rclone will display this fixed time instead.
|
||||
* For the old behaviour use `--default-time 0s` which will set this time to the time rclone started up.
|
||||
* New Features
|
||||
* build
|
||||
* Modernise linters in use and fixup all affected code (albertony)
|
||||
* Push docker beta to GHCR (GitHub container registry) (Richard Tweed)
|
||||
* cat: Add `--separator` option to cat command (Loren Gordon)
|
||||
* config
|
||||
* Do not remove/overwrite other files during config file save (albertony)
|
||||
* Do not overwrite config file symbolic link (albertony)
|
||||
* Stop `config create` making invalid config files (Nick Craig-Wood)
|
||||
* doc updates (Adam K, Aditya Basu, albertony, asdffdsazqqq, Damo, danielkrajnik, Dimitri Papadopoulos, dlitster, Drew Parsons, jumbi77, kapitainsky, mac-15, Mariusz Suchodolski, Nick Craig-Wood, NickIAm, Rintze Zelle, Stanislav Gromov, Tareq Sharafy, URenko, yuudi, Zach Kipp)
|
||||
* fs
|
||||
* Add `size` to JSON logs when moving or copying an object (Nick Craig-Wood)
|
||||
* Allow boolean features to be enabled with `--disable !Feature` (Nick Craig-Wood)
|
||||
* genautocomplete: Rename to `completion` with alias to the old name (Nick Craig-Wood)
|
||||
* librclone: Added example on using `librclone` with Go (alankrit)
|
||||
* lsjson: Make `--stat` more efficient (Nick Craig-Wood)
|
||||
* operations
|
||||
* Implement `--multi-thread-write-buffer-size` for speed improvements on downloads (Paulo Schreiner)
|
||||
* Reopen downloads on error when using `check --download` and `cat` (Nick Craig-Wood)
|
||||
* rc: `config/listremotes` includes remotes defined with environment variables (kapitainsky)
|
||||
* selfupdate: Obey `--no-check-certificate` flag (Nick Craig-Wood)
|
||||
* serve restic: Trigger systemd notify (Shyim)
|
||||
* serve webdav: Implement owncloud checksum and modtime extensions (WeidiDeng)
|
||||
* sync: `--suffix-keep-extension` preserve 2 part extensions like .tar.gz (Nick Craig-Wood)
|
||||
* Bug Fixes
|
||||
* accounting
|
||||
* Fix Prometheus metrics to be the same as `core/stats` (Nick Craig-Wood)
|
||||
* Bwlimit signal handler should always start (Sam Lai)
|
||||
* bisync: Fix `maxDelete` parameter being ignored via the rc (Nick Craig-Wood)
|
||||
* cmd/ncdu: Fix screen corruption when logging (eNV25)
|
||||
* filter: Fix deadlock with errors on `--files-from` (douchen)
|
||||
* fs
|
||||
* Fix interaction between `--progress` and `--interactive` (Nick Craig-Wood)
|
||||
* Fix infinite recursive call in pacer ModifyCalculator (fixes issue reported by the staticcheck linter) (albertony)
|
||||
* lib/atexit: Ensure OnError only calls cancel function once (Nick Craig-Wood)
|
||||
* lib/rest: Fix problems re-using HTTP connections (Nick Craig-Wood)
|
||||
* rc
|
||||
* Fix `operations/stat` with trailing `/` (Nick Craig-Wood)
|
||||
* Fix missing `--rc` flags (Nick Craig-Wood)
|
||||
* Fix output of Time values in `options/get` (Nick Craig-Wood)
|
||||
* serve dlna: Fix potential data race (Nick Craig-Wood)
|
||||
* version: Fix reported os/kernel version for windows (albertony)
|
||||
* Mount
|
||||
* Add `--mount-case-insensitive` to force the mount to be case insensitive (Nick Craig-Wood)
|
||||
* Removed unnecessary byte slice allocation for reads (Anagh Kumar Baranwal)
|
||||
* Clarify rclone mount error when installed via homebrew (Nick Craig-Wood)
|
||||
* Added _netdev to the example mount so it gets treated as a remote-fs rather than local-fs (Anagh Kumar Baranwal)
|
||||
* Mount2
|
||||
* Updated go-fuse version (Anagh Kumar Baranwal)
|
||||
* Fixed statfs (Anagh Kumar Baranwal)
|
||||
* Disable xattrs (Anagh Kumar Baranwal)
|
||||
* VFS
|
||||
* Add MkdirAll function to make a directory and all beneath (Nick Craig-Wood)
|
||||
* Fix reload: failed to add virtual dir entry: file does not exist (Nick Craig-Wood)
|
||||
* Fix writing to a read only directory creating spurious directory entries (WeidiDeng)
|
||||
* Fix potential data race (Nick Craig-Wood)
|
||||
* Fix backends being Shutdown too early when startup takes a long time (Nick Craig-Wood)
|
||||
* Local
|
||||
* Fix filtering of symlinks with `-l`/`--links` flag (Nick Craig-Wood)
|
||||
* Fix /path/to/file.rclonelink when `-l`/`--links` is in use (Nick Craig-Wood)
|
||||
* Fix crash with `--metadata` on Android (Nick Craig-Wood)
|
||||
* Cache
|
||||
* Fix backends shutting down when in use when used via the rc (Nick Craig-Wood)
|
||||
* Crypt
|
||||
* Add `--crypt-suffix` option to set a custom suffix for encrypted files (jladbrook)
|
||||
* Add `--crypt-pass-bad-blocks` to allow corrupted file output (Nick Craig-Wood)
|
||||
* Fix reading 0 length files (Nick Craig-Wood)
|
||||
* Try not to return "unexpected EOF" error (Nick Craig-Wood)
|
||||
* Reduce allocations (albertony)
|
||||
* Recommend Dropbox for `base32768` encoding (Nick Craig-Wood)
|
||||
* Azure Blob
|
||||
* Empty directory markers (Nick Craig-Wood)
|
||||
* Support azure workload identities (Tareq Sharafy)
|
||||
* Fix azure blob uploads with multiple bits of metadata (Nick Craig-Wood)
|
||||
* Fix azurite compatibility by sending nil tier if set to empty string (Roel Arents)
|
||||
* Combine
|
||||
* Implement missing methods (Nick Craig-Wood)
|
||||
* Fix goroutine stack overflow on bad object (Nick Craig-Wood)
|
||||
* Drive
|
||||
* Add `--drive-env-auth` to get IAM credentials from runtime (Peter Brunner)
|
||||
* Update drive service account guide (Juang, Yi-Lin)
|
||||
* Fix change notify picking up files outside the root (Nick Craig-Wood)
|
||||
* Fix trailing slash mis-identificaton of folder as file (Nick Craig-Wood)
|
||||
* Fix incorrect remote after Update on object (Nick Craig-Wood)
|
||||
* Dropbox
|
||||
* Implement `--dropbox-pacer-min-sleep` flag (Nick Craig-Wood)
|
||||
* Fix the dropbox batcher stalling (Misty)
|
||||
* Fichier
|
||||
* Add `--ficicher-cdn` option to use the CDN for download (Nick Craig-Wood)
|
||||
* FTP
|
||||
* Lower log message priority when `SetModTime` is not supported to debug (Tobias Gion)
|
||||
* Fix "unsupported LIST line" errors on startup (Nick Craig-Wood)
|
||||
* Fix "501 Not a valid pathname." errors when creating directories (Nick Craig-Wood)
|
||||
* Google Cloud Storage
|
||||
* Empty directory markers (Jānis Bebrītis, Nick Craig-Wood)
|
||||
* Added `--gcs-user-project` needed for requester pays (Christopher Merry)
|
||||
* HTTP
|
||||
* Add client certificate user auth middleware. This can auth `serve restic` from the username in the client cert. (Peter Fern)
|
||||
* Jottacloud
|
||||
* Fix vfs writeback stuck in a failed upload loop with file versioning disabled (albertony)
|
||||
* Onedrive
|
||||
* Add `--onedrive-av-override` flag to download files flagged as virus (Nick Craig-Wood)
|
||||
* Fix quickxorhash on 32 bit architectures (Nick Craig-Wood)
|
||||
* Report any list errors during `rclone cleanup` (albertony)
|
||||
* Putio
|
||||
* Fix uploading to the wrong object on Update with overriden remote name (Nick Craig-Wood)
|
||||
* Fix modification times not being preserved for server side copy and move (Nick Craig-Wood)
|
||||
* Fix server side copy failures (400 errors) (Nick Craig-Wood)
|
||||
* S3
|
||||
* Empty directory markers (Jānis Bebrītis, Nick Craig-Wood)
|
||||
* Update Scaleway storage classes (Brian Starkey)
|
||||
* Fix `--s3-versions` on individual objects (Nick Craig-Wood)
|
||||
* Fix hang on aborting multpart upload with iDrive e2 (Nick Craig-Wood)
|
||||
* Fix missing "tier" metadata (Nick Craig-Wood)
|
||||
* Fix V3sign: add missing subresource delete (cc)
|
||||
* Fix Arvancloud Domain and region changes and alphabetise the provider (Ehsan Tadayon)
|
||||
* Fix Qiniu KODO quirks virtualHostStyle is false (zzq)
|
||||
* SFTP
|
||||
* Add `--sftp-host-key-algorithms ` to allow specifying SSH host key algorithms (Joel)
|
||||
* Fix using `--sftp-key-use-agent` and `--sftp-key-file` together needing private key file (Arnav Singh)
|
||||
* Fix move to allow overwriting existing files (Nick Craig-Wood)
|
||||
* Don't stat directories before listing them (Nick Craig-Wood)
|
||||
* Don't check remote points to a file if it ends with / (Nick Craig-Wood)
|
||||
* Sharefile
|
||||
* Disable streamed transfers as they no longer work (Nick Craig-Wood)
|
||||
* Smb
|
||||
* Code cleanup to avoid overwriting ctx before first use (fixes issue reported by the staticcheck linter) (albertony)
|
||||
* Storj
|
||||
* Fix "uplink: too many requests" errors when uploading to the same file (Nick Craig-Wood)
|
||||
* Fix uploading to the wrong object on Update with overriden remote name (Nick Craig-Wood)
|
||||
* Swift
|
||||
* Ignore 404 error when deleting an object (Nick Craig-Wood)
|
||||
* Union
|
||||
* Implement missing methods (Nick Craig-Wood)
|
||||
* Allow errors to be unwrapped for inspection (Nick Craig-Wood)
|
||||
* Uptobox
|
||||
* Add `--uptobox-private` flag to make all uploaded files private (Nick Craig-Wood)
|
||||
* Fix improper regex (Aaron Gokaslan)
|
||||
* Fix Update returning the wrong object (Nick Craig-Wood)
|
||||
* Fix rmdir declaring that directories weren't empty (Nick Craig-Wood)
|
||||
* WebDAV
|
||||
* nextcloud: Add support for chunked uploads (Paul)
|
||||
* Set modtime using propset for owncloud and nextcloud (WeidiDeng)
|
||||
* Make pacer minSleep configurable with `--webdav-pacer-min-sleep` (ed)
|
||||
* Fix server side copy/move not overwriting (WeidiDeng)
|
||||
* Fix modtime on server side copy for owncloud and nextcloud (Nick Craig-Wood)
|
||||
* Yandex
|
||||
* Fix 400 Bad Request on transfer failure (Nick Craig-Wood)
|
||||
* Zoho
|
||||
* Fix downloads with `Range:` header returning the wrong data (Nick Craig-Wood)
|
||||
|
||||
## v1.62.2 - 2023-03-16
|
||||
|
||||
[See commits](https://github.com/rclone/rclone/compare/v1.62.1...v1.62.2)
|
||||
|
||||
@ -42,7 +42,7 @@ See the [global flags page](/flags/) for global options not listed here.
|
||||
* [rclone check](/commands/rclone_check/) - Checks the files in the source and destination match.
|
||||
* [rclone checksum](/commands/rclone_checksum/) - Checks the files in the source against a SUM file.
|
||||
* [rclone cleanup](/commands/rclone_cleanup/) - Clean up the remote if possible.
|
||||
* [rclone completion](/commands/rclone_completion/) - Generate the autocompletion script for the specified shell
|
||||
* [rclone completion](/commands/rclone_completion/) - Output completion script for a given shell.
|
||||
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.
|
||||
* [rclone copy](/commands/rclone_copy/) - Copy files from source to dest, skipping identical files.
|
||||
* [rclone copyto](/commands/rclone_copyto/) - Copy files from source to dest, skipping identical files.
|
||||
@ -52,11 +52,10 @@ See the [global flags page](/flags/) for global options not listed here.
|
||||
* [rclone dedupe](/commands/rclone_dedupe/) - Interactively find duplicate filenames and delete/rename them.
|
||||
* [rclone delete](/commands/rclone_delete/) - Remove the files in path.
|
||||
* [rclone deletefile](/commands/rclone_deletefile/) - Remove a single file from remote.
|
||||
* [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell.
|
||||
* [rclone gendocs](/commands/rclone_gendocs/) - Output markdown docs for rclone to the directory supplied.
|
||||
* [rclone hashsum](/commands/rclone_hashsum/) - Produces a hashsum file for all the objects in the path.
|
||||
* [rclone link](/commands/rclone_link/) - Generate public link to file/folder.
|
||||
* [rclone listremotes](/commands/rclone_listremotes/) - List all the remotes in the config file.
|
||||
* [rclone listremotes](/commands/rclone_listremotes/) - List all the remotes in the config file and defined in environment variables.
|
||||
* [rclone ls](/commands/rclone_ls/) - List the objects in the path with size and path.
|
||||
* [rclone lsd](/commands/rclone_lsd/) - List all directories/containers/buckets in the path.
|
||||
* [rclone lsf](/commands/rclone_lsf/) - List directories and objects in remote:path formatted for parsing.
|
||||
|
||||
@ -52,8 +52,9 @@ you what happened to it. These are reminiscent of diff files.
|
||||
- `* path` means path was present in source and destination but different.
|
||||
- `! path` means there was an error reading or hashing the source or dest.
|
||||
|
||||
The default number of parallel checks is N=8. See the [--checkers=N](/docs/#checkers-n) option
|
||||
for more information.
|
||||
The default number of parallel checks is 8. See the [--checkers=N](/docs/#checkers-n)
|
||||
option for more information.
|
||||
|
||||
|
||||
```
|
||||
rclone check source:path dest:path [flags]
|
||||
|
||||
@ -44,6 +44,9 @@ you what happened to it. These are reminiscent of diff files.
|
||||
- `* path` means path was present in source and destination but different.
|
||||
- `! path` means there was an error reading or hashing the source or dest.
|
||||
|
||||
The default number of parallel checks is 8. See the [--checkers=N](/docs/#checkers-n)
|
||||
option for more information.
|
||||
|
||||
|
||||
```
|
||||
rclone checksum <hash> sumfile src:path [flags]
|
||||
|
||||
@ -1,18 +1,20 @@
|
||||
---
|
||||
title: "rclone completion"
|
||||
description: "Generate the autocompletion script for the specified shell"
|
||||
description: "Output completion script for a given shell."
|
||||
slug: rclone_completion
|
||||
url: /commands/rclone_completion/
|
||||
versionIntroduced: v1.33
|
||||
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/completion/ and as part of making a release run "make commanddocs"
|
||||
---
|
||||
# rclone completion
|
||||
|
||||
Generate the autocompletion script for the specified shell
|
||||
Output completion script for a given shell.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Generate the autocompletion script for rclone for the specified shell.
|
||||
See each sub-command's help for details on how to use the generated script.
|
||||
|
||||
Generates a shell completion script for rclone.
|
||||
Run with `--help` to list the supported shells.
|
||||
|
||||
|
||||
## Options
|
||||
@ -26,8 +28,7 @@ See the [global flags page](/flags/) for global options not listed here.
|
||||
## SEE ALSO
|
||||
|
||||
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
|
||||
* [rclone completion bash](/commands/rclone_completion_bash/) - Generate the autocompletion script for bash
|
||||
* [rclone completion fish](/commands/rclone_completion_fish/) - Generate the autocompletion script for fish
|
||||
* [rclone completion powershell](/commands/rclone_completion_powershell/) - Generate the autocompletion script for powershell
|
||||
* [rclone completion zsh](/commands/rclone_completion_zsh/) - Generate the autocompletion script for zsh
|
||||
* [rclone completion bash](/commands/rclone_completion_bash/) - Output bash completion script for rclone.
|
||||
* [rclone completion fish](/commands/rclone_completion_fish/) - Output fish completion script for rclone.
|
||||
* [rclone completion zsh](/commands/rclone_completion_zsh/) - Output zsh completion script for rclone.
|
||||
|
||||
|
||||
@ -1,52 +1,48 @@
|
||||
---
|
||||
title: "rclone completion bash"
|
||||
description: "Generate the autocompletion script for bash"
|
||||
description: "Output bash completion script for rclone."
|
||||
slug: rclone_completion_bash
|
||||
url: /commands/rclone_completion_bash/
|
||||
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/completion/bash/ and as part of making a release run "make commanddocs"
|
||||
---
|
||||
# rclone completion bash
|
||||
|
||||
Generate the autocompletion script for bash
|
||||
Output bash completion script for rclone.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Generate the autocompletion script for the bash shell.
|
||||
|
||||
This script depends on the 'bash-completion' package.
|
||||
If it is not installed already, you can install it via your OS's package manager.
|
||||
Generates a bash shell autocompletion script for rclone.
|
||||
|
||||
To load completions in your current shell session:
|
||||
This writes to /etc/bash_completion.d/rclone by default so will
|
||||
probably need to be run with sudo or as root, e.g.
|
||||
|
||||
source <(rclone completion bash)
|
||||
sudo rclone genautocomplete bash
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
Logout and login again to use the autocompletion scripts, or source
|
||||
them directly
|
||||
|
||||
### Linux:
|
||||
. /etc/bash_completion
|
||||
|
||||
rclone completion bash > /etc/bash_completion.d/rclone
|
||||
If you supply a command line argument the script will be written
|
||||
there.
|
||||
|
||||
### macOS:
|
||||
|
||||
rclone completion bash > $(brew --prefix)/etc/bash_completion.d/rclone
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
If output_file is "-", then the output will be written to stdout.
|
||||
|
||||
|
||||
```
|
||||
rclone completion bash
|
||||
rclone completion bash [output_file] [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for bash
|
||||
--no-descriptions disable completion descriptions
|
||||
```
|
||||
|
||||
See the [global flags page](/flags/) for global options not listed here.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [rclone completion](/commands/rclone_completion/) - Generate the autocompletion script for the specified shell
|
||||
* [rclone completion](/commands/rclone_completion/) - Output completion script for a given shell.
|
||||
|
||||
|
||||
@ -1,43 +1,48 @@
|
||||
---
|
||||
title: "rclone completion fish"
|
||||
description: "Generate the autocompletion script for fish"
|
||||
description: "Output fish completion script for rclone."
|
||||
slug: rclone_completion_fish
|
||||
url: /commands/rclone_completion_fish/
|
||||
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/completion/fish/ and as part of making a release run "make commanddocs"
|
||||
---
|
||||
# rclone completion fish
|
||||
|
||||
Generate the autocompletion script for fish
|
||||
Output fish completion script for rclone.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Generate the autocompletion script for the fish shell.
|
||||
|
||||
To load completions in your current shell session:
|
||||
Generates a fish autocompletion script for rclone.
|
||||
|
||||
rclone completion fish | source
|
||||
This writes to /etc/fish/completions/rclone.fish by default so will
|
||||
probably need to be run with sudo or as root, e.g.
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
sudo rclone genautocomplete fish
|
||||
|
||||
rclone completion fish > ~/.config/fish/completions/rclone.fish
|
||||
Logout and login again to use the autocompletion scripts, or source
|
||||
them directly
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
. /etc/fish/completions/rclone.fish
|
||||
|
||||
If you supply a command line argument the script will be written
|
||||
there.
|
||||
|
||||
If output_file is "-", then the output will be written to stdout.
|
||||
|
||||
|
||||
```
|
||||
rclone completion fish [flags]
|
||||
rclone completion fish [output_file] [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for fish
|
||||
--no-descriptions disable completion descriptions
|
||||
```
|
||||
|
||||
See the [global flags page](/flags/) for global options not listed here.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [rclone completion](/commands/rclone_completion/) - Generate the autocompletion script for the specified shell
|
||||
* [rclone completion](/commands/rclone_completion/) - Output completion script for a given shell.
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ url: /commands/rclone_completion_powershell/
|
||||
|
||||
Generate the autocompletion script for powershell
|
||||
|
||||
## Synopsis
|
||||
# Synopsis
|
||||
|
||||
Generate the autocompletion script for powershell.
|
||||
|
||||
@ -25,7 +25,7 @@ to your powershell profile.
|
||||
rclone completion powershell [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
# Options
|
||||
|
||||
```
|
||||
-h, --help help for powershell
|
||||
@ -34,7 +34,7 @@ rclone completion powershell [flags]
|
||||
|
||||
See the [global flags page](/flags/) for global options not listed here.
|
||||
|
||||
## SEE ALSO
|
||||
# SEE ALSO
|
||||
|
||||
* [rclone completion](/commands/rclone_completion/) - Generate the autocompletion script for the specified shell
|
||||
|
||||
|
||||
@ -1,54 +1,48 @@
|
||||
---
|
||||
title: "rclone completion zsh"
|
||||
description: "Generate the autocompletion script for zsh"
|
||||
description: "Output zsh completion script for rclone."
|
||||
slug: rclone_completion_zsh
|
||||
url: /commands/rclone_completion_zsh/
|
||||
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/completion/zsh/ and as part of making a release run "make commanddocs"
|
||||
---
|
||||
# rclone completion zsh
|
||||
|
||||
Generate the autocompletion script for zsh
|
||||
Output zsh completion script for rclone.
|
||||
|
||||
## Synopsis
|
||||
|
||||
Generate the autocompletion script for the zsh shell.
|
||||
|
||||
If shell completion is not already enabled in your environment you will need
|
||||
to enable it. You can execute the following once:
|
||||
Generates a zsh autocompletion script for rclone.
|
||||
|
||||
echo "autoload -U compinit; compinit" >> ~/.zshrc
|
||||
This writes to /usr/share/zsh/vendor-completions/_rclone by default so will
|
||||
probably need to be run with sudo or as root, e.g.
|
||||
|
||||
To load completions in your current shell session:
|
||||
sudo rclone genautocomplete zsh
|
||||
|
||||
source <(rclone completion zsh); compdef _rclone rclone
|
||||
Logout and login again to use the autocompletion scripts, or source
|
||||
them directly
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
autoload -U compinit && compinit
|
||||
|
||||
### Linux:
|
||||
If you supply a command line argument the script will be written
|
||||
there.
|
||||
|
||||
rclone completion zsh > "${fpath[1]}/_rclone"
|
||||
|
||||
### macOS:
|
||||
|
||||
rclone completion zsh > $(brew --prefix)/share/zsh/site-functions/_rclone
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
If output_file is "-", then the output will be written to stdout.
|
||||
|
||||
|
||||
```
|
||||
rclone completion zsh [flags]
|
||||
rclone completion zsh [output_file] [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for zsh
|
||||
--no-descriptions disable completion descriptions
|
||||
```
|
||||
|
||||
See the [global flags page](/flags/) for global options not listed here.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [rclone completion](/commands/rclone_completion/) - Generate the autocompletion script for the specified shell
|
||||
* [rclone completion](/commands/rclone_completion/) - Output completion script for a given shell.
|
||||
|
||||
|
||||
@ -13,16 +13,16 @@ Cryptcheck checks the integrity of an encrypted remote.
|
||||
## Synopsis
|
||||
|
||||
|
||||
rclone cryptcheck checks a remote against an [encrypted](/crypt/) remote.
|
||||
rclone cryptcheck checks a remote against a [crypted](/crypt/) remote.
|
||||
This is the equivalent of running rclone [check](/commands/rclone_check/),
|
||||
but able to check the checksums of the encrypted remote.
|
||||
|
||||
For it to work the underlying remote of the encryptedremote must support
|
||||
For it to work the underlying remote of the cryptedremote must support
|
||||
some kind of checksum.
|
||||
|
||||
It works by reading the nonce from each file on the encryptedremote: and
|
||||
It works by reading the nonce from each file on the cryptedremote: and
|
||||
using that to encrypt each file on the remote:. It then checks the
|
||||
checksum of the underlying file on the ercryptedremote: against the
|
||||
checksum of the underlying file on the cryptedremote: against the
|
||||
checksum of the file it has just encrypted.
|
||||
|
||||
Use it like this
|
||||
@ -57,11 +57,12 @@ you what happened to it. These are reminiscent of diff files.
|
||||
- `* path` means path was present in source and destination but different.
|
||||
- `! path` means there was an error reading or hashing the source or dest.
|
||||
|
||||
The default number of parallel checks is N=8. See the [--checkers=N](/docs/#checkers-n) option
|
||||
for more information.
|
||||
The default number of parallel checks is 8. See the [--checkers=N](/docs/#checkers-n)
|
||||
option for more information.
|
||||
|
||||
|
||||
```
|
||||
rclone cryptcheck remote:path encryptedremote:path [flags]
|
||||
rclone cryptcheck remote:path cryptedremote:path [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
@ -10,14 +10,14 @@ versionIntroduced: v1.33
|
||||
|
||||
Output completion script for a given shell.
|
||||
|
||||
## Synopsis
|
||||
# Synopsis
|
||||
|
||||
|
||||
Generates a shell completion script for rclone.
|
||||
Run with `--help` to list the supported shells.
|
||||
|
||||
|
||||
## Options
|
||||
# Options
|
||||
|
||||
```
|
||||
-h, --help help for genautocomplete
|
||||
@ -25,7 +25,7 @@ Run with `--help` to list the supported shells.
|
||||
|
||||
See the [global flags page](/flags/) for global options not listed here.
|
||||
|
||||
## SEE ALSO
|
||||
# SEE ALSO
|
||||
|
||||
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
|
||||
* [rclone genautocomplete bash](/commands/rclone_genautocomplete_bash/) - Output bash completion script for rclone.
|
||||
|
||||
@ -9,7 +9,7 @@ url: /commands/rclone_genautocomplete_bash/
|
||||
|
||||
Output bash completion script for rclone.
|
||||
|
||||
## Synopsis
|
||||
# Synopsis
|
||||
|
||||
|
||||
Generates a bash shell autocompletion script for rclone.
|
||||
@ -34,7 +34,7 @@ If output_file is "-", then the output will be written to stdout.
|
||||
rclone genautocomplete bash [output_file] [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
# Options
|
||||
|
||||
```
|
||||
-h, --help help for bash
|
||||
@ -42,7 +42,7 @@ rclone genautocomplete bash [output_file] [flags]
|
||||
|
||||
See the [global flags page](/flags/) for global options not listed here.
|
||||
|
||||
## SEE ALSO
|
||||
# SEE ALSO
|
||||
|
||||
* [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell.
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ url: /commands/rclone_genautocomplete_fish/
|
||||
|
||||
Output fish completion script for rclone.
|
||||
|
||||
## Synopsis
|
||||
# Synopsis
|
||||
|
||||
|
||||
Generates a fish autocompletion script for rclone.
|
||||
@ -34,7 +34,7 @@ If output_file is "-", then the output will be written to stdout.
|
||||
rclone genautocomplete fish [output_file] [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
# Options
|
||||
|
||||
```
|
||||
-h, --help help for fish
|
||||
@ -42,7 +42,7 @@ rclone genautocomplete fish [output_file] [flags]
|
||||
|
||||
See the [global flags page](/flags/) for global options not listed here.
|
||||
|
||||
## SEE ALSO
|
||||
# SEE ALSO
|
||||
|
||||
* [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell.
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ url: /commands/rclone_genautocomplete_zsh/
|
||||
|
||||
Output zsh completion script for rclone.
|
||||
|
||||
## Synopsis
|
||||
# Synopsis
|
||||
|
||||
|
||||
Generates a zsh autocompletion script for rclone.
|
||||
@ -34,7 +34,7 @@ If output_file is "-", then the output will be written to stdout.
|
||||
rclone genautocomplete zsh [output_file] [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
# Options
|
||||
|
||||
```
|
||||
-h, --help help for zsh
|
||||
@ -42,7 +42,7 @@ rclone genautocomplete zsh [output_file] [flags]
|
||||
|
||||
See the [global flags page](/flags/) for global options not listed here.
|
||||
|
||||
## SEE ALSO
|
||||
# SEE ALSO
|
||||
|
||||
* [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell.
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ versionIntroduced: v1.34
|
||||
---
|
||||
# rclone listremotes
|
||||
|
||||
List all the remotes in the config file.
|
||||
List all the remotes in the config file and defined in environment variables.
|
||||
|
||||
## Synopsis
|
||||
|
||||
|
||||
@ -272,6 +272,17 @@ Mounting on macOS can be done either via [macFUSE](https://osxfuse.github.io/)
|
||||
FUSE driver utilizing a macOS kernel extension (kext). FUSE-T is an alternative FUSE system
|
||||
which "mounts" via an NFSv4 local server.
|
||||
|
||||
### macFUSE Notes
|
||||
|
||||
If installing macFUSE using [dmg packages](https://github.com/osxfuse/osxfuse/releases) from
|
||||
the website, rclone will locate the macFUSE libraries without any further intervention.
|
||||
If however, macFUSE is installed using the [macports](https://www.macports.org/) package manager,
|
||||
the following addition steps are required.
|
||||
|
||||
sudo mkdir /usr/local/lib
|
||||
cd /usr/local/lib
|
||||
sudo ln -s /opt/local/lib/libfuse.2.dylib
|
||||
|
||||
### FUSE-T Limitations, Caveats, and Notes
|
||||
|
||||
There are some limitations, caveats, and notes about how it works. These are current as
|
||||
@ -407,18 +418,20 @@ mount sftp1:subdir /mnt/data -t rclone -o vfs_cache_mode=writes,sftp_key_file=/p
|
||||
or create systemd mount units:
|
||||
```
|
||||
# /etc/systemd/system/mnt-data.mount
|
||||
[Unit]
|
||||
Description=Mount for /mnt/data
|
||||
[Mount]
|
||||
Type=rclone
|
||||
What=sftp1:subdir
|
||||
Where=/mnt/data
|
||||
Options=rw,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone
|
||||
Options=rw,_netdev,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone
|
||||
```
|
||||
|
||||
optionally accompanied by systemd automount unit
|
||||
```
|
||||
# /etc/systemd/system/mnt-data.automount
|
||||
[Unit]
|
||||
Before=remote-fs.target
|
||||
Description=AutoMount for /mnt/data
|
||||
[Automount]
|
||||
Where=/mnt/data
|
||||
TimeoutIdleSec=600
|
||||
@ -531,7 +544,7 @@ find that you need one or the other or both.
|
||||
|
||||
--cache-dir string Directory rclone will use for caching.
|
||||
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||
--vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s)
|
||||
--vfs-write-back duration Time to writeback files after last use when using cache (default 5s)
|
||||
@ -554,7 +567,18 @@ flags.
|
||||
If using `--vfs-cache-max-size` note that the cache may exceed this size
|
||||
for two reasons. Firstly because it is only checked every
|
||||
`--vfs-cache-poll-interval`. Secondly because open files cannot be
|
||||
evicted from the cache.
|
||||
evicted from the cache. When `--vfs-cache-max-size`
|
||||
is exceeded, rclone will attempt to evict the least accessed files
|
||||
from the cache first. rclone will start with files that haven't
|
||||
been accessed for the longest. This cache flushing strategy is
|
||||
efficient and more relevant files are likely to remain cached.
|
||||
|
||||
The `--vfs-cache-max-age` will evict files from the cache
|
||||
after the set time since last access has passed. The default value of
|
||||
1 hour will start evicting files from cache that haven't been accessed
|
||||
for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0
|
||||
and will wait for 1 more hour before evicting. Specify the time with
|
||||
standard notation, s, m, h, d, w .
|
||||
|
||||
You **should not** run two copies of rclone using the same VFS cache
|
||||
with the same or overlapping remotes if using `--vfs-cache-mode > off`.
|
||||
@ -799,6 +823,7 @@ rclone mount remote:path /path/to/mountpoint [flags]
|
||||
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
-h, --help help for mount
|
||||
--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)
|
||||
--no-checksum Don't compare checksums on up/download
|
||||
--no-modtime Don't read/write the modification time (can speed things up)
|
||||
@ -810,7 +835,7 @@ rclone mount remote:path /path/to/mountpoint [flags]
|
||||
--read-only Only allow read-only access
|
||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||
--vfs-cache-max-age Duration Max age of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||
--vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s)
|
||||
|
||||
@ -38,10 +38,11 @@ and actually stream it, even if remote backend doesn't support streaming.
|
||||
size of the stream is different in length to the `--size` passed in
|
||||
then the transfer will likely fail.
|
||||
|
||||
Note that the upload can also not be retried because the data is
|
||||
not kept around until the upload succeeds. If you need to transfer
|
||||
a lot of data, you're better off caching locally and then
|
||||
`rclone move` it to the destination.
|
||||
Note that the upload cannot be retried because the data is not stored.
|
||||
If the backend supports multipart uploading then individual chunks can
|
||||
be retried. If you need to transfer a lot of data, you may be better
|
||||
off caching it locally and then `rclone move` it to the
|
||||
destination which can use retries.
|
||||
|
||||
```
|
||||
rclone rcat remote:path [flags]
|
||||
|
||||
@ -25,54 +25,54 @@ See the [rc documentation](/rc/) for more info on the rc flags.
|
||||
|
||||
## Server options
|
||||
|
||||
Use `--addr` to specify which IP address and port the server should
|
||||
listen on, eg `--addr 1.2.3.4:8000` or `--addr :8080` to listen to all
|
||||
Use `--rc-addr` to specify which IP address and port the server should
|
||||
listen on, eg `--rc-addr 1.2.3.4:8000` or `--rc-addr :8080` to listen to all
|
||||
IPs. By default it only listens on localhost. You can use port
|
||||
:0 to let the OS choose an available port.
|
||||
|
||||
If you set `--addr` to listen on a public or LAN accessible IP address
|
||||
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.
|
||||
|
||||
`--addr` may be repeated to listen on multiple IPs/ports/sockets.
|
||||
`--rc-addr` may be repeated to listen on multiple IPs/ports/sockets.
|
||||
|
||||
`--server-read-timeout` and `--server-write-timeout` can be used to
|
||||
`--rc-server-read-timeout` and `--rc-server-write-timeout` can be used to
|
||||
control the timeouts on the server. Note that this is the total time
|
||||
for a transfer.
|
||||
|
||||
`--max-header-bytes` controls the maximum number of bytes the server will
|
||||
`--rc-max-header-bytes` controls the maximum number of bytes the server will
|
||||
accept in the HTTP header.
|
||||
|
||||
`--baseurl` controls the URL prefix that rclone serves from. By default
|
||||
rclone will serve from the root. If you used `--baseurl "/rclone"` then
|
||||
`--rc-baseurl` controls the URL prefix that rclone serves from. By default
|
||||
rclone will serve from the root. If you used `--rc-baseurl "/rclone"` then
|
||||
rclone would serve from a URL starting with "/rclone/". This is
|
||||
useful if you wish to proxy rclone serve. Rclone automatically
|
||||
inserts leading and trailing "/" on `--baseurl`, so `--baseurl "rclone"`,
|
||||
`--baseurl "/rclone"` and `--baseurl "/rclone/"` are all treated
|
||||
inserts leading and trailing "/" on `--rc-baseurl`, so `--rc-baseurl "rclone"`,
|
||||
`--rc-baseurl "/rclone"` and `--rc-baseurl "/rclone/"` are all treated
|
||||
identically.
|
||||
|
||||
### TLS (SSL)
|
||||
|
||||
By default this will serve over http. If you want you can serve over
|
||||
https. You will need to supply the `--cert` and `--key` flags.
|
||||
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 `--client-ca` also.
|
||||
supply `--rc-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
|
||||
`--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.
|
||||
|
||||
--min-tls-version is minimum TLS version that is acceptable. Valid
|
||||
--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").
|
||||
|
||||
### Template
|
||||
|
||||
`--template` allows a user to specify a custom markup template for HTTP
|
||||
`--rc-template` allows a user to specify a custom markup template for HTTP
|
||||
and WebDAV serve functions. The server exports the following markup
|
||||
to be used within the template to server pages:
|
||||
|
||||
@ -100,9 +100,13 @@ to be used within the template to server pages:
|
||||
By default this will serve files without needing a login.
|
||||
|
||||
You can either use an htpasswd file which can take lots of users, or
|
||||
set a single username and password with the `--user` and `--pass` flags.
|
||||
set a single username and password with the `--rc-user` and `--rc-pass` flags.
|
||||
|
||||
Use `--htpasswd /path/to/htpasswd` to provide an htpasswd file. This is
|
||||
If no static users are configured by either of the above methods, and client
|
||||
certificates are required by the `--client-ca` flag passed to the server, the
|
||||
client certificate common name will be considered as the username.
|
||||
|
||||
Use `--rc-htpasswd /path/to/htpasswd` to provide an htpasswd file. This is
|
||||
in standard apache format and supports MD5, SHA1 and BCrypt for basic
|
||||
authentication. Bcrypt is recommended.
|
||||
|
||||
@ -114,9 +118,9 @@ To create an htpasswd file:
|
||||
|
||||
The password file can be updated while rclone is running.
|
||||
|
||||
Use `--realm` to set the authentication realm.
|
||||
Use `--rc-realm` to set the authentication realm.
|
||||
|
||||
Use `--salt` to change the password hashing salt from the default.
|
||||
Use `--rc-salt` to change the password hashing salt from the default.
|
||||
|
||||
|
||||
```
|
||||
|
||||
@ -112,7 +112,7 @@ find that you need one or the other or both.
|
||||
|
||||
--cache-dir string Directory rclone will use for caching.
|
||||
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||
--vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s)
|
||||
--vfs-write-back duration Time to writeback files after last use when using cache (default 5s)
|
||||
@ -135,7 +135,18 @@ flags.
|
||||
If using `--vfs-cache-max-size` note that the cache may exceed this size
|
||||
for two reasons. Firstly because it is only checked every
|
||||
`--vfs-cache-poll-interval`. Secondly because open files cannot be
|
||||
evicted from the cache.
|
||||
evicted from the cache. When `--vfs-cache-max-size`
|
||||
is exceeded, rclone will attempt to evict the least accessed files
|
||||
from the cache first. rclone will start with files that haven't
|
||||
been accessed for the longest. This cache flushing strategy is
|
||||
efficient and more relevant files are likely to remain cached.
|
||||
|
||||
The `--vfs-cache-max-age` will evict files from the cache
|
||||
after the set time since last access has passed. The default value of
|
||||
1 hour will start evicting files from cache that haven't been accessed
|
||||
for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0
|
||||
and will wait for 1 more hour before evicting. Specify the time with
|
||||
standard notation, s, m, h, d, w .
|
||||
|
||||
You **should not** run two copies of rclone using the same VFS cache
|
||||
with the same or overlapping remotes if using `--vfs-cache-mode > off`.
|
||||
@ -379,7 +390,7 @@ rclone serve dlna remote:path [flags]
|
||||
--read-only Only allow read-only access
|
||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||
--vfs-cache-max-age Duration Max age of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||
--vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s)
|
||||
|
||||
@ -128,7 +128,7 @@ find that you need one or the other or both.
|
||||
|
||||
--cache-dir string Directory rclone will use for caching.
|
||||
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||
--vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s)
|
||||
--vfs-write-back duration Time to writeback files after last use when using cache (default 5s)
|
||||
@ -151,7 +151,18 @@ flags.
|
||||
If using `--vfs-cache-max-size` note that the cache may exceed this size
|
||||
for two reasons. Firstly because it is only checked every
|
||||
`--vfs-cache-poll-interval`. Secondly because open files cannot be
|
||||
evicted from the cache.
|
||||
evicted from the cache. When `--vfs-cache-max-size`
|
||||
is exceeded, rclone will attempt to evict the least accessed files
|
||||
from the cache first. rclone will start with files that haven't
|
||||
been accessed for the longest. This cache flushing strategy is
|
||||
efficient and more relevant files are likely to remain cached.
|
||||
|
||||
The `--vfs-cache-max-age` will evict files from the cache
|
||||
after the set time since last access has passed. The default value of
|
||||
1 hour will start evicting files from cache that haven't been accessed
|
||||
for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0
|
||||
and will wait for 1 more hour before evicting. Specify the time with
|
||||
standard notation, s, m, h, d, w .
|
||||
|
||||
You **should not** run two copies of rclone using the same VFS cache
|
||||
with the same or overlapping remotes if using `--vfs-cache-mode > off`.
|
||||
@ -398,6 +409,7 @@ rclone serve docker [flags]
|
||||
--gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
-h, --help help for docker
|
||||
--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)
|
||||
--no-checksum Don't compare checksums on up/download
|
||||
--no-modtime Don't read/write the modification time (can speed things up)
|
||||
@ -412,7 +424,7 @@ rclone serve docker [flags]
|
||||
--socket-gid int GID for unix socket (default: current process GID) (default 1000)
|
||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||
--vfs-cache-max-age Duration Max age of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||
--vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s)
|
||||
|
||||
@ -109,7 +109,7 @@ find that you need one or the other or both.
|
||||
|
||||
--cache-dir string Directory rclone will use for caching.
|
||||
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||
--vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s)
|
||||
--vfs-write-back duration Time to writeback files after last use when using cache (default 5s)
|
||||
@ -132,7 +132,18 @@ flags.
|
||||
If using `--vfs-cache-max-size` note that the cache may exceed this size
|
||||
for two reasons. Firstly because it is only checked every
|
||||
`--vfs-cache-poll-interval`. Secondly because open files cannot be
|
||||
evicted from the cache.
|
||||
evicted from the cache. When `--vfs-cache-max-size`
|
||||
is exceeded, rclone will attempt to evict the least accessed files
|
||||
from the cache first. rclone will start with files that haven't
|
||||
been accessed for the longest. This cache flushing strategy is
|
||||
efficient and more relevant files are likely to remain cached.
|
||||
|
||||
The `--vfs-cache-max-age` will evict files from the cache
|
||||
after the set time since last access has passed. The default value of
|
||||
1 hour will start evicting files from cache that haven't been accessed
|
||||
for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0
|
||||
and will wait for 1 more hour before evicting. Specify the time with
|
||||
standard notation, s, m, h, d, w .
|
||||
|
||||
You **should not** run two copies of rclone using the same VFS cache
|
||||
with the same or overlapping remotes if using `--vfs-cache-mode > off`.
|
||||
@ -460,7 +471,7 @@ rclone serve ftp remote:path [flags]
|
||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||
--user string User name for authentication (default "anonymous")
|
||||
--vfs-cache-max-age Duration Max age of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||
--vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s)
|
||||
|
||||
@ -103,6 +103,10 @@ By default this will serve files without needing a login.
|
||||
You can either use an htpasswd file which can take lots of users, or
|
||||
set a single username and password with the `--user` and `--pass` flags.
|
||||
|
||||
If no static users are configured by either of the above methods, and client
|
||||
certificates are required by the `--client-ca` flag passed to the server, the
|
||||
client certificate common name will be considered as the username.
|
||||
|
||||
Use `--htpasswd /path/to/htpasswd` to provide an htpasswd file. This is
|
||||
in standard apache format and supports MD5, SHA1 and BCrypt for basic
|
||||
authentication. Bcrypt is recommended.
|
||||
@ -195,7 +199,7 @@ find that you need one or the other or both.
|
||||
|
||||
--cache-dir string Directory rclone will use for caching.
|
||||
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||
--vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s)
|
||||
--vfs-write-back duration Time to writeback files after last use when using cache (default 5s)
|
||||
@ -218,7 +222,18 @@ flags.
|
||||
If using `--vfs-cache-max-size` note that the cache may exceed this size
|
||||
for two reasons. Firstly because it is only checked every
|
||||
`--vfs-cache-poll-interval`. Secondly because open files cannot be
|
||||
evicted from the cache.
|
||||
evicted from the cache. When `--vfs-cache-max-size`
|
||||
is exceeded, rclone will attempt to evict the least accessed files
|
||||
from the cache first. rclone will start with files that haven't
|
||||
been accessed for the longest. This cache flushing strategy is
|
||||
efficient and more relevant files are likely to remain cached.
|
||||
|
||||
The `--vfs-cache-max-age` will evict files from the cache
|
||||
after the set time since last access has passed. The default value of
|
||||
1 hour will start evicting files from cache that haven't been accessed
|
||||
for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0
|
||||
and will wait for 1 more hour before evicting. Specify the time with
|
||||
standard notation, s, m, h, d, w .
|
||||
|
||||
You **should not** run two copies of rclone using the same VFS cache
|
||||
with the same or overlapping remotes if using `--vfs-cache-mode > off`.
|
||||
@ -554,7 +569,7 @@ rclone serve http remote:path [flags]
|
||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||
--user string User name for authentication
|
||||
--vfs-cache-max-age Duration Max age of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||
--vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s)
|
||||
|
||||
@ -148,6 +148,10 @@ By default this will serve files without needing a login.
|
||||
You can either use an htpasswd file which can take lots of users, or
|
||||
set a single username and password with the `--user` and `--pass` flags.
|
||||
|
||||
If no static users are configured by either of the above methods, and client
|
||||
certificates are required by the `--client-ca` flag passed to the server, the
|
||||
client certificate common name will be considered as the username.
|
||||
|
||||
Use `--htpasswd /path/to/htpasswd` to provide an htpasswd file. This is
|
||||
in standard apache format and supports MD5, SHA1 and BCrypt for basic
|
||||
authentication. Bcrypt is recommended.
|
||||
|
||||
@ -141,7 +141,7 @@ find that you need one or the other or both.
|
||||
|
||||
--cache-dir string Directory rclone will use for caching.
|
||||
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||
--vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s)
|
||||
--vfs-write-back duration Time to writeback files after last use when using cache (default 5s)
|
||||
@ -164,7 +164,18 @@ flags.
|
||||
If using `--vfs-cache-max-size` note that the cache may exceed this size
|
||||
for two reasons. Firstly because it is only checked every
|
||||
`--vfs-cache-poll-interval`. Secondly because open files cannot be
|
||||
evicted from the cache.
|
||||
evicted from the cache. When `--vfs-cache-max-size`
|
||||
is exceeded, rclone will attempt to evict the least accessed files
|
||||
from the cache first. rclone will start with files that haven't
|
||||
been accessed for the longest. This cache flushing strategy is
|
||||
efficient and more relevant files are likely to remain cached.
|
||||
|
||||
The `--vfs-cache-max-age` will evict files from the cache
|
||||
after the set time since last access has passed. The default value of
|
||||
1 hour will start evicting files from cache that haven't been accessed
|
||||
for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0
|
||||
and will wait for 1 more hour before evicting. Specify the time with
|
||||
standard notation, s, m, h, d, w .
|
||||
|
||||
You **should not** run two copies of rclone using the same VFS cache
|
||||
with the same or overlapping remotes if using `--vfs-cache-mode > off`.
|
||||
@ -492,7 +503,7 @@ rclone serve sftp remote:path [flags]
|
||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||
--user string User name for authentication
|
||||
--vfs-cache-max-age Duration Max age of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||
--vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s)
|
||||
|
||||
@ -132,6 +132,10 @@ By default this will serve files without needing a login.
|
||||
You can either use an htpasswd file which can take lots of users, or
|
||||
set a single username and password with the `--user` and `--pass` flags.
|
||||
|
||||
If no static users are configured by either of the above methods, and client
|
||||
certificates are required by the `--client-ca` flag passed to the server, the
|
||||
client certificate common name will be considered as the username.
|
||||
|
||||
Use `--htpasswd /path/to/htpasswd` to provide an htpasswd file. This is
|
||||
in standard apache format and supports MD5, SHA1 and BCrypt for basic
|
||||
authentication. Bcrypt is recommended.
|
||||
@ -224,7 +228,7 @@ find that you need one or the other or both.
|
||||
|
||||
--cache-dir string Directory rclone will use for caching.
|
||||
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||
--vfs-cache-max-age duration Max age of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s)
|
||||
--vfs-write-back duration Time to writeback files after last use when using cache (default 5s)
|
||||
@ -247,7 +251,18 @@ flags.
|
||||
If using `--vfs-cache-max-size` note that the cache may exceed this size
|
||||
for two reasons. Firstly because it is only checked every
|
||||
`--vfs-cache-poll-interval`. Secondly because open files cannot be
|
||||
evicted from the cache.
|
||||
evicted from the cache. When `--vfs-cache-max-size`
|
||||
is exceeded, rclone will attempt to evict the least accessed files
|
||||
from the cache first. rclone will start with files that haven't
|
||||
been accessed for the longest. This cache flushing strategy is
|
||||
efficient and more relevant files are likely to remain cached.
|
||||
|
||||
The `--vfs-cache-max-age` will evict files from the cache
|
||||
after the set time since last access has passed. The default value of
|
||||
1 hour will start evicting files from cache that haven't been accessed
|
||||
for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0
|
||||
and will wait for 1 more hour before evicting. Specify the time with
|
||||
standard notation, s, m, h, d, w .
|
||||
|
||||
You **should not** run two copies of rclone using the same VFS cache
|
||||
with the same or overlapping remotes if using `--vfs-cache-mode > off`.
|
||||
@ -585,7 +600,7 @@ rclone serve webdav remote:path [flags]
|
||||
--uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000)
|
||||
--umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2)
|
||||
--user string User name for authentication
|
||||
--vfs-cache-max-age Duration Max age of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s)
|
||||
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off)
|
||||
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
|
||||
--vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s)
|
||||
|
||||
@ -26,7 +26,7 @@ recursion.
|
||||
|
||||
Some backends do not always provide file sizes, see for example
|
||||
[Google Photos](/googlephotos/#size) and
|
||||
[Google Drive](/drive/#limitations-of-google-docs).
|
||||
[Google Docs](/drive/#limitations-of-google-docs).
|
||||
Rclone will then show a notice in the log indicating how many such
|
||||
files were encountered, and count them in as empty files in the output
|
||||
of the size command.
|
||||
|
||||
@ -454,7 +454,7 @@ Properties:
|
||||
- Very simple filename obfuscation.
|
||||
- "off"
|
||||
- Don't encrypt the file names.
|
||||
- Adds a ".bin" extension only.
|
||||
- Adds a ".bin", or "suffix" extension only.
|
||||
|
||||
#### --crypt-directory-name-encryption
|
||||
|
||||
@ -509,6 +509,8 @@ Here are the Advanced options specific to crypt (Encrypt/Decrypt a remote).
|
||||
|
||||
#### --crypt-server-side-across-configs
|
||||
|
||||
Deprecated: use --server-side-across-configs instead.
|
||||
|
||||
Allow server-side operations (e.g. copy) to work across different crypt configs.
|
||||
|
||||
Normally this option is not what you want, but if you have two crypts
|
||||
@ -562,6 +564,21 @@ Properties:
|
||||
- "false"
|
||||
- Encrypt file data.
|
||||
|
||||
#### --crypt-pass-bad-blocks
|
||||
|
||||
If set this will pass bad blocks through as all 0.
|
||||
|
||||
This should not be set in normal operation, it should only be set if
|
||||
trying to recover an encrypted file with errors and it is desired to
|
||||
recover as much of the file as possible.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: pass_bad_blocks
|
||||
- Env Var: RCLONE_CRYPT_PASS_BAD_BLOCKS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --crypt-filename-encoding
|
||||
|
||||
How to encode the encrypted filename to text string.
|
||||
@ -583,7 +600,21 @@ Properties:
|
||||
- Encode using base64. Suitable for case sensitive remote.
|
||||
- "base32768"
|
||||
- Encode using base32768. Suitable if your remote counts UTF-16 or
|
||||
- Unicode codepoint instead of UTF-8 byte length. (Eg. Onedrive)
|
||||
- Unicode codepoint instead of UTF-8 byte length. (Eg. Onedrive, Dropbox)
|
||||
|
||||
#### --crypt-suffix
|
||||
|
||||
If this is set it will override the default suffix of ".bin".
|
||||
|
||||
Setting suffix to "none" will result in an empty suffix. This may be useful
|
||||
when the path length is critical.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: suffix
|
||||
- Env Var: RCLONE_CRYPT_SUFFIX
|
||||
- Type: string
|
||||
- Default: ".bin"
|
||||
|
||||
### Metadata
|
||||
|
||||
|
||||
@ -1066,6 +1066,8 @@ Properties:
|
||||
|
||||
#### --drive-server-side-across-configs
|
||||
|
||||
Deprecated: use --server-side-across-configs instead.
|
||||
|
||||
Allow server-side operations (e.g. copy) to work across different drive configs.
|
||||
|
||||
This can be useful if you wish to do a server-side copy between two
|
||||
@ -1215,6 +1217,24 @@ Properties:
|
||||
- Type: MultiEncoder
|
||||
- Default: InvalidUtf8
|
||||
|
||||
#### --drive-env-auth
|
||||
|
||||
Get IAM credentials from runtime (environment variables or instance meta data if no env vars).
|
||||
|
||||
Only applies if service_account_file and service_account_credentials is blank.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: env_auth
|
||||
- Env Var: RCLONE_DRIVE_ENV_AUTH
|
||||
- Type: bool
|
||||
- Default: false
|
||||
- Examples:
|
||||
- "false"
|
||||
- Enter credentials in the next step.
|
||||
- "true"
|
||||
- Get GCP IAM credentials from the environment (env vars or IAM).
|
||||
|
||||
## Backend commands
|
||||
|
||||
Here are the commands specific to the drive backend.
|
||||
|
||||
@ -406,8 +406,8 @@ uploaded.
|
||||
The default for this is 0 which means rclone will choose a sensible
|
||||
default based on the batch_mode in use.
|
||||
|
||||
- batch_mode: async - default batch_timeout is 500ms
|
||||
- batch_mode: sync - default batch_timeout is 10s
|
||||
- batch_mode: async - default batch_timeout is 10s
|
||||
- batch_mode: sync - default batch_timeout is 500ms
|
||||
- batch_mode: off - not in use
|
||||
|
||||
|
||||
@ -429,6 +429,17 @@ Properties:
|
||||
- Type: Duration
|
||||
- Default: 10m0s
|
||||
|
||||
#### --dropbox-pacer-min-sleep
|
||||
|
||||
Minimum time to sleep between API calls.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: pacer_min_sleep
|
||||
- Env Var: RCLONE_DROPBOX_PACER_MIN_SLEEP
|
||||
- Type: Duration
|
||||
- Default: 10ms
|
||||
|
||||
#### --dropbox-encoding
|
||||
|
||||
The encoding for the backend.
|
||||
|
||||
@ -171,6 +171,17 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --fichier-cdn
|
||||
|
||||
Set if you wish to use CDN download links.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: cdn
|
||||
- Env Var: RCLONE_FICHIER_CDN
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --fichier-encoding
|
||||
|
||||
The encoding for the backend.
|
||||
|
||||
@ -34,6 +34,7 @@ These flags are available for every command.
|
||||
--copy-dest stringArray Implies --compare-dest but also copies files from paths into destination
|
||||
--cpuprofile string Write cpu profile to file
|
||||
--cutoff-mode string Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default "HARD")
|
||||
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
|
||||
--delete-after When synchronizing, delete files on destination after transferring (default)
|
||||
--delete-before When synchronizing, delete files on destination before transferring
|
||||
--delete-during When synchronizing, delete files during transfer
|
||||
@ -72,6 +73,7 @@ These flags are available for every command.
|
||||
--immutable Do not modify files, fail if existing files have been modified
|
||||
--include stringArray Include files matching pattern
|
||||
--include-from stringArray Read file include patterns from file (use - to read from stdin)
|
||||
--inplace Download directly to destination file instead of atomic download to temp/rename
|
||||
-i, --interactive Enable interactive mode
|
||||
--kv-lock-time Duration Maximum time to keep key-value database locked by process (default 1s)
|
||||
--log-file string Log everything to this file
|
||||
@ -102,6 +104,7 @@ These flags are available for every command.
|
||||
--modify-window Duration Max time diff to be considered the same (default 1ns)
|
||||
--multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 250Mi)
|
||||
--multi-thread-streams int Max number of streams to use for multi-thread downloads (default 4)
|
||||
--multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki)
|
||||
--no-check-certificate Do not verify the server SSL certificate (insecure)
|
||||
--no-check-dest Don't check the destination, copy regardless
|
||||
--no-console Hide console window (supported on Windows only)
|
||||
@ -171,7 +174,7 @@ These flags are available for every command.
|
||||
--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.62.0")
|
||||
--user-agent string Set the user-agent to a specified string (default "rclone/v1.63.0")
|
||||
-v, --verbose count Print lots more stuff (repeat for more)
|
||||
```
|
||||
|
||||
@ -199,6 +202,7 @@ and may be set in the config file.
|
||||
--azureblob-client-id string The ID of the client in use
|
||||
--azureblob-client-secret string One of the service principal's client secrets
|
||||
--azureblob-client-send-certificate-chain Send the certificate chain when using certificate auth
|
||||
--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-encoding MultiEncoder The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
|
||||
--azureblob-endpoint string Endpoint for the service
|
||||
@ -286,11 +290,13 @@ and may be set in the config file.
|
||||
--crypt-filename-encoding string How to encode the encrypted filename to text string (default "base32")
|
||||
--crypt-filename-encryption string How to encrypt the filenames (default "standard")
|
||||
--crypt-no-data-encryption Option to either encrypt file data or leave it unencrypted
|
||||
--crypt-pass-bad-blocks If set this will pass bad blocks through as all 0
|
||||
--crypt-password string Password or pass phrase for encryption (obscured)
|
||||
--crypt-password2 string Password or pass phrase for salt (obscured)
|
||||
--crypt-remote string Remote to encrypt/decrypt
|
||||
--crypt-server-side-across-configs Allow server-side operations (e.g. copy) to work across different crypt configs
|
||||
--crypt-server-side-across-configs Deprecated: use --server-side-across-configs instead
|
||||
--crypt-show-mapping For all files listed show how the names encrypt
|
||||
--crypt-suffix string If this is set it will override the default suffix of ".bin" (default ".bin")
|
||||
--drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded
|
||||
--drive-allow-import-name-change Allow the filetype to change when uploading Google docs
|
||||
--drive-auth-owner-only Only consider files owned by the authenticated user
|
||||
@ -301,6 +307,7 @@ and may be set in the config file.
|
||||
--drive-copy-shortcut-content Server side copy contents of shortcuts instead of the shortcut
|
||||
--drive-disable-http2 Disable drive using http2 (default true)
|
||||
--drive-encoding MultiEncoder The encoding for the backend (default InvalidUtf8)
|
||||
--drive-env-auth Get IAM credentials from runtime (environment variables or instance meta data if no env vars)
|
||||
--drive-export-formats string Comma separated list of preferred formats for downloading Google docs (default "docx,xlsx,pptx,svg")
|
||||
--drive-formats string Deprecated: See export_formats
|
||||
--drive-impersonate string Impersonate this user when using a service account
|
||||
@ -312,7 +319,7 @@ and may be set in the config file.
|
||||
--drive-resource-key string Resource key for accessing a link-shared file
|
||||
--drive-root-folder-id string ID of the root folder
|
||||
--drive-scope string Scope that rclone should use when requesting access from drive
|
||||
--drive-server-side-across-configs Allow server-side operations (e.g. copy) to work across different drive configs
|
||||
--drive-server-side-across-configs Deprecated: use --server-side-across-configs instead
|
||||
--drive-service-account-credentials string Service Account Credentials JSON blob
|
||||
--drive-service-account-file string Service Account Credentials JSON file path
|
||||
--drive-shared-with-me Only show files that are shared with me
|
||||
@ -343,11 +350,13 @@ and may be set in the config file.
|
||||
--dropbox-client-secret string OAuth Client Secret
|
||||
--dropbox-encoding MultiEncoder The encoding for the backend (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot)
|
||||
--dropbox-impersonate string Impersonate this user when using a business account
|
||||
--dropbox-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms)
|
||||
--dropbox-shared-files Instructs rclone to work on individual shared files
|
||||
--dropbox-shared-folders Instructs rclone to work on shared folders
|
||||
--dropbox-token string OAuth Access Token as a JSON blob
|
||||
--dropbox-token-url string Token server url
|
||||
--fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl
|
||||
--fichier-cdn Set if you wish to use CDN download links
|
||||
--fichier-encoding MultiEncoder The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot)
|
||||
--fichier-file-password string If you want to download a shared file that is password protected, add this parameter (obscured)
|
||||
--fichier-folder-password string If you want to list the files in a shared folder that is password protected, add this parameter (obscured)
|
||||
@ -386,6 +395,7 @@ and may be set in the config file.
|
||||
--gcs-client-id string OAuth Client Id
|
||||
--gcs-client-secret string OAuth Client Secret
|
||||
--gcs-decompress If set this will decompress gzip encoded objects
|
||||
--gcs-directory-markers Upload an empty object with a trailing slash when a new directory is created
|
||||
--gcs-encoding MultiEncoder The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
|
||||
--gcs-endpoint string Endpoint for the service
|
||||
--gcs-env-auth Get GCP IAM credentials from runtime (environment variables or instance meta data if no env vars)
|
||||
@ -397,6 +407,7 @@ and may be set in the config file.
|
||||
--gcs-storage-class string The storage class to use when storing objects in Google Cloud Storage
|
||||
--gcs-token string OAuth Access Token as a JSON blob
|
||||
--gcs-token-url string Token server url
|
||||
--gcs-user-project string User project
|
||||
--gphotos-auth-url string Auth server URL
|
||||
--gphotos-client-id string OAuth Client Id
|
||||
--gphotos-client-secret string OAuth Client Secret
|
||||
@ -486,6 +497,7 @@ and may be set in the config file.
|
||||
-x, --one-file-system Don't cross filesystem boundaries (unix/macOS only)
|
||||
--onedrive-access-scopes SpaceSepList Set scopes to be requested by rclone (default Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access)
|
||||
--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-id string OAuth Client Id
|
||||
--onedrive-client-secret string OAuth Client Secret
|
||||
@ -501,7 +513,7 @@ and may be set in the config file.
|
||||
--onedrive-no-versions Remove all versions on modifying operations
|
||||
--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 Allow server-side operations (e.g. copy) to work across different onedrive configs
|
||||
--onedrive-server-side-across-configs Deprecated: use --server-side-across-configs instead
|
||||
--onedrive-token string OAuth Access Token as a JSON blob
|
||||
--onedrive-token-url string Token server url
|
||||
--oos-chunk-size SizeSuffix Chunk size to use for uploading (default 5Mi)
|
||||
@ -522,7 +534,7 @@ and may be set in the config file.
|
||||
--oos-sse-customer-key string To use SSE-C, the optional header that specifies the base64-encoded 256-bit encryption key to use to
|
||||
--oos-sse-customer-key-file string To use SSE-C, a file containing the base64-encoded string of the AES-256 encryption key associated
|
||||
--oos-sse-customer-key-sha256 string If using SSE-C, The optional header that specifies the base64-encoded SHA256 hash of the encryption
|
||||
--oos-sse-kms-key-id string if using using your own master key in vault, this header specifies the
|
||||
--oos-sse-kms-key-id string if using your own master key in vault, this header specifies the
|
||||
--oos-storage-tier string The storage class to use when storing new objects in storage. https://docs.oracle.com/en-us/iaas/Content/Object/Concepts/understandingstoragetiers.htm (default "Standard")
|
||||
--oos-upload-concurrency int Concurrency for multipart uploads (default 10)
|
||||
--oos-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
|
||||
@ -540,6 +552,18 @@ and may be set in the config file.
|
||||
--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-client-id string OAuth Client Id
|
||||
--pikpak-client-secret string OAuth Client Secret
|
||||
--pikpak-encoding MultiEncoder 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-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-use-trash Send files to the trash instead of deleting permanently (default true)
|
||||
--pikpak-user string Pikpak username
|
||||
--premiumizeme-encoding MultiEncoder The encoding for the backend (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||
--putio-encoding MultiEncoder The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
|
||||
--qingstor-access-key-id string QingStor Access Key ID
|
||||
@ -558,6 +582,7 @@ and may be set in the config file.
|
||||
--s3-chunk-size SizeSuffix Chunk size to use for uploading (default 5Mi)
|
||||
--s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi)
|
||||
--s3-decompress If set this will decompress gzip encoded objects
|
||||
--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
|
||||
--s3-download-url string Custom endpoint for downloads
|
||||
@ -596,6 +621,7 @@ and may be set in the config file.
|
||||
--s3-upload-concurrency int Concurrency for multipart uploads (default 4)
|
||||
--s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi)
|
||||
--s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint
|
||||
--s3-use-accept-encoding-gzip Accept-Encoding: gzip Whether to send Accept-Encoding: gzip header (default unset)
|
||||
--s3-use-multipart-etag Tristate Whether to use ETag in multipart uploads for verification (default unset)
|
||||
--s3-use-presigned-request Whether to use a presigned request or PutObject for single part uploads
|
||||
--s3-v2-auth If true use v2 authentication
|
||||
@ -617,6 +643,7 @@ and may be set in the config file.
|
||||
--sftp-disable-concurrent-writes If set don't use concurrent writes
|
||||
--sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available
|
||||
--sftp-host string SSH host to connect to
|
||||
--sftp-host-key-algorithms SpaceSepList Space separated list of host key algorithms, ordered by preference
|
||||
--sftp-idle-timeout Duration Max time before closing idle connections (default 1m0s)
|
||||
--sftp-key-exchange SpaceSepList Space separated list of key exchange algorithms, ordered by preference
|
||||
--sftp-key-file string Path to PEM-encoded private key file
|
||||
@ -707,10 +734,13 @@ and may be set in the config file.
|
||||
--union-upstreams string List of space separated upstreams
|
||||
--uptobox-access-token string Your access token
|
||||
--uptobox-encoding MultiEncoder The encoding for the backend (default Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot)
|
||||
--uptobox-private Set to make uploaded files private
|
||||
--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-encoding string The encoding for the backend
|
||||
--webdav-headers CommaSepList Set HTTP headers for all transactions
|
||||
--webdav-nextcloud-chunk-size SizeSuffix Nextcloud upload chunk size (default 10Mi)
|
||||
--webdav-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms)
|
||||
--webdav-pass string Password (obscured)
|
||||
--webdav-url string URL of http host to connect to
|
||||
--webdav-user string User name
|
||||
|
||||
@ -320,6 +320,19 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --gcs-user-project
|
||||
|
||||
User project.
|
||||
|
||||
Optional - needed only for requester pays.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: user_project
|
||||
- Env Var: RCLONE_GCS_USER_PROJECT
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --gcs-service-account-file
|
||||
|
||||
Service Account Credentials JSON file path.
|
||||
@ -611,6 +624,21 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --gcs-directory-markers
|
||||
|
||||
Upload an empty object with a trailing slash when a new directory is created
|
||||
|
||||
Empty folders are unsupported for bucket based remotes, this option creates an empty
|
||||
object ending with "/", to persist the folder.
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: directory_markers
|
||||
- Env Var: RCLONE_GCS_DIRECTORY_MARKERS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --gcs-no-check-bucket
|
||||
|
||||
If set, don't attempt to check the bucket exists or create it.
|
||||
|
||||
@ -205,9 +205,9 @@ Properties:
|
||||
Kerberos data transfer protection: authentication|integrity|privacy.
|
||||
|
||||
Specifies whether or not authentication, data signature integrity
|
||||
checks, and wire encryption is required when communicating the the
|
||||
datanodes. Possible values are 'authentication', 'integrity' and
|
||||
'privacy'. Used only with KERBEROS enabled.
|
||||
checks, and wire encryption are required when communicating with
|
||||
the datanodes. Possible values are 'authentication', 'integrity'
|
||||
and 'privacy'. Used only with KERBEROS enabled.
|
||||
|
||||
Properties:
|
||||
|
||||
|
||||
@ -428,6 +428,8 @@ Properties:
|
||||
|
||||
#### --onedrive-server-side-across-configs
|
||||
|
||||
Deprecated: use --server-side-across-configs instead.
|
||||
|
||||
Allow server-side operations (e.g. copy) to work across different onedrive configs.
|
||||
|
||||
This will only work if you are copying between two OneDrive *Personal* drives AND
|
||||
@ -531,7 +533,7 @@ Properties:
|
||||
Specify the hash in use for the backend.
|
||||
|
||||
This specifies the hash type in use. If set to "auto" it will use the
|
||||
default hash which is is QuickXorHash.
|
||||
default hash which is QuickXorHash.
|
||||
|
||||
Before rclone 1.62 an SHA1 hash was used by default for Onedrive
|
||||
Personal. For 1.62 and later the default is to use a QuickXorHash for
|
||||
@ -568,6 +570,30 @@ Properties:
|
||||
- "none"
|
||||
- None - don't use any hashes
|
||||
|
||||
#### --onedrive-av-override
|
||||
|
||||
Allows download of files the server thinks has a virus.
|
||||
|
||||
The onedrive/sharepoint server may check files uploaded with an Anti
|
||||
Virus checker. If it detects any potential viruses or malware it will
|
||||
block download of the file.
|
||||
|
||||
In this case you will see a message like this
|
||||
|
||||
server reports this file is infected with a virus - use --onedrive-av-override to download anyway: Infected (name of virus): 403 Forbidden:
|
||||
|
||||
If you are 100% sure you want to download this file anyway then use
|
||||
the --onedrive-av-override flag, or av_override = true in the config
|
||||
file.
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: av_override
|
||||
- Env Var: RCLONE_ONEDRIVE_AV_OVERRIDE
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --onedrive-encoding
|
||||
|
||||
The encoding for the backend.
|
||||
|
||||
@ -611,7 +611,7 @@ Properties:
|
||||
|
||||
#### --oos-sse-kms-key-id
|
||||
|
||||
if using using your own master key in vault, this header specifies the
|
||||
if using your own master key in vault, this header specifies the
|
||||
OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a master encryption key used to call
|
||||
the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.
|
||||
Please note only one of sse_customer_key_file|sse_customer_key|sse_kms_key_id is needed.
|
||||
|
||||
@ -586,7 +586,7 @@ See the [config dump](/commands/rclone_config_dump/) command for more informatio
|
||||
|
||||
**Authentication is required for this call.**
|
||||
|
||||
### config/listremotes: Lists the remotes in the config file. {#config-listremotes}
|
||||
### config/listremotes: Lists the remotes in the config file and defined in environment variables. {#config-listremotes}
|
||||
|
||||
Returns
|
||||
- remotes - array of remote names
|
||||
@ -1160,9 +1160,9 @@ See the [cleanup](/commands/rclone_cleanup/) command for more information on the
|
||||
|
||||
This takes the following parameters:
|
||||
|
||||
- srcFs - a remote name string e.g. "drive:" for the source
|
||||
- srcFs - a remote name string e.g. "drive:" for the source, "/" for local filesystem
|
||||
- srcRemote - a path within that remote e.g. "file.txt" for the source
|
||||
- dstFs - a remote name string e.g. "drive2:" for the destination
|
||||
- dstFs - a remote name string e.g. "drive2:" for the destination, "/" for local filesystem
|
||||
- dstRemote - a path within that remote e.g. "file2.txt" for the destination
|
||||
|
||||
**Authentication is required for this call.**
|
||||
@ -1357,9 +1357,9 @@ See the [mkdir](/commands/rclone_mkdir/) command for more information on the abo
|
||||
|
||||
This takes the following parameters:
|
||||
|
||||
- srcFs - a remote name string e.g. "drive:" for the source
|
||||
- srcFs - a remote name string e.g. "drive:" for the source, "/" for local filesystem
|
||||
- srcRemote - a path within that remote e.g. "file.txt" for the source
|
||||
- dstFs - a remote name string e.g. "drive2:" for the destination
|
||||
- dstFs - a remote name string e.g. "drive2:" for the destination, "/" for local filesystem
|
||||
- dstRemote - a path within that remote e.g. "file2.txt" for the destination
|
||||
|
||||
**Authentication is required for this call.**
|
||||
|
||||
@ -649,7 +649,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, Ceph, China Mobile, Cloudflare, ArvanCloud, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, IDrive e2, IONOS Cloud, Liara, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS, Qiniu and Wasabi).
|
||||
Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, China Mobile, Cloudflare, GCS, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, IDrive e2, IONOS Cloud, Liara, Lyve Cloud, Minio, Netease, Petabox, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS, Qiniu and Wasabi).
|
||||
|
||||
#### --s3-provider
|
||||
|
||||
@ -666,18 +666,20 @@ Properties:
|
||||
- Amazon Web Services (AWS) S3
|
||||
- "Alibaba"
|
||||
- Alibaba Cloud Object Storage System (OSS) formerly Aliyun
|
||||
- "ArvanCloud"
|
||||
- Arvan Cloud Object Storage (AOS)
|
||||
- "Ceph"
|
||||
- Ceph Object Storage
|
||||
- "ChinaMobile"
|
||||
- China Mobile Ecloud Elastic Object Storage (EOS)
|
||||
- "Cloudflare"
|
||||
- Cloudflare R2 Storage
|
||||
- "ArvanCloud"
|
||||
- Arvan Cloud Object Storage (AOS)
|
||||
- "DigitalOcean"
|
||||
- DigitalOcean Spaces
|
||||
- "Dreamhost"
|
||||
- Dreamhost DreamObjects
|
||||
- "GCS"
|
||||
- Google Cloud Storage
|
||||
- "HuaweiOBS"
|
||||
- Huawei Object Storage Service
|
||||
- "IBMCOS"
|
||||
@ -694,6 +696,8 @@ Properties:
|
||||
- Minio Object Storage
|
||||
- "Netease"
|
||||
- Netease Object Storage (NOS)
|
||||
- "Petabox"
|
||||
- Petabox Object Storage
|
||||
- "RackCorp"
|
||||
- RackCorp Object Storage
|
||||
- "Scaleway"
|
||||
@ -1033,6 +1037,30 @@ Properties:
|
||||
|
||||
#### --s3-region
|
||||
|
||||
Region where your bucket will be created and your data stored.
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: region
|
||||
- Env Var: RCLONE_S3_REGION
|
||||
- Provider: Petabox
|
||||
- Type: string
|
||||
- Required: false
|
||||
- Examples:
|
||||
- "us-east-1"
|
||||
- US East (N. Virginia)
|
||||
- "eu-central-1"
|
||||
- Europe (Frankfurt)
|
||||
- "ap-southeast-1"
|
||||
- Asia Pacific (Singapore)
|
||||
- "me-south-1"
|
||||
- Middle East (Bahrain)
|
||||
- "sa-east-1"
|
||||
- South America (São Paulo)
|
||||
|
||||
#### --s3-region
|
||||
|
||||
Region to connect to.
|
||||
|
||||
Leave blank if you are using an S3 clone and you don't have a region.
|
||||
@ -1041,7 +1069,7 @@ Properties:
|
||||
|
||||
- Config: region
|
||||
- Env Var: RCLONE_S3_REGION
|
||||
- Provider: !AWS,Alibaba,ChinaMobile,Cloudflare,IONOS,ArvanCloud,Liara,Qiniu,RackCorp,Scaleway,Storj,TencentCOS,HuaweiOBS,IDrive
|
||||
- Provider: !AWS,Alibaba,ArvanCloud,ChinaMobile,Cloudflare,IONOS,Petabox,Liara,Qiniu,RackCorp,Scaleway,Storj,TencentCOS,HuaweiOBS,IDrive
|
||||
- Type: string
|
||||
- Required: false
|
||||
- Examples:
|
||||
@ -1152,10 +1180,10 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
- Examples:
|
||||
- "s3.ir-thr-at1.arvanstorage.com"
|
||||
- "s3.ir-thr-at1.arvanstorage.ir"
|
||||
- The default endpoint - a good choice if you are unsure.
|
||||
- Tehran Iran (Asiatech)
|
||||
- "s3.ir-tbz-sh1.arvanstorage.com"
|
||||
- Tehran Iran (Simin)
|
||||
- "s3.ir-tbz-sh1.arvanstorage.ir"
|
||||
- Tabriz Iran (Shahriar)
|
||||
|
||||
#### --s3-endpoint
|
||||
@ -1320,6 +1348,33 @@ Properties:
|
||||
|
||||
#### --s3-endpoint
|
||||
|
||||
Endpoint for Petabox S3 Object Storage.
|
||||
|
||||
Specify the endpoint from the same region.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: endpoint
|
||||
- Env Var: RCLONE_S3_ENDPOINT
|
||||
- Provider: Petabox
|
||||
- Type: string
|
||||
- Required: true
|
||||
- Examples:
|
||||
- "s3.petabox.io"
|
||||
- US East (N. Virginia)
|
||||
- "s3.us-east-1.petabox.io"
|
||||
- US East (N. Virginia)
|
||||
- "s3.eu-central-1.petabox.io"
|
||||
- Europe (Frankfurt)
|
||||
- "s3.ap-southeast-1.petabox.io"
|
||||
- Asia Pacific (Singapore)
|
||||
- "s3.me-south-1.petabox.io"
|
||||
- Middle East (Bahrain)
|
||||
- "s3.sa-east-1.petabox.io"
|
||||
- South America (São Paulo)
|
||||
|
||||
#### --s3-endpoint
|
||||
|
||||
Endpoint for Liara Object Storage API.
|
||||
|
||||
Properties:
|
||||
@ -1480,6 +1535,21 @@ Properties:
|
||||
|
||||
#### --s3-endpoint
|
||||
|
||||
Endpoint for Google Cloud Storage.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: endpoint
|
||||
- Env Var: RCLONE_S3_ENDPOINT
|
||||
- Provider: GCS
|
||||
- Type: string
|
||||
- Required: false
|
||||
- Examples:
|
||||
- "https://storage.googleapis.com"
|
||||
- Google Cloud Storage endpoint
|
||||
|
||||
#### --s3-endpoint
|
||||
|
||||
Endpoint for Storj Gateway.
|
||||
|
||||
Properties:
|
||||
@ -1632,7 +1702,7 @@ Properties:
|
||||
|
||||
- Config: endpoint
|
||||
- Env Var: RCLONE_S3_ENDPOINT
|
||||
- Provider: !AWS,IBMCOS,IDrive,IONOS,TencentCOS,HuaweiOBS,Alibaba,ChinaMobile,Liara,ArvanCloud,Scaleway,StackPath,Storj,RackCorp,Qiniu
|
||||
- Provider: !AWS,ArvanCloud,IBMCOS,IDrive,IONOS,TencentCOS,HuaweiOBS,Alibaba,ChinaMobile,GCS,Liara,Scaleway,StackPath,Storj,RackCorp,Qiniu,Petabox
|
||||
- Type: string
|
||||
- Required: false
|
||||
- Examples:
|
||||
@ -1686,8 +1756,10 @@ Properties:
|
||||
- Wasabi AP Southeast 2 (Sydney)
|
||||
- "storage.iran.liara.space"
|
||||
- Liara Iran endpoint
|
||||
- "s3.ir-thr-at1.arvanstorage.com"
|
||||
- ArvanCloud Tehran Iran (Asiatech) endpoint
|
||||
- "s3.ir-thr-at1.arvanstorage.ir"
|
||||
- ArvanCloud Tehran Iran (Simin) endpoint
|
||||
- "s3.ir-tbz-sh1.arvanstorage.ir"
|
||||
- ArvanCloud Tabriz Iran (Shahriar) endpoint
|
||||
|
||||
#### --s3-location-constraint
|
||||
|
||||
@ -1844,7 +1916,7 @@ Properties:
|
||||
- Required: false
|
||||
- Examples:
|
||||
- "ir-thr-at1"
|
||||
- Tehran Iran (Asiatech)
|
||||
- Tehran Iran (Simin)
|
||||
- "ir-tbz-sh1"
|
||||
- Tabriz Iran (Shahriar)
|
||||
|
||||
@ -2018,7 +2090,7 @@ Properties:
|
||||
|
||||
- Config: location_constraint
|
||||
- Env Var: RCLONE_S3_LOCATION_CONSTRAINT
|
||||
- Provider: !AWS,Alibaba,HuaweiOBS,ChinaMobile,Cloudflare,IBMCOS,IDrive,IONOS,Liara,ArvanCloud,Qiniu,RackCorp,Scaleway,StackPath,Storj,TencentCOS
|
||||
- Provider: !AWS,Alibaba,ArvanCloud,HuaweiOBS,ChinaMobile,Cloudflare,IBMCOS,IDrive,IONOS,Liara,Qiniu,RackCorp,Scaleway,StackPath,Storj,TencentCOS,Petabox
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
@ -2263,9 +2335,15 @@ Properties:
|
||||
- "STANDARD"
|
||||
- The Standard class for any upload.
|
||||
- Suitable for on-demand content like streaming or CDN.
|
||||
- Available in all regions.
|
||||
- "GLACIER"
|
||||
- Archived storage.
|
||||
- Prices are lower, but it needs to be restored first to be accessed.
|
||||
- Available in FR-PAR and NL-AMS regions.
|
||||
- "ONEZONE_IA"
|
||||
- One Zone - Infrequent Access.
|
||||
- A good choice for storing secondary backup copies or easily re-creatable data.
|
||||
- Available in the FR-PAR region only.
|
||||
|
||||
#### --s3-storage-class
|
||||
|
||||
@ -2290,7 +2368,7 @@ Properties:
|
||||
|
||||
### Advanced options
|
||||
|
||||
Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, IDrive e2, IONOS Cloud, Liara, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS, Qiniu and Wasabi).
|
||||
Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, China Mobile, Cloudflare, GCS, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, IDrive e2, IONOS Cloud, Liara, Lyve Cloud, Minio, Netease, Petabox, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS, Qiniu and Wasabi).
|
||||
|
||||
#### --s3-bucket-acl
|
||||
|
||||
@ -2843,6 +2921,21 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
|
||||
#### --s3-directory-markers
|
||||
|
||||
Upload an empty object with a trailing slash when a new directory is created
|
||||
|
||||
Empty folders are unsupported for bucket based remotes, this option creates an empty
|
||||
object ending with "/", to persist the folder.
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: directory_markers
|
||||
- Env Var: RCLONE_S3_DIRECTORY_MARKERS
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --s3-use-multipart-etag
|
||||
|
||||
Whether to use ETag in multipart uploads for verification
|
||||
@ -2958,6 +3051,30 @@ Properties:
|
||||
- Type: Tristate
|
||||
- Default: unset
|
||||
|
||||
#### --s3-use-accept-encoding-gzip
|
||||
|
||||
Whether to send `Accept-Encoding: gzip` header.
|
||||
|
||||
By default, rclone will append `Accept-Encoding: gzip` to the request to download
|
||||
compressed objects whenever possible.
|
||||
|
||||
However some providers such as Google Cloud Storage may alter the HTTP headers, breaking
|
||||
the signature of the request.
|
||||
|
||||
A symptom of this would be receiving errors like
|
||||
|
||||
SignatureDoesNotMatch: The request signature we calculated does not match the signature you provided.
|
||||
|
||||
In this case, you might want to try disabling this option.
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: use_accept_encoding_gzip
|
||||
- Env Var: RCLONE_S3_USE_ACCEPT_ENCODING_GZIP
|
||||
- Type: Tristate
|
||||
- Default: unset
|
||||
|
||||
#### --s3-no-system-metadata
|
||||
|
||||
Suppress setting and reading of system metadata
|
||||
@ -3029,7 +3146,7 @@ to normal storage.
|
||||
|
||||
Usage Examples:
|
||||
|
||||
rclone backend restore s3:bucket/path/to/ --include /object [-o priority=PRIORITY] [-o lifetime=DAYS]
|
||||
rclone backend restore s3:bucket/path/to/object [-o priority=PRIORITY] [-o lifetime=DAYS]
|
||||
rclone backend restore s3:bucket/path/to/directory [-o priority=PRIORITY] [-o lifetime=DAYS]
|
||||
rclone backend restore s3:bucket [-o priority=PRIORITY] [-o lifetime=DAYS]
|
||||
|
||||
|
||||
@ -850,7 +850,7 @@ Pass multiple variables space separated, eg
|
||||
|
||||
VAR1=value VAR2=value
|
||||
|
||||
and pass variables with spaces in in quotes, eg
|
||||
and pass variables with spaces in quotes, eg
|
||||
|
||||
"VAR3=value with space" "VAR4=value with space" VAR5=nospacehere
|
||||
|
||||
@ -921,6 +921,26 @@ Properties:
|
||||
- Type: SpaceSepList
|
||||
- Default:
|
||||
|
||||
#### --sftp-host-key-algorithms
|
||||
|
||||
Space separated list of host key algorithms, ordered by preference.
|
||||
|
||||
At least one must match with server configuration. This can be checked for example using ssh -Q HostKeyAlgorithms.
|
||||
|
||||
Note: This can affect the outcome of key negotiation with the server even if server host key validation is not enabled.
|
||||
|
||||
Example:
|
||||
|
||||
ssh-ed25519 ssh-rsa ssh-dss
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: host_key_algorithms
|
||||
- Env Var: RCLONE_SFTP_HOST_KEY_ALGORITHMS
|
||||
- Type: SpaceSepList
|
||||
- Default:
|
||||
|
||||
{{< rem autogenerated options stop >}}
|
||||
|
||||
## Limitations
|
||||
|
||||
@ -315,6 +315,7 @@ Properties:
|
||||
- OVH
|
||||
- "https://authenticate.ain.net"
|
||||
- Blomp Cloud Storage
|
||||
|
||||
#### --swift-user-id
|
||||
|
||||
User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID).
|
||||
@ -490,7 +491,7 @@ Properties:
|
||||
|
||||
### Advanced options
|
||||
|
||||
Here are the Advanced options specific to swift (OpenStack Swift (Rackspace Cloud Files, Blomp Cloud Storage , Memset Memstore, OVH)).
|
||||
Here are the Advanced options specific to swift (OpenStack Swift (Rackspace Cloud Files, Blomp Cloud Storage, Memset Memstore, OVH)).
|
||||
|
||||
#### --swift-leave-parts-on-error
|
||||
|
||||
|
||||
@ -122,6 +122,17 @@ Properties:
|
||||
|
||||
Here are the Advanced options specific to uptobox (Uptobox).
|
||||
|
||||
#### --uptobox-private
|
||||
|
||||
Set to make uploaded files private
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: private
|
||||
- Env Var: RCLONE_UPTOBOX_PRIVATE
|
||||
- Type: bool
|
||||
- Default: false
|
||||
|
||||
#### --uptobox-encoding
|
||||
|
||||
The encoding for the backend.
|
||||
|
||||
@ -139,6 +139,8 @@ Properties:
|
||||
- Type: string
|
||||
- Required: false
|
||||
- Examples:
|
||||
- "fastmail"
|
||||
- Fastmail Files
|
||||
- "nextcloud"
|
||||
- Nextcloud
|
||||
- "owncloud"
|
||||
@ -238,6 +240,34 @@ Properties:
|
||||
- Type: CommaSepList
|
||||
- Default:
|
||||
|
||||
#### --webdav-pacer-min-sleep
|
||||
|
||||
Minimum time to sleep between API calls.
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: pacer_min_sleep
|
||||
- Env Var: RCLONE_WEBDAV_PACER_MIN_SLEEP
|
||||
- Type: Duration
|
||||
- Default: 10ms
|
||||
|
||||
#### --webdav-nextcloud-chunk-size
|
||||
|
||||
Nextcloud upload chunk size.
|
||||
|
||||
We recommend configuring your NextCloud instance to increase the max chunk size to 1 GB for better upload performances.
|
||||
See https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/big_file_upload_configuration.html#adjust-chunk-size-on-nextcloud-side
|
||||
|
||||
Set to 0 to disable chunked uploading.
|
||||
|
||||
|
||||
Properties:
|
||||
|
||||
- Config: nextcloud_chunk_size
|
||||
- Env Var: RCLONE_WEBDAV_NEXTCLOUD_CHUNK_SIZE
|
||||
- Type: SizeSuffix
|
||||
- Default: 10Mi
|
||||
|
||||
{{< rem autogenerated options stop >}}
|
||||
|
||||
## Provider notes
|
||||
|
||||
10
go.sum
10
go.sum
@ -39,24 +39,16 @@ cloud.google.com/go/storage v1.6.0/go.mod h1:N7U0C8pVQ/+NIKOBQyamJIeKQKkZ+mxpohl
|
||||
cloud.google.com/go/storage v1.8.0/go.mod h1:Wv1Oy7z6Yz3DshWRJFhqM/UCfaWIRTdp0RXyy7KQOVs=
|
||||
cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9ullr3+Kg0=
|
||||
dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.4.0 h1:rTnT/Jrcm+figWlYz4Ixzt0SJVR2cMC8lvZcimipiEY=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.4.0/go.mod h1:ON4tFdPTwRcgWEaVDrN3584Ef+b7GgSJaXxe5fW9t4M=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.6.0 h1:8kDqDngH+DmVBiCtIjCFTGa7MBnsIOkF9IccInFEbjk=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.6.0/go.mod h1:bjGvMhVMb+EEm3VRNQawDMUyMMjo+S5ewNjflkep/0Q=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.2.2 h1:uqM+VoHjVH6zdlkLF2b6O0ZANcHoj3rO0PoQ3jglUJA=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.2.2/go.mod h1:twTKAa1E6hLmSDjLhaCkbTMQKc7p/rNLU40rLxGEOCI=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.3.0 h1:vcYCAze6p19qBW7MhZybIsqD8sMV8js0NyQM8JDnVtg=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.3.0/go.mod h1:OQeznEEkTZ9OrhHJoDD8ZDq51FHgXjqtP9z6bEwBq9U=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/internal v1.2.0 h1:leh5DwKv6Ihwi+h60uHtn6UWAxBbZ0q8DwQVMzf61zw=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/internal v1.2.0/go.mod h1:eWRD7oawr1Mu1sLCawqVc0CUiF43ia3qQMxLscsKQ9w=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/internal v1.3.0 h1:sXr+ck84g/ZlZUOZiNELInmMgOsuGwdjjVkEIde0OtY=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/internal v1.3.0/go.mod h1:okt5dMMTOFjX/aovMlrjvvXoPMBVSPzk9185BT0+eZM=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/storage/azblob v1.0.0 h1:u/LLAOFgsMv7HmNL4Qufg58y+qElGOt5qv0z1mURkRY=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/storage/azblob v1.0.0/go.mod h1:2e8rMJtl2+2j+HXbTBwnyGpm5Nou7KhvSfxOq8JpTag=
|
||||
github.com/Azure/go-ntlmssp v0.0.0-20221128193559-754e69321358 h1:mFRzDkZVAjdal+s7s0MwaRv9igoPqLRdzOLzw/8Xvq8=
|
||||
github.com/Azure/go-ntlmssp v0.0.0-20221128193559-754e69321358/go.mod h1:chxPXzSsl7ZWRAuOIE23GDNzjWuZquvFlgA8xmpunjU=
|
||||
github.com/AzureAD/microsoft-authentication-library-for-go v0.9.0 h1:UE9n9rkJF62ArLb1F3DEjRt8O3jLwMWdSoypKV4f3MU=
|
||||
github.com/AzureAD/microsoft-authentication-library-for-go v0.9.0/go.mod h1:kgDmCTgBzIEPFElEF+FK0SdjAor06dRq2Go927dnQ6o=
|
||||
github.com/AzureAD/microsoft-authentication-library-for-go v1.0.0 h1:OBhqkivkhkMqLPymWEppkm7vgPQY2XsHoEkaMQ0AdZY=
|
||||
github.com/AzureAD/microsoft-authentication-library-for-go v1.0.0/go.mod h1:kgDmCTgBzIEPFElEF+FK0SdjAor06dRq2Go927dnQ6o=
|
||||
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
|
||||
@ -131,7 +123,7 @@ github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ3
|
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/dnaeon/go-vcr v1.1.0 h1:ReYa/UBrRyQdant9B4fNHGoCNKw6qh6P0fsdGmZpR7c=
|
||||
github.com/dnaeon/go-vcr v1.2.0 h1:zHCHvJYTMh1N7xnV7zf1m1GPBF9Ad0Jk/whtQ1663qI=
|
||||
github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815/go.mod h1:WwZ+bS3ebgob9U8Nd0kOddGdZWjyMGR8Wziv+TBNwSE=
|
||||
github.com/dop251/scsu v0.0.0-20220106150536-84ac88021d00 h1:xJBhC00smQpSZw3Kr0ErMUBXhUSjYoLRm2szxdbRBL0=
|
||||
github.com/dop251/scsu v0.0.0-20220106150536-84ac88021d00/go.mod h1:nNICngOdmNImBb/vuL+dSc0aIg3ryNATpjxThNoPw4g=
|
||||
|
||||
Loading…
Reference in New Issue
Block a user