github.com/xhghs/rclone@v1.51.1-0.20200430155106-e186a28cced8/docs/content/hubic.md (about)

     1  ---
     2  title: "Hubic"
     3  description: "Rclone docs for Hubic"
     4  date: "2016-05-27"
     5  ---
     6  
     7  <i class="fa fa-space-shuttle"></i> Hubic
     8  -----------------------------------------
     9  
    10  Paths are specified as `remote:path`
    11  
    12  Paths are specified as `remote:container` (or `remote:` for the `lsd`
    13  command.)  You may put subdirectories in too, eg `remote:container/path/to/dir`.
    14  
    15  The initial setup for Hubic involves getting a token from Hubic which
    16  you need to do in your browser.  `rclone config` walks you through it.
    17  
    18  Here is an example of how to make a remote called `remote`.  First run:
    19  
    20       rclone config
    21  
    22  This will guide you through an interactive setup process:
    23  
    24  ```
    25  n) New remote
    26  s) Set configuration password
    27  n/s> n
    28  name> remote
    29  Type of storage to configure.
    30  Choose a number from below, or type in your own value
    31  [snip]
    32  XX / Hubic
    33     \ "hubic"
    34  [snip]
    35  Storage> hubic
    36  Hubic Client Id - leave blank normally.
    37  client_id>
    38  Hubic Client Secret - leave blank normally.
    39  client_secret>
    40  Remote config
    41  Use auto config?
    42   * Say Y if not sure
    43   * Say N if you are working on a remote or headless machine
    44  y) Yes
    45  n) No
    46  y/n> y
    47  If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
    48  Log in and authorize rclone for access
    49  Waiting for code...
    50  Got code
    51  --------------------
    52  [remote]
    53  client_id =
    54  client_secret =
    55  token = {"access_token":"XXXXXX"}
    56  --------------------
    57  y) Yes this is OK
    58  e) Edit this remote
    59  d) Delete this remote
    60  y/e/d> y
    61  ```
    62  
    63  See the [remote setup docs](/remote_setup/) for how to set it up on a
    64  machine with no Internet browser available.
    65  
    66  Note that rclone runs a webserver on your local machine to collect the
    67  token as returned from Hubic. This only runs from the moment it opens
    68  your browser to the moment you get back the verification code.  This
    69  is on `http://127.0.0.1:53682/` and this it may require you to unblock
    70  it temporarily if you are running a host firewall.
    71  
    72  Once configured you can then use `rclone` like this,
    73  
    74  List containers in the top level of your Hubic
    75  
    76      rclone lsd remote:
    77  
    78  List all the files in your Hubic
    79  
    80      rclone ls remote:
    81  
    82  To copy a local directory to an Hubic directory called backup
    83  
    84      rclone copy /home/source remote:backup
    85  
    86  If you want the directory to be visible in the official *Hubic
    87  browser*, you need to copy your files to the `default` directory
    88  
    89      rclone copy /home/source remote:default/backup
    90  
    91  ### --fast-list ###
    92  
    93  This remote supports `--fast-list` which allows you to use fewer
    94  transactions in exchange for more memory. See the [rclone
    95  docs](/docs/#fast-list) for more details.
    96  
    97  ### Modified time ###
    98  
    99  The modified time is stored as metadata on the object as
   100  `X-Object-Meta-Mtime` as floating point since the epoch accurate to 1
   101  ns.
   102  
   103  This is a de facto standard (used in the official python-swiftclient
   104  amongst others) for storing the modification time for an object.
   105  
   106  Note that Hubic wraps the Swift backend, so most of the properties of
   107  are the same.
   108  
   109  <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/hubic/hubic.go then run make backenddocs -->
   110  ### Standard Options
   111  
   112  Here are the standard options specific to hubic (Hubic).
   113  
   114  #### --hubic-client-id
   115  
   116  Hubic Client Id
   117  Leave blank normally.
   118  
   119  - Config:      client_id
   120  - Env Var:     RCLONE_HUBIC_CLIENT_ID
   121  - Type:        string
   122  - Default:     ""
   123  
   124  #### --hubic-client-secret
   125  
   126  Hubic Client Secret
   127  Leave blank normally.
   128  
   129  - Config:      client_secret
   130  - Env Var:     RCLONE_HUBIC_CLIENT_SECRET
   131  - Type:        string
   132  - Default:     ""
   133  
   134  ### Advanced Options
   135  
   136  Here are the advanced options specific to hubic (Hubic).
   137  
   138  #### --hubic-chunk-size
   139  
   140  Above this size files will be chunked into a _segments container.
   141  
   142  Above this size files will be chunked into a _segments container.  The
   143  default for this is 5GB which is its maximum value.
   144  
   145  - Config:      chunk_size
   146  - Env Var:     RCLONE_HUBIC_CHUNK_SIZE
   147  - Type:        SizeSuffix
   148  - Default:     5G
   149  
   150  #### --hubic-no-chunk
   151  
   152  Don't chunk files during streaming upload.
   153  
   154  When doing streaming uploads (eg using rcat or mount) setting this
   155  flag will cause the swift backend to not upload chunked files.
   156  
   157  This will limit the maximum upload size to 5GB. However non chunked
   158  files are easier to deal with and have an MD5SUM.
   159  
   160  Rclone will still chunk files bigger than chunk_size when doing normal
   161  copy operations.
   162  
   163  - Config:      no_chunk
   164  - Env Var:     RCLONE_HUBIC_NO_CHUNK
   165  - Type:        bool
   166  - Default:     false
   167  
   168  #### --hubic-encoding
   169  
   170  This sets the encoding for the backend.
   171  
   172  See: the [encoding section in the overview](/overview/#encoding) for more info.
   173  
   174  - Config:      encoding
   175  - Env Var:     RCLONE_HUBIC_ENCODING
   176  - Type:        MultiEncoder
   177  - Default:     Slash,InvalidUtf8
   178  
   179  <!--- autogenerated options stop -->
   180  
   181  ### Limitations ###
   182  
   183  This uses the normal OpenStack Swift mechanism to refresh the Swift
   184  API credentials and ignores the expires field returned by the Hubic
   185  API.
   186  
   187  The Swift API doesn't return a correct MD5SUM for segmented files
   188  (Dynamic or Static Large Objects) so rclone won't check or use the
   189  MD5SUM for these.