From 36f6a3fa1a46ee21bc541ecb0c795b32a91b9f95 Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Tue, 20 Jan 2026 17:41:37 +0000 Subject: [PATCH] docs: build overview page from the backend data --- docs/content/overview.md | 169 +----------------- docs/layouts/partials/bool.html | 6 + docs/layouts/shortcodes/features-table.html | 120 +++++++++++++ .../shortcodes/optional-features-table.html | 40 +++++ 4 files changed, 168 insertions(+), 167 deletions(-) create mode 100644 docs/layouts/partials/bool.html create mode 100644 docs/layouts/shortcodes/features-table.html create mode 100644 docs/layouts/shortcodes/optional-features-table.html diff --git a/docs/content/overview.md b/docs/content/overview.md index 2e4334e4e..7d2a3ac20 100644 --- a/docs/content/overview.md +++ b/docs/content/overview.md @@ -14,105 +14,7 @@ show through. Here is an overview of the major features of each cloud storage system. -| Name | Hash | ModTime | Case Insensitive | Duplicate Files | MIME Type | Metadata | -| ---------------------------- |:-----------------:|:-------:|:----------------:|:---------------:|:---------:|:--------:| -| 1Fichier | Whirlpool | - | No | Yes | R | - | -| Akamai Netstorage | MD5, SHA256 | R/W | No | No | R | - | -| Amazon S3 (or S3 compatible) | MD5 | R/W | No | No | R/W | RWU | -| Backblaze B2 | SHA1 | R/W | No | No | R/W | - | -| Box | SHA1 | R/W | Yes | No | - | - | -| Citrix ShareFile | MD5 | R/W | Yes | No | - | - | -| Cloudinary | MD5 | R | No | Yes | - | - | -| Drime | - | - | No | No | R/W | - | -| Dropbox | DBHASH ¹ | R | Yes | No | - | - | -| Enterprise File Fabric | - | R/W | Yes | No | R/W | - | -| FileLu Cloud Storage | MD5 | R/W | No | Yes | R | - | -| Filen | Blake3 | R/W | Yes | No | R/W | - | -| Files.com | MD5, CRC32 | DR/W | Yes | No | R | - | -| FTP | - | R/W ¹⁰ | No | No | - | - | -| Gofile | MD5 | DR/W | No | Yes | R | - | -| Google Cloud Storage | MD5 | R/W | No | No | R/W | - | -| Google Drive | MD5, SHA1, SHA256 | DR/W | No | Yes | R/W | DRWU | -| Google Photos | - | - | No | Yes | R | - | -| HDFS | - | R/W | No | No | - | - | -| HiDrive | HiDrive ¹² | R/W | No | No | - | - | -| HTTP | - | R | No | No | R | R | -| iCloud Drive | - | R | No | No | - | - | -| Internet Archive | MD5, SHA1, CRC32 | R/W ¹¹ | No | No | - | RWU | -| Jottacloud | MD5 | R/W | Yes | No | R | RW | -| Koofr | MD5 | - | Yes | No | - | - | -| Linkbox | - | R | No | No | - | - | -| Mail.ru Cloud | Mailru ⁶ | R/W | Yes | No | - | - | -| Mega | - | - | No | Yes | - | - | -| Memory | MD5 | R/W | No | No | - | - | -| Microsoft Azure Blob Storage | MD5 | R/W | No | No | R/W | - | -| Microsoft Azure Files Storage | MD5 | R/W | Yes | No | R/W | - | -| Microsoft OneDrive | QuickXorHash ⁵ | DR/W | Yes | No | R | DRW | -| OpenDrive | MD5 | R/W | Yes | Partial ⁸ | - | - | -| OpenStack Swift | MD5 | R/W | No | No | R/W | - | -| Oracle Object Storage | MD5 | R/W | No | No | R/W | RU | -| pCloud | MD5, SHA1 ⁷ | R/W | No | No | W | - | -| PikPak | MD5 | R | No | No | R | - | -| Pixeldrain | SHA256 | R/W | No | No | R | RW | -| premiumize.me | - | - | Yes | No | R | - | -| put.io | CRC-32 | R/W | No | Yes | R | - | -| Proton Drive | SHA1 | R/W | No | No | R | - | -| QingStor | MD5 | - ⁹ | No | No | R/W | - | -| Quatrix by Maytech | - | R/W | No | No | - | - | -| Seafile | - | - | No | No | - | - | -| SFTP | MD5, SHA1 ² | DR/W | Depends | No | - | - | -| Shade | - | - | Yes | No | - | - | -| Sia | - | - | No | No | - | - | -| SMB | - | R/W | Yes | No | - | - | -| SugarSync | - | - | No | No | - | - | -| Storj | - | R | No | No | - | - | -| Uloz.to | MD5, SHA256 ¹³ | - | No | Yes | - | - | -| WebDAV | MD5, SHA1 ³ | R ⁴ | Depends | No | - | - | -| Yandex Disk | MD5 | R/W | No | No | R | - | -| Zoho WorkDrive | - | - | No | No | - | - | -| The local filesystem | All | DR/W | Depends | No | - | DRWU | - -¹ Dropbox supports [its own custom -hash](https://www.dropbox.com/developers/reference/content-hash). -This is an SHA256 sum of all the 4 MiB block SHA256s. - -² SFTP supports checksums if the same login has shell access and -`md5sum` or `sha1sum` as well as `echo` are in the remote's PATH. - -³ WebDAV supports hashes when used with Fastmail Files, Owncloud and Nextcloud only. - -⁴ WebDAV supports modtimes when used with Fastmail Files, Owncloud and Nextcloud -only. - -⁵ [QuickXorHash](https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash) -is Microsoft's own hash. - -⁶ Mail.ru uses its own modified SHA1 hash - -⁷ pCloud only supports SHA1 (not MD5) in its EU region - -⁸ Opendrive does not support creation of duplicate files using -their web client interface or other stock clients, but the underlying -storage platform has been determined to allow duplicate files, and it -is possible to create them with `rclone`. It may be that this is a -mistake or an unsupported feature. - -⁹ QingStor does not support SetModTime for objects bigger than 5 GiB. - -¹⁰ FTP supports modtimes for the major FTP servers, and also others -if they advertised required protocol extensions. See [this](/ftp/#modification-times) -for more details. - -¹¹ Internet Archive requires option `wait_archive` to be set to a non-zero value -for full modtime support. - -¹² HiDrive supports [its own custom -hash](https://static.hidrive.com/dev/0001). -It combines SHA1 sums for each 4 KiB block hierarchically to a single -top-level sum. - -¹³ Uloz.to provides server-calculated MD5 hash upon file upload. MD5 and SHA256 -hashes are client-calculated and stored as metadata fields. +{{< features-table >}} ### Hash @@ -508,74 +410,7 @@ See [the metadata docs](/docs/#metadata) for more info. All rclone remotes support a base command set. Other features depend upon backend-specific capabilities. -| Name | Purge | Copy | Move | DirMove | CleanUp | ListR | StreamUpload | MultithreadUpload | LinkSharing | About | EmptyDir | -| ---------------------------- |:-----:|:----:|:----:|:-------:|:-------:|:-----:|:------------:|:------------------|:------------:|:-----:|:--------:| -| 1Fichier | No | Yes | Yes | No | No | No | No | No | Yes | No | Yes | -| Akamai Netstorage | Yes | No | No | No | No | Yes | Yes | No | No | No | Yes | -| Amazon S3 (or S3 compatible) | No | Yes | No | No | Yes | Yes | Yes | Yes | Yes | No | No | -| Backblaze B2 | No | Yes | No | No | Yes | Yes | Yes | Yes | Yes | No | No | -| Box | Yes | Yes | Yes | Yes | Yes | No | Yes | No | Yes | Yes | Yes | -| Citrix ShareFile | Yes | Yes | Yes | Yes | No | No | No | No | No | No | Yes | -| Drime | Yes | Yes | Yes | Yes | No | No | Yes | Yes | No | No | Yes | -| Dropbox | Yes | Yes | Yes | Yes | No | No | Yes | No | Yes | Yes | Yes | -| Cloudinary | No | No | No | No | No | No | Yes | No | No | No | No | -| Enterprise File Fabric | Yes | Yes | Yes | Yes | Yes | No | No | No | No | No | Yes | -| Filen | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | -| Files.com | Yes | Yes | Yes | Yes | No | No | Yes | No | Yes | No | Yes | -| FTP | No | No | Yes | Yes | No | No | Yes | No | No | No | Yes | -| Gofile | Yes | Yes | Yes | Yes | No | No | Yes | No | Yes | Yes | Yes | -| Google Cloud Storage | Yes | Yes | No | No | No | No | Yes | No | No | No | No | -| Google Drive | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | -| Google Photos | No | No | No | No | No | No | No | No | No | No | No | -| HDFS | Yes | No | Yes | Yes | No | No | Yes | No | No | Yes | Yes | -| HiDrive | Yes | Yes | Yes | Yes | No | No | Yes | No | No | No | Yes | -| HTTP | No | No | No | No | No | No | No | No | No | No | Yes | -| iCloud Drive | Yes | Yes | Yes | Yes | No | No | No | No | No | No | Yes | -| ImageKit | Yes | No | Yes | No | No | No | No | No | No | No | Yes | -| Internet Archive | No | Yes | No | No | Yes | Yes | No | No | Yes | Yes | No | -| Jottacloud | Yes | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | -| Koofr | Yes | Yes | Yes | Yes | No | No | Yes | No | Yes | Yes | Yes | -| Mail.ru Cloud | Yes | Yes | Yes | Yes | Yes | No | No | No | Yes | Yes | Yes | -| Mega | Yes | No | Yes | Yes | Yes | No | No | No | Yes | Yes | Yes | -| Memory | No | Yes | No | No | No | Yes | Yes | No | No | No | No | -| Microsoft Azure Blob Storage | Yes | Yes | No | No | No | Yes | Yes | Yes | No | No | No | -| Microsoft Azure Files Storage | No | Yes | Yes | Yes | No | No | Yes | Yes | No | Yes | Yes | -| Microsoft OneDrive | Yes | Yes | Yes | Yes | Yes | Yes ⁵ | No | No | Yes | Yes | Yes | -| OpenDrive | Yes | Yes | Yes | Yes | No | No | No | No | No | Yes | Yes | -| OpenStack Swift | Yes ¹ | Yes | No | No | No | Yes | Yes | No | No | Yes | No | -| Oracle Object Storage | No | Yes | No | No | Yes | Yes | Yes | Yes | No | No | No | -| pCloud | Yes | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | -| PikPak | Yes | Yes | Yes | Yes | Yes | No | No | No | Yes | Yes | Yes | -| Pixeldrain | Yes | No | Yes | Yes | No | No | Yes | No | Yes | Yes | Yes | -| premiumize.me | Yes | No | Yes | Yes | No | No | No | No | Yes | Yes | Yes | -| put.io | Yes | No | Yes | Yes | Yes | No | Yes | No | No | Yes | Yes | -| Proton Drive | Yes | No | Yes | Yes | Yes | No | No | No | No | Yes | Yes | -| QingStor | No | Yes | No | No | Yes | Yes | No | No | No | No | No | -| Quatrix by Maytech | Yes | Yes | Yes | Yes | No | No | No | No | No | Yes | Yes | -| Seafile | Yes | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | -| SFTP | No | Yes ⁴| Yes | Yes | No | No | Yes | No | No | Yes | Yes | -| Sia | No | No | No | No | No | No | Yes | No | No | No | Yes | -| SMB | No | No | Yes | Yes | No | No | Yes | Yes | No | No | Yes | -| SugarSync | Yes | Yes | Yes | Yes | No | No | Yes | No | Yes | No | Yes | -| Storj | Yes ² | Yes | Yes | No | No | Yes | Yes | No | Yes | No | No | -| Uloz.to | No | No | Yes | Yes | No | No | No | No | No | No | Yes | -| WebDAV | Yes | Yes | Yes | Yes | No | No | Yes ³ | No | No | Yes | Yes | -| Yandex Disk | Yes | Yes | Yes | Yes | Yes | No | Yes | No | Yes | Yes | Yes | -| Zoho WorkDrive | Yes | Yes | Yes | Yes | No | No | No | No | No | Yes | Yes | -| The local filesystem | No | No | Yes | Yes | No | No | Yes | Yes | No | Yes | Yes | - -¹ Note Swift implements this in order to delete directory markers but -it doesn't actually have a quicker way of deleting files other than -deleting them individually. - -² Storj implements this efficiently only for entire buckets. If -purging a directory inside a bucket, files are deleted individually. - -³ StreamUpload is not supported with Nextcloud - -⁴ Use the `--sftp-copy-is-hardlink` flag to enable. - -⁵ Use the `--onedrive-delta` flag to enable. +{{< optional-features-table >}} ### Purge diff --git a/docs/layouts/partials/bool.html b/docs/layouts/partials/bool.html new file mode 100644 index 000000000..0dc9b311b --- /dev/null +++ b/docs/layouts/partials/bool.html @@ -0,0 +1,6 @@ +{{ if . }} + ✔ +{{ else }} + ✖ +{{ end }} + diff --git a/docs/layouts/shortcodes/features-table.html b/docs/layouts/shortcodes/features-table.html new file mode 100644 index 000000000..494fe9271 --- /dev/null +++ b/docs/layouts/shortcodes/features-table.html @@ -0,0 +1,120 @@ + + + + + + + + + + + + + + + {{ range sort site.Data.backends "name" "asc" }} + {{ if .virtual }}{{ continue }} {{ end }} + + + + {{/* Tier Column */}} + + + {{/* Hash Column */}} + + + {{/* ModTime */}} + + + {{/* Case Insensitive */}} + + + {{/* Duplicate Files */}} + + + {{/* MIME Type Synthesis */}} + + + {{/* Metadata Synthesis */}} + + + + {{ end }} + +
NameTierHashModTimeCase InsensitiveDuplicate FilesMIME TypeMetadata
+ {{ .name }} + + {{ partial "tier.html" (dict "name" .backend "align" false) }} + + {{ $local := in .features "IsLocal" }} + {{ if $local }} + ALL + {{ else }} + {{ with .hashes }} + {{ delimit . ", " }} + {{ else }} + - + {{ end }} + {{ end }} + + {{ $d := or (in .features "MkdirMetadata") (in .features "DirSetModTime") }} + {{ $r := true }} {{/* FIXME don't have a way of reading this from the features */}} + {{ $w := and (isset . "precision") (le .precision 1000000000) }} + {{- if $d -}} + D + {{- end -}} + {{ if and $r $w -}} + R/W + {{- else if $r -}} + R + {{- else if $w -}} + W + {{- else -}} + - + {{- end -}} + + {{ partial "bool.html" (in .features "CaseInsensitive") }} + + {{ partial "bool.html" (in .features "DuplicateFiles") }} + + {{ $r := in .features "ReadMimeType" }} + {{ $w := in .features "WriteMimeType" }} + {{ if and $r $w }} + R/W + {{ else if $r }} + R + {{ else if $w }} + W + {{ else }} + - + {{ end }} + + {{ $meta := "" }} + + {{/* Check Directory Metadata Support */}} + {{ if or (in .features "ReadDirMetadata") (in .features "WriteDirMetadata") }} + {{ $meta = "D" }} + {{ end }} + + {{/* Check System Metadata Read */}} + {{ if in .features "ReadMetadata" }} + {{ $meta = print $meta "R" }} + {{ end }} + + {{/* Check System Metadata Write */}} + {{ if in .features "WriteMetadata" }} + {{ $meta = print $meta "W" }} + {{ end }} + + {{/* Check User Metadata Support */}} + {{ if in .features "UserMetadata" }} + {{ $meta = print $meta "U" }} + {{ end }} + + {{/* Output result or hyphen if empty */}} + {{ if eq $meta "" }} + - + {{ else }} + {{ $meta }} + {{ end }} +
diff --git a/docs/layouts/shortcodes/optional-features-table.html b/docs/layouts/shortcodes/optional-features-table.html new file mode 100644 index 000000000..61de1ba38 --- /dev/null +++ b/docs/layouts/shortcodes/optional-features-table.html @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + + {{ range sort site.Data.backends "name" "asc" }} + {{ if .virtual }}{{ continue }} {{ end }} + + + + + + + + + + + + + + + + {{ end }} + +
NamePurgeCopyMoveDirMoveCleanUpListRStreamUploadMultithreadUploadLinkSharingAboutEmptyDir
+ {{ .name }} + {{ partial "bool.html" (in .features "Purge") }}{{ partial "bool.html" (in .features "Copy") }}{{ partial "bool.html" (in .features "Move") }}{{ partial "bool.html" (in .features "DirMove") }}{{ partial "bool.html" (in .features "CleanUp") }}{{ partial "bool.html" (in .features "ListR") }}{{ partial "bool.html" (in .features "PutStream") }}{{ partial "bool.html" (or (in .features "OpenChunkWriter") (in .features "OpenWriterAt")) }}{{ partial "bool.html" (in .features "PublicLink") }}{{ partial "bool.html" (in .features "About") }}{{ partial "bool.html" (in .features "CanHaveEmptyDirectories") }}