github.com/ncw/rclone@v1.48.1-0.20190724201158-a35aa1360e3e/docs/content/qingstor.md (about)

     1  ---
     2  title: "QingStor"
     3  description: "Rclone docs for QingStor Object Storage"
     4  date: "2017-06-26"
     5  ---
     6  
     7  <i class="fa fa-hdd-o"></i> QingStor
     8  ---------------------------------------
     9  
    10  Paths are specified as `remote:bucket` (or `remote:` for the `lsd`
    11  command.)  You may put subdirectories in too, eg `remote:bucket/path/to/dir`.
    12  
    13  Here is an example of making an QingStor configuration.  First run
    14  
    15      rclone config
    16  
    17  This will guide you through an interactive setup process.
    18  
    19  ```
    20  No remotes found - make a new one
    21  n) New remote
    22  r) Rename remote
    23  c) Copy remote
    24  s) Set configuration password
    25  q) Quit config
    26  n/r/c/s/q> n
    27  name> remote
    28  Type of storage to configure.
    29  Choose a number from below, or type in your own value
    30   1 / Amazon Drive
    31     \ "amazon cloud drive"
    32   2 / Amazon S3 (also Dreamhost, Ceph, Minio)
    33     \ "s3"
    34   3 / Backblaze B2
    35     \ "b2"
    36   4 / Dropbox
    37     \ "dropbox"
    38   5 / Encrypt/Decrypt a remote
    39     \ "crypt"
    40   6 / FTP Connection
    41     \ "ftp"
    42   7 / Google Cloud Storage (this is not Google Drive)
    43     \ "google cloud storage"
    44   8 / Google Drive
    45     \ "drive"
    46   9 / Hubic
    47     \ "hubic"
    48  10 / Local Disk
    49     \ "local"
    50  11 / Microsoft OneDrive
    51     \ "onedrive"
    52  12 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
    53     \ "swift"
    54  13 / QingStor Object Storage
    55     \ "qingstor"
    56  14 / SSH/SFTP Connection
    57     \ "sftp"
    58  15 / Yandex Disk
    59     \ "yandex"
    60  Storage> 13
    61  Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank.
    62  Choose a number from below, or type in your own value
    63   1 / Enter QingStor credentials in the next step
    64     \ "false"
    65   2 / Get QingStor credentials from the environment (env vars or IAM)
    66     \ "true"
    67  env_auth> 1
    68  QingStor Access Key ID - leave blank for anonymous access or runtime credentials.
    69  access_key_id> access_key
    70  QingStor Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
    71  secret_access_key> secret_key
    72  Enter a endpoint URL to connection QingStor API.
    73  Leave blank will use the default value "https://qingstor.com:443"
    74  endpoint>
    75  Zone connect to. Default is "pek3a".
    76  Choose a number from below, or type in your own value
    77     / The Beijing (China) Three Zone
    78   1 | Needs location constraint pek3a.
    79     \ "pek3a"
    80     / The Shanghai (China) First Zone
    81   2 | Needs location constraint sh1a.
    82     \ "sh1a"
    83  zone> 1
    84  Number of connnection retry.
    85  Leave blank will use the default value "3".
    86  connection_retries>
    87  Remote config
    88  --------------------
    89  [remote]
    90  env_auth = false
    91  access_key_id = access_key
    92  secret_access_key = secret_key
    93  endpoint =
    94  zone = pek3a
    95  connection_retries =
    96  --------------------
    97  y) Yes this is OK
    98  e) Edit this remote
    99  d) Delete this remote
   100  y/e/d> y
   101  ```
   102  
   103  This remote is called `remote` and can now be used like this
   104  
   105  See all buckets
   106  
   107      rclone lsd remote:
   108  
   109  Make a new bucket
   110  
   111      rclone mkdir remote:bucket
   112  
   113  List the contents of a bucket
   114  
   115      rclone ls remote:bucket
   116  
   117  Sync `/home/local/directory` to the remote bucket, deleting any excess
   118  files in the bucket.
   119  
   120      rclone sync /home/local/directory remote:bucket
   121  
   122  ### --fast-list ###
   123  
   124  This remote supports `--fast-list` which allows you to use fewer
   125  transactions in exchange for more memory. See the [rclone
   126  docs](/docs/#fast-list) for more details.
   127  
   128  ### Multipart uploads ###
   129  
   130  rclone supports multipart uploads with QingStor which means that it can
   131  upload files bigger than 5GB. Note that files uploaded with multipart
   132  upload don't have an MD5SUM.
   133  
   134  ### Buckets and Zone ###
   135  
   136  With QingStor you can list buckets (`rclone lsd`) using any zone,
   137  but you can only access the content of a bucket from the zone it was
   138  created in.  If you attempt to access a bucket from the wrong zone,
   139  you will get an error, `incorrect zone, the bucket is not in 'XXX'
   140  zone`.
   141  
   142  ### Authentication ###
   143  
   144  There are two ways to supply `rclone` with a set of QingStor
   145  credentials. In order of precedence:
   146  
   147   - Directly in the rclone configuration file (as configured by `rclone config`)
   148     - set `access_key_id` and `secret_access_key`
   149   - Runtime configuration:
   150     - set `env_auth` to `true` in the config file
   151     - Exporting the following environment variables before running `rclone`
   152       - Access Key ID: `QS_ACCESS_KEY_ID` or `QS_ACCESS_KEY`
   153       - Secret Access Key: `QS_SECRET_ACCESS_KEY` or `QS_SECRET_KEY`
   154  
   155  <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/qingstor/qingstor.go then run make backenddocs -->
   156  ### Standard Options
   157  
   158  Here are the standard options specific to qingstor (QingCloud Object Storage).
   159  
   160  #### --qingstor-env-auth
   161  
   162  Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank.
   163  
   164  - Config:      env_auth
   165  - Env Var:     RCLONE_QINGSTOR_ENV_AUTH
   166  - Type:        bool
   167  - Default:     false
   168  - Examples:
   169      - "false"
   170          - Enter QingStor credentials in the next step
   171      - "true"
   172          - Get QingStor credentials from the environment (env vars or IAM)
   173  
   174  #### --qingstor-access-key-id
   175  
   176  QingStor Access Key ID
   177  Leave blank for anonymous access or runtime credentials.
   178  
   179  - Config:      access_key_id
   180  - Env Var:     RCLONE_QINGSTOR_ACCESS_KEY_ID
   181  - Type:        string
   182  - Default:     ""
   183  
   184  #### --qingstor-secret-access-key
   185  
   186  QingStor Secret Access Key (password)
   187  Leave blank for anonymous access or runtime credentials.
   188  
   189  - Config:      secret_access_key
   190  - Env Var:     RCLONE_QINGSTOR_SECRET_ACCESS_KEY
   191  - Type:        string
   192  - Default:     ""
   193  
   194  #### --qingstor-endpoint
   195  
   196  Enter a endpoint URL to connection QingStor API.
   197  Leave blank will use the default value "https://qingstor.com:443"
   198  
   199  - Config:      endpoint
   200  - Env Var:     RCLONE_QINGSTOR_ENDPOINT
   201  - Type:        string
   202  - Default:     ""
   203  
   204  #### --qingstor-zone
   205  
   206  Zone to connect to.
   207  Default is "pek3a".
   208  
   209  - Config:      zone
   210  - Env Var:     RCLONE_QINGSTOR_ZONE
   211  - Type:        string
   212  - Default:     ""
   213  - Examples:
   214      - "pek3a"
   215          - The Beijing (China) Three Zone
   216          - Needs location constraint pek3a.
   217      - "sh1a"
   218          - The Shanghai (China) First Zone
   219          - Needs location constraint sh1a.
   220      - "gd2a"
   221          - The Guangdong (China) Second Zone
   222          - Needs location constraint gd2a.
   223  
   224  ### Advanced Options
   225  
   226  Here are the advanced options specific to qingstor (QingCloud Object Storage).
   227  
   228  #### --qingstor-connection-retries
   229  
   230  Number of connection retries.
   231  
   232  - Config:      connection_retries
   233  - Env Var:     RCLONE_QINGSTOR_CONNECTION_RETRIES
   234  - Type:        int
   235  - Default:     3
   236  
   237  #### --qingstor-upload-cutoff
   238  
   239  Cutoff for switching to chunked upload
   240  
   241  Any files larger than this will be uploaded in chunks of chunk_size.
   242  The minimum is 0 and the maximum is 5GB.
   243  
   244  - Config:      upload_cutoff
   245  - Env Var:     RCLONE_QINGSTOR_UPLOAD_CUTOFF
   246  - Type:        SizeSuffix
   247  - Default:     200M
   248  
   249  #### --qingstor-chunk-size
   250  
   251  Chunk size to use for uploading.
   252  
   253  When uploading files larger than upload_cutoff they will be uploaded
   254  as multipart uploads using this chunk size.
   255  
   256  Note that "--qingstor-upload-concurrency" chunks of this size are buffered
   257  in memory per transfer.
   258  
   259  If you are transferring large files over high speed links and you have
   260  enough memory, then increasing this will speed up the transfers.
   261  
   262  - Config:      chunk_size
   263  - Env Var:     RCLONE_QINGSTOR_CHUNK_SIZE
   264  - Type:        SizeSuffix
   265  - Default:     4M
   266  
   267  #### --qingstor-upload-concurrency
   268  
   269  Concurrency for multipart uploads.
   270  
   271  This is the number of chunks of the same file that are uploaded
   272  concurrently.
   273  
   274  NB if you set this to > 1 then the checksums of multpart uploads
   275  become corrupted (the uploads themselves are not corrupted though).
   276  
   277  If you are uploading small numbers of large file over high speed link
   278  and these uploads do not fully utilize your bandwidth, then increasing
   279  this may help to speed up the transfers.
   280  
   281  - Config:      upload_concurrency
   282  - Env Var:     RCLONE_QINGSTOR_UPLOAD_CONCURRENCY
   283  - Type:        int
   284  - Default:     1
   285  
   286  <!--- autogenerated options stop -->