github.com/10XDev/rclone@v1.52.3-0.20200626220027-16af9ab76b2a/docs/content/hubic.md (about)

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