github.com/ncw/rclone@v1.48.1-0.20190724201158-a35aa1360e3e/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   1 / Amazon Drive
    32     \ "amazon cloud drive"
    33   2 / Amazon S3 (also Dreamhost, Ceph, Minio)
    34     \ "s3"
    35   3 / Backblaze B2
    36     \ "b2"
    37   4 / Dropbox
    38     \ "dropbox"
    39   5 / Encrypt/Decrypt a remote
    40     \ "crypt"
    41   6 / Google Cloud Storage (this is not Google Drive)
    42     \ "google cloud storage"
    43   7 / Google Drive
    44     \ "drive"
    45   8 / Hubic
    46     \ "hubic"
    47   9 / Local Disk
    48     \ "local"
    49  10 / Microsoft OneDrive
    50     \ "onedrive"
    51  11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
    52     \ "swift"
    53  12 / SSH/SFTP Connection
    54     \ "sftp"
    55  13 / Yandex Disk
    56     \ "yandex"
    57  Storage> 8
    58  Hubic Client Id - leave blank normally.
    59  client_id>
    60  Hubic Client Secret - leave blank normally.
    61  client_secret>
    62  Remote config
    63  Use auto config?
    64   * Say Y if not sure
    65   * Say N if you are working on a remote or headless machine
    66  y) Yes
    67  n) No
    68  y/n> y
    69  If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
    70  Log in and authorize rclone for access
    71  Waiting for code...
    72  Got code
    73  --------------------
    74  [remote]
    75  client_id =
    76  client_secret =
    77  token = {"access_token":"XXXXXX"}
    78  --------------------
    79  y) Yes this is OK
    80  e) Edit this remote
    81  d) Delete this remote
    82  y/e/d> y
    83  ```
    84  
    85  See the [remote setup docs](/remote_setup/) for how to set it up on a
    86  machine with no Internet browser available.
    87  
    88  Note that rclone runs a webserver on your local machine to collect the
    89  token as returned from Hubic. This only runs from the moment it opens
    90  your browser to the moment you get back the verification code.  This
    91  is on `http://127.0.0.1:53682/` and this it may require you to unblock
    92  it temporarily if you are running a host firewall.
    93  
    94  Once configured you can then use `rclone` like this,
    95  
    96  List containers in the top level of your Hubic
    97  
    98      rclone lsd remote:
    99  
   100  List all the files in your Hubic
   101  
   102      rclone ls remote:
   103  
   104  To copy a local directory to an Hubic directory called backup
   105  
   106      rclone copy /home/source remote:backup
   107  
   108  If you want the directory to be visible in the official *Hubic
   109  browser*, you need to copy your files to the `default` directory
   110  
   111      rclone copy /home/source remote:default/backup
   112  
   113  ### --fast-list ###
   114  
   115  This remote supports `--fast-list` which allows you to use fewer
   116  transactions in exchange for more memory. See the [rclone
   117  docs](/docs/#fast-list) for more details.
   118  
   119  ### Modified time ###
   120  
   121  The modified time is stored as metadata on the object as
   122  `X-Object-Meta-Mtime` as floating point since the epoch accurate to 1
   123  ns.
   124  
   125  This is a de facto standard (used in the official python-swiftclient
   126  amongst others) for storing the modification time for an object.
   127  
   128  Note that Hubic wraps the Swift backend, so most of the properties of
   129  are the same.
   130  
   131  <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/hubic/hubic.go then run make backenddocs -->
   132  ### Standard Options
   133  
   134  Here are the standard options specific to hubic (Hubic).
   135  
   136  #### --hubic-client-id
   137  
   138  Hubic Client Id
   139  Leave blank normally.
   140  
   141  - Config:      client_id
   142  - Env Var:     RCLONE_HUBIC_CLIENT_ID
   143  - Type:        string
   144  - Default:     ""
   145  
   146  #### --hubic-client-secret
   147  
   148  Hubic Client Secret
   149  Leave blank normally.
   150  
   151  - Config:      client_secret
   152  - Env Var:     RCLONE_HUBIC_CLIENT_SECRET
   153  - Type:        string
   154  - Default:     ""
   155  
   156  ### Advanced Options
   157  
   158  Here are the advanced options specific to hubic (Hubic).
   159  
   160  #### --hubic-chunk-size
   161  
   162  Above this size files will be chunked into a _segments container.
   163  
   164  Above this size files will be chunked into a _segments container.  The
   165  default for this is 5GB which is its maximum value.
   166  
   167  - Config:      chunk_size
   168  - Env Var:     RCLONE_HUBIC_CHUNK_SIZE
   169  - Type:        SizeSuffix
   170  - Default:     5G
   171  
   172  #### --hubic-no-chunk
   173  
   174  Don't chunk files during streaming upload.
   175  
   176  When doing streaming uploads (eg using rcat or mount) setting this
   177  flag will cause the swift backend to not upload chunked files.
   178  
   179  This will limit the maximum upload size to 5GB. However non chunked
   180  files are easier to deal with and have an MD5SUM.
   181  
   182  Rclone will still chunk files bigger than chunk_size when doing normal
   183  copy operations.
   184  
   185  - Config:      no_chunk
   186  - Env Var:     RCLONE_HUBIC_NO_CHUNK
   187  - Type:        bool
   188  - Default:     false
   189  
   190  <!--- autogenerated options stop -->
   191  
   192  ### Limitations ###
   193  
   194  This uses the normal OpenStack Swift mechanism to refresh the Swift
   195  API credentials and ignores the expires field returned by the Hubic
   196  API.
   197  
   198  The Swift API doesn't return a correct MD5SUM for segmented files
   199  (Dynamic or Static Large Objects) so rclone won't check or use the
   200  MD5SUM for these.