github.com/rclone/rclone@v1.66.1-0.20240517100346-7b89735ae726/docs/content/uptobox.md (about)

     1  ---
     2  title: "Uptobox"
     3  description: "Rclone docs for Uptobox"
     4  versionIntroduced: "v1.56"
     5  ---
     6  
     7  # {{< icon "fa fa-archive" >}} Uptobox
     8  
     9  This is a Backend for Uptobox file storage service. Uptobox is closer to a one-click hoster than a traditional 
    10  cloud storage provider and therefore not suitable for long term storage. 
    11  
    12  Paths are specified as `remote:path`
    13  
    14  Paths may be as deep as required, e.g. `remote:directory/subdirectory`.
    15  
    16  ## Configuration
    17  
    18  To configure an Uptobox backend you'll need your personal api token. You'll find it in your
    19  [account settings](https://uptobox.com/my_account)
    20  
    21  Here is an example of how to make a remote called `remote` with the default setup.  First run:
    22  
    23      rclone config
    24  
    25  This will guide you through an interactive setup process:
    26  
    27  ```
    28  Current remotes:
    29  
    30  Name                 Type
    31  ====                 ====
    32  TestUptobox          uptobox
    33  
    34  e) Edit existing remote
    35  n) New remote
    36  d) Delete remote
    37  r) Rename remote
    38  c) Copy remote
    39  s) Set configuration password
    40  q) Quit config
    41  e/n/d/r/c/s/q> n
    42  name> uptobox
    43  Type of storage to configure.
    44  Enter a string value. Press Enter for the default ("").
    45  Choose a number from below, or type in your own value
    46  [...]
    47  37 / Uptobox
    48     \ "uptobox"
    49  [...]
    50  Storage> uptobox
    51  ** See help for uptobox backend at: https://rclone.org/uptobox/ **
    52  
    53  Your API Key, get it from https://uptobox.com/my_account
    54  Enter a string value. Press Enter for the default ("").
    55  api_key> xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    56  Edit advanced config? (y/n)
    57  y) Yes
    58  n) No (default)
    59  y/n> n
    60  Remote config
    61  --------------------
    62  [uptobox]
    63  type = uptobox
    64  api_key = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    65  --------------------
    66  y) Yes this is OK (default)
    67  e) Edit this remote
    68  d) Delete this remote
    69  y/e/d> 
    70  ```
    71  Once configured you can then use `rclone` like this,
    72  
    73  List directories in top level of your Uptobox
    74  
    75      rclone lsd remote:
    76  
    77  List all the files in your Uptobox
    78  
    79      rclone ls remote:
    80  
    81  To copy a local directory to an Uptobox directory called backup
    82  
    83      rclone copy /home/source remote:backup
    84  
    85  ### Modification times and hashes
    86  
    87  Uptobox supports neither modified times nor checksums. All timestamps
    88  will read as that set by `--default-time`.
    89  
    90  ### Restricted filename characters
    91  
    92  In addition to the [default restricted characters set](/overview/#restricted-characters)
    93  the following characters are also replaced:
    94  
    95  | Character | Value | Replacement |
    96  | --------- |:-----:|:-----------:|
    97  | "         | 0x22  | ＂          |
    98  | `         | 0x41  | ｀          |
    99  
   100  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
   101  as they can't be used in XML strings.
   102  
   103  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/uptobox/uptobox.go then run make backenddocs" >}}
   104  ### Standard options
   105  
   106  Here are the Standard options specific to uptobox (Uptobox).
   107  
   108  #### --uptobox-access-token
   109  
   110  Your access token.
   111  
   112  Get it from https://uptobox.com/my_account.
   113  
   114  Properties:
   115  
   116  - Config:      access_token
   117  - Env Var:     RCLONE_UPTOBOX_ACCESS_TOKEN
   118  - Type:        string
   119  - Required:    false
   120  
   121  ### Advanced options
   122  
   123  Here are the Advanced options specific to uptobox (Uptobox).
   124  
   125  #### --uptobox-private
   126  
   127  Set to make uploaded files private
   128  
   129  Properties:
   130  
   131  - Config:      private
   132  - Env Var:     RCLONE_UPTOBOX_PRIVATE
   133  - Type:        bool
   134  - Default:     false
   135  
   136  #### --uptobox-encoding
   137  
   138  The encoding for the backend.
   139  
   140  See the [encoding section in the overview](/overview/#encoding) for more info.
   141  
   142  Properties:
   143  
   144  - Config:      encoding
   145  - Env Var:     RCLONE_UPTOBOX_ENCODING
   146  - Type:        Encoding
   147  - Default:     Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot
   148  
   149  #### --uptobox-description
   150  
   151  Description of the remote
   152  
   153  Properties:
   154  
   155  - Config:      description
   156  - Env Var:     RCLONE_UPTOBOX_DESCRIPTION
   157  - Type:        string
   158  - Required:    false
   159  
   160  {{< rem autogenerated options stop >}}
   161  
   162  ## Limitations
   163  
   164  Uptobox will delete inactive files that have not been accessed in 60 days.
   165  
   166  `rclone about` is not supported by this backend an overview of used space can however
   167  been seen in the uptobox web interface.