Skip to content

Commit

Permalink
Version v1.57.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ncw committed Nov 1, 2021
1 parent e781bcb commit 169990e
Show file tree
Hide file tree
Showing 96 changed files with 19,769 additions and 11,241 deletions.
5,811 changes: 3,508 additions & 2,303 deletions MANUAL.html

Large diffs are not rendered by default.

6,613 changes: 4,264 additions & 2,349 deletions MANUAL.md

Large diffs are not rendered by default.

7,008 changes: 4,540 additions & 2,468 deletions MANUAL.txt

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions bin/make_manual.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
"googlecloudstorage.md",
"drive.md",
"googlephotos.md",
"hasher.md",
"hdfs.md",
"http.md",
"hubic.md",
Expand All @@ -55,6 +56,7 @@
"onedrive.md",
"opendrive.md",
"qingstor.md",
"sia.md",
"swift.md",
"pcloud.md",
"premiumizeme.md",
Expand Down
3 changes: 2 additions & 1 deletion docs/content/alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,14 @@ Copy another local directory to the alias directory called source
rclone copy /home/source remote:source

{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/alias/alias.go then run make backenddocs" >}}
### Standard Options
### Standard options

Here are the standard options specific to alias (Alias for an existing remote).

#### --alias-remote

Remote or path to alias.

Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path".

- Config: remote
Expand Down
14 changes: 9 additions & 5 deletions docs/content/amazonclouddrive.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,13 +158,14 @@ rclone it will take you to an `amazon.com` page to log in. Your
`amazon.co.uk` email and password should work here just fine.

{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/amazonclouddrive/amazonclouddrive.go then run make backenddocs" >}}
### Standard Options
### Standard options

Here are the standard options specific to amazon cloud drive (Amazon Drive).

#### --acd-client-id

OAuth Client Id
OAuth Client Id.

Leave blank normally.

- Config: client_id
Expand All @@ -174,15 +175,16 @@ Leave blank normally.

#### --acd-client-secret

OAuth Client Secret
OAuth Client Secret.

Leave blank normally.

- Config: client_secret
- Env Var: RCLONE_ACD_CLIENT_SECRET
- Type: string
- Default: ""

### Advanced Options
### Advanced options

Here are the advanced options specific to amazon cloud drive (Amazon Drive).

Expand All @@ -198,6 +200,7 @@ OAuth Access Token as a JSON blob.
#### --acd-auth-url

Auth server URL.

Leave blank to use the provider defaults.

- Config: auth_url
Expand All @@ -208,6 +211,7 @@ Leave blank to use the provider defaults.
#### --acd-token-url

Token server url.

Leave blank to use the provider defaults.

- Config: token_url
Expand Down Expand Up @@ -275,7 +279,7 @@ underlying S3 storage.

This sets the encoding for the backend.

See: the [encoding section in the overview](/overview/#encoding) for more info.
See the [encoding section in the overview](/overview/#encoding) for more info.

- Config: encoding
- Env Var: RCLONE_ACD_ENCODING
Expand Down
57 changes: 41 additions & 16 deletions docs/content/azureblob.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,13 +148,15 @@ parties access to a single container or putting credentials into an
untrusted environment such as a CI build server.

{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/azureblob/azureblob.go then run make backenddocs" >}}
### Standard Options
### Standard options

Here are the standard options specific to azureblob (Microsoft Azure Blob Storage).

#### --azureblob-account

Storage Account Name (leave blank to use SAS URL or Emulator)
Storage Account Name.

Leave blank to use SAS URL or Emulator.

- Config: account
- Env Var: RCLONE_AZUREBLOB_ACCOUNT
Expand Down Expand Up @@ -182,7 +184,9 @@ See ["Create an Azure service principal"](https://docs.microsoft.com/en-us/cli/a

#### --azureblob-key

Storage Account Key (leave blank to use SAS URL or Emulator)
Storage Account Key.

Leave blank to use SAS URL or Emulator.

- Config: key
- Env Var: RCLONE_AZUREBLOB_KEY
Expand All @@ -191,8 +195,9 @@ Storage Account Key (leave blank to use SAS URL or Emulator)

#### --azureblob-sas-url

SAS URL for container level access only
(leave blank if using account/key or Emulator)
SAS URL for container level access only.

Leave blank if using account/key or Emulator.

- Config: sas_url
- Env Var: RCLONE_AZUREBLOB_SAS_URL
Expand All @@ -201,7 +206,7 @@ SAS URL for container level access only

#### --azureblob-use-msi

Use a managed service identity to authenticate (only works in Azure)
Use a managed service identity to authenticate (only works in Azure).

When true, use a [managed service identity](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/)
to authenticate to Azure Storage instead of a SAS token or account key.
Expand All @@ -219,20 +224,24 @@ msi_client_id, or msi_mi_res_id parameters.

#### --azureblob-use-emulator

Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint)
Uses local storage emulator if provided as 'true'.

Leave blank if using real azure storage endpoint.

- Config: use_emulator
- Env Var: RCLONE_AZUREBLOB_USE_EMULATOR
- Type: bool
- Default: false

### Advanced Options
### Advanced options

Here are the advanced options specific to azureblob (Microsoft Azure Blob Storage).

#### --azureblob-msi-object-id

Object ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_mi_res_id specified.
Object ID of the user-assigned MSI to use, if any.

Leave blank if msi_client_id or msi_mi_res_id specified.

- Config: msi_object_id
- Env Var: RCLONE_AZUREBLOB_MSI_OBJECT_ID
Expand All @@ -241,7 +250,9 @@ Object ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id

#### --azureblob-msi-client-id

Object ID of the user-assigned MSI to use, if any. Leave blank if msi_object_id or msi_mi_res_id specified.
Object ID of the user-assigned MSI to use, if any.

Leave blank if msi_object_id or msi_mi_res_id specified.

- Config: msi_client_id
- Env Var: RCLONE_AZUREBLOB_MSI_CLIENT_ID
Expand All @@ -250,7 +261,9 @@ Object ID of the user-assigned MSI to use, if any. Leave blank if msi_object_id

#### --azureblob-msi-mi-res-id

Azure resource ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_object_id specified.
Azure resource ID of the user-assigned MSI to use, if any.

Leave blank if msi_client_id or msi_object_id specified.

- Config: msi_mi_res_id
- Env Var: RCLONE_AZUREBLOB_MSI_MI_RES_ID
Expand All @@ -259,7 +272,8 @@ Azure resource ID of the user-assigned MSI to use, if any. Leave blank if msi_cl

#### --azureblob-endpoint

Endpoint for the service
Endpoint for the service.

Leave blank normally.

- Config: endpoint
Expand All @@ -269,7 +283,7 @@ Leave blank normally.

#### --azureblob-upload-cutoff

Cutoff for switching to chunked upload (<= 256 MiB). (Deprecated)
Cutoff for switching to chunked upload (<= 256 MiB) (deprecated).

- Config: upload_cutoff
- Env Var: RCLONE_AZUREBLOB_UPLOAD_CUTOFF
Expand Down Expand Up @@ -364,6 +378,7 @@ to start uploading.
#### --azureblob-memory-pool-flush-time

How often internal memory buffer pools will be flushed.

Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations.
This option controls how often unused buffers will be removed from the pool.

Expand All @@ -385,7 +400,7 @@ Whether to use mmap buffers in internal memory pool.

This sets the encoding for the backend.

See: the [encoding section in the overview](/overview/#encoding) for more info.
See the [encoding section in the overview](/overview/#encoding) for more info.

- Config: encoding
- Env Var: RCLONE_AZUREBLOB_ENCODING
Expand All @@ -394,20 +409,30 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.

#### --azureblob-public-access

Public access level of a container: blob, container.
Public access level of a container: blob or container.

- Config: public_access
- Env Var: RCLONE_AZUREBLOB_PUBLIC_ACCESS
- Type: string
- Default: ""
- Examples:
- ""
- The container and its blobs can be accessed only with an authorized request. It's a default value
- The container and its blobs can be accessed only with an authorized request.
- It's a default value.
- "blob"
- Blob data within this container can be read via anonymous request.
- "container"
- Allow full public read access for container and blob data.

#### --azureblob-no-head-object

If set, do not do HEAD before GET when getting objects.

- Config: no_head_object
- Env Var: RCLONE_AZUREBLOB_NO_HEAD_OBJECT
- Type: bool
- Default: false

{{< rem autogenerated options stop >}}

## Limitations
Expand Down
28 changes: 16 additions & 12 deletions docs/content/b2.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,13 +321,13 @@ https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxx
```

{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/b2/b2.go then run make backenddocs" >}}
### Standard Options
### Standard options

Here are the standard options specific to b2 (Backblaze B2).

#### --b2-account

Account ID or Application Key ID
Account ID or Application Key ID.

- Config: account
- Env Var: RCLONE_B2_ACCOUNT
Expand All @@ -336,7 +336,7 @@ Account ID or Application Key ID

#### --b2-key

Application Key
Application Key.

- Config: key
- Env Var: RCLONE_B2_KEY
Expand All @@ -352,13 +352,14 @@ Permanently delete files on remote removal, otherwise hide files.
- Type: bool
- Default: false

### Advanced Options
### Advanced options

Here are the advanced options specific to b2 (Backblaze B2).

#### --b2-endpoint

Endpoint for the service.

Leave blank normally.

- Config: endpoint
Expand Down Expand Up @@ -388,6 +389,7 @@ in the [b2 integrations checklist](https://www.backblaze.com/b2/docs/integration
#### --b2-versions

Include old versions in directory listings.

Note that when using this no file write operations are permitted,
so you can't upload files or delete them.

Expand All @@ -411,7 +413,7 @@ This value should be set no larger than 4.657 GiB (== 5 GB).

#### --b2-copy-cutoff

Cutoff for switching to multipart copy
Cutoff for switching to multipart copy.

Any files larger than this that need to be server-side copied will be
copied in chunks of this size.
Expand All @@ -425,12 +427,14 @@ The minimum is 0 and the maximum is 4.6 GiB.

#### --b2-chunk-size

Upload chunk size. Must fit in memory.
Upload chunk size.

When uploading large files, chunk the file into this size.

Must fit in memory. These chunks are buffered in memory and there
might a maximum of "--transfers" chunks in progress at once.

When uploading large files, chunk the file into this size. Note that
these chunks are buffered in memory and there might a maximum of
"--transfers" chunks in progress at once. 5,000,000 Bytes is the
minimum size.
5,000,000 Bytes is the minimum size.

- Config: chunk_size
- Env Var: RCLONE_B2_CHUNK_SIZE
Expand All @@ -439,7 +443,7 @@ minimum size.

#### --b2-disable-checksum

Disable checksums for large (> upload cutoff) files
Disable checksums for large (> upload cutoff) files.

Normally rclone will calculate the SHA1 checksum of the input before
uploading it so it can add it to metadata on the object. This is great
Expand Down Expand Up @@ -503,7 +507,7 @@ Whether to use mmap buffers in internal memory pool.

This sets the encoding for the backend.

See: the [encoding section in the overview](/overview/#encoding) for more info.
See the [encoding section in the overview](/overview/#encoding) for more info.

- Config: encoding
- Env Var: RCLONE_B2_ENCODING
Expand Down
Loading

0 comments on commit 169990e

Please sign in to comment.