From cd69f9e6e81c4bfab19b3c01cf1b0f221c6d7188 Mon Sep 17 00:00:00 2001 From: buengese Date: Fri, 9 Apr 2021 16:57:24 +0200 Subject: [PATCH] uptobox: add docs --- bin/make_manual.py | 1 + docs/content/_index.md | 1 + docs/content/docs.md | 1 + docs/content/overview.md | 2 + docs/content/uptobox.md | 141 ++++++++++++++++++++++++++++++++ docs/layouts/chrome/navbar.html | 1 + 6 files changed, 147 insertions(+) create mode 100644 docs/content/uptobox.md diff --git a/bin/make_manual.py b/bin/make_manual.py index ef37f9f97..aeb1eb698 100755 --- a/bin/make_manual.py +++ b/bin/make_manual.py @@ -62,6 +62,7 @@ docs = [ "sftp.md", "sugarsync.md", "tardigrade.md", + "uptobox.md" "union.md", "webdav.md", "yandex.md", diff --git a/docs/content/_index.md b/docs/content/_index.md index 44d0da5b0..2a97ae6c8 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -152,6 +152,7 @@ WebDAV or S3, that work out of the box.) {{< provider name="SugarSync" home="https://sugarsync.com/" config="/sugarsync/" >}} {{< provider name="Tardigrade" home="https://tardigrade.io/" config="/tardigrade/" >}} {{< provider name="Tencent Cloud Object Storage (COS)" home="https://intl.cloud.tencent.com/product/cos" config="/s3/#tencent-cos" >}} +{{< provider name="Uptobox" home="https://uptobox.com" config="/uptobox/" >}} {{< provider name="Wasabi" home="https://wasabi.com/" config="/s3/#wasabi" >}} {{< provider name="WebDAV" home="https://en.wikipedia.org/wiki/WebDAV" config="/webdav/" >}} {{< provider name="Yandex Disk" home="https://disk.yandex.com/" config="/yandex/" >}} diff --git a/docs/content/docs.md b/docs/content/docs.md index d5eb67f41..f61462c87 100644 --- a/docs/content/docs.md +++ b/docs/content/docs.md @@ -57,6 +57,7 @@ See the following for detailed instructions for * [SugarSync](/sugarsync/) * [Tardigrade](/tardigrade/) * [Union](/union/) + * [Uptobox](/uptobox/) * [WebDAV](/webdav/) * [Yandex Disk](/yandex/) * [Zoho WorkDrive](/zoho/) diff --git a/docs/content/overview.md b/docs/content/overview.md index f1af56da9..ba9bca566 100644 --- a/docs/content/overview.md +++ b/docs/content/overview.md @@ -48,6 +48,7 @@ Here is an overview of the major features of each cloud storage system. | SFTP | MD5, SHA1 ² | Yes | Depends | No | - | | SugarSync | - | No | No | No | - | | Tardigrade | - | Yes | No | No | - | +| Uptobox | - | No | No | Yes | - | | WebDAV | MD5, SHA1 ³ | Yes ⁴ | Depends | No | - | | Yandex Disk | MD5 | Yes | No | No | R | | Zoho WorkDrive | - | No | No | No | - | @@ -361,6 +362,7 @@ upon backend specific capabilities. | SFTP | No | No | Yes | Yes | No | No | Yes | No | Yes | Yes | | SugarSync | Yes | Yes | Yes | Yes | No | No | Yes | Yes | No | Yes | | Tardigrade | Yes † | No | No | No | No | Yes | Yes | No | No | No | +| Uptobox | No | Yes | Yes | Yes | No | No | No | No | No | No | | WebDAV | Yes | Yes | Yes | Yes | No | No | Yes ‡ | No | Yes | Yes | | Yandex Disk | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | Yes | | Zoho WorkDrive | Yes | Yes | Yes | Yes | No | No | No | No | Yes | Yes | diff --git a/docs/content/uptobox.md b/docs/content/uptobox.md new file mode 100644 index 000000000..402d0a004 --- /dev/null +++ b/docs/content/uptobox.md @@ -0,0 +1,141 @@ +--- +title: "Uptobox" +description: "Rclone docs for Uptobox" +--- + +{{< icon "fa fa-archive" >}} Uptobox +----------------------------------------- + +This is a Backend for Uptobox file storage service. Uptobox is closer to a one-click hoster than a traditional +cloud storage provider and therefore not suitable for long term storage. + +Paths are specified as `remote:path` + +Paths may be as deep as required, e.g. `remote:directory/subdirectory`. + +## Setup + +To configure an Uptobox backend you'll need your personal api token. You'll find it in you +[account settings](https://uptobox.com/my_account) + + +### Example + +Here is an example of how to make a remote called `remote` with the default setup. First run: + + rclone config + +This will guide you through an interactive setup process: + +``` +Current remotes: + +Name Type +==== ==== +TestUptobox uptobox + +e) Edit existing remote +n) New remote +d) Delete remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +e/n/d/r/c/s/q> n +name> uptobox +Type of storage to configure. +Enter a string value. Press Enter for the default (""). +Choose a number from below, or type in your own value +[...] +37 / Uptobox + \ "uptobox" +[...] +Storage> uptobox +** See help for uptobox backend at: https://rclone.org/uptobox/ ** + +Your API Key, get it from https://uptobox.com/my_account +Enter a string value. Press Enter for the default (""). +api_key> xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> n +Remote config +-------------------- +[uptobox] +type = uptobox +api_key = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +-------------------- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> +``` +Once configured you can then use `rclone` like this, + +List directories in top level of your Uptobox + + rclone lsd remote: + +List all the files in your Uptobox + + rclone ls remote: + +To copy a local directory to an Uptobox directory called backup + + rclone copy /home/source remote:backup + +### Modified time and hashes + +Uptobox supports neither modified times nor checksums. + +#### Restricted filename characters + +In addition to the [default restricted characters set](/overview/#restricted-characters) +the following characters are also replaced: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| " | 0x22 | ＂ | +| ` | 0x41 | ｀ | + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in XML strings. + +{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/uptobox/uptobox.go then run make backenddocs" >}} +### Standard Options + +Here are the standard options specific to uptobox (Uptobox). + +#### --uptobox-api-key + +Your API Key, get it from https://uptobox.com/my_account + +- Config: api_key +- Env Var: RCLONE_UPTOBOX_API_KEY +- Type: string +- Default: "" + +### Advanced Options + +Here are the advanced options specific to uptobox (Uptobox). + +#### --uptobox-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_UPTOBOX_ENCODING +- Type: MultiEncoder +- Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot + +{{< rem autogenerated options stop >}} + +### Limitations + +Uptobox will delete inactive files that have not been accessed in 60 days. + +`rclone about` is not supported by this backend an overview of used space can however +been seen in the uptobox web interface. \ No newline at end of file diff --git a/docs/layouts/chrome/navbar.html b/docs/layouts/chrome/navbar.html index 189e9074e..6939a2a30 100644 --- a/docs/layouts/chrome/navbar.html +++ b/docs/layouts/chrome/navbar.html @@ -98,6 +98,7 @@ SFTP SugarSync Tardigrade + Uptobox Union (merge backends) WebDAV Yandex Disk