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

     1  ---
     2  title: "Koofr"
     3  description: "Rclone docs for Koofr"
     4  date: "2019-02-25"
     5  ---
     6  
     7  <i class="fa fa-suitcase"></i> Koofr
     8  -----------------------------------------
     9  
    10  Paths are specified as `remote:path`
    11  
    12  Paths may be as deep as required, eg `remote:directory/subdirectory`.
    13  
    14  The initial setup for Koofr involves creating an application password for
    15  rclone. You can do that by opening the Koofr
    16  [web application](https://app.koofr.net/app/admin/preferences/password),
    17  giving the password a nice name like `rclone` and clicking on generate.
    18  
    19  Here is an example of how to make a remote called `koofr`.  First run:
    20  
    21       rclone config
    22  
    23  This will guide you through an interactive setup process:
    24  
    25  ```
    26  No remotes found - make a new one
    27  n) New remote
    28  s) Set configuration password
    29  q) Quit config
    30  n/s/q> n
    31  name> koofr 
    32  Type of storage to configure.
    33  Enter a string value. Press Enter for the default ("").
    34  Choose a number from below, or type in your own value
    35   1 / A stackable unification remote, which can appear to merge the contents of several remotes
    36     \ "union"
    37   2 / Alias for an existing remote
    38     \ "alias"
    39   3 / Amazon Drive
    40     \ "amazon cloud drive"
    41   4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)
    42     \ "s3"
    43   5 / Backblaze B2
    44     \ "b2"
    45   6 / Box
    46     \ "box"
    47   7 / Cache a remote
    48     \ "cache"
    49   8 / Dropbox
    50     \ "dropbox"
    51   9 / Encrypt/Decrypt a remote
    52     \ "crypt"
    53  10 / FTP Connection
    54     \ "ftp"
    55  11 / Google Cloud Storage (this is not Google Drive)
    56     \ "google cloud storage"
    57  12 / Google Drive
    58     \ "drive"
    59  13 / Hubic
    60     \ "hubic"
    61  14 / JottaCloud
    62     \ "jottacloud"
    63  15 / Koofr
    64     \ "koofr"
    65  16 / Local Disk
    66     \ "local"
    67  17 / Mega
    68     \ "mega"
    69  18 / Microsoft Azure Blob Storage
    70     \ "azureblob"
    71  19 / Microsoft OneDrive
    72     \ "onedrive"
    73  20 / OpenDrive
    74     \ "opendrive"
    75  21 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
    76     \ "swift"
    77  22 / Pcloud
    78     \ "pcloud"
    79  23 / QingCloud Object Storage
    80     \ "qingstor"
    81  24 / SSH/SFTP Connection
    82     \ "sftp"
    83  25 / Webdav
    84     \ "webdav"
    85  26 / Yandex Disk
    86     \ "yandex"
    87  27 / http Connection
    88     \ "http"
    89  Storage> koofr
    90  ** See help for koofr backend at: https://rclone.org/koofr/ **
    91  
    92  Your Koofr user name
    93  Enter a string value. Press Enter for the default ("").
    94  user> USER@NAME
    95  Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
    96  y) Yes type in my own password
    97  g) Generate random password
    98  y/g> y
    99  Enter the password:
   100  password:
   101  Confirm the password:
   102  password:
   103  Edit advanced config? (y/n)
   104  y) Yes
   105  n) No
   106  y/n> n
   107  Remote config
   108  --------------------
   109  [koofr]
   110  type = koofr
   111  baseurl = https://app.koofr.net
   112  user = USER@NAME
   113  password = *** ENCRYPTED ***
   114  --------------------
   115  y) Yes this is OK
   116  e) Edit this remote
   117  d) Delete this remote
   118  y/e/d> y
   119  ```
   120  
   121  You can choose to edit advanced config in order to enter your own service URL
   122  if you use an on-premise or white label Koofr instance, or choose an alternative
   123  mount instead of your primary storage.
   124  
   125  Once configured you can then use `rclone` like this,
   126  
   127  List directories in top level of your Koofr
   128  
   129      rclone lsd koofr:
   130  
   131  List all the files in your Koofr
   132  
   133      rclone ls koofr:
   134  
   135  To copy a local directory to an Koofr directory called backup
   136  
   137      rclone copy /home/source remote:backup
   138  
   139  <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/koofr/koofr.go then run make backenddocs -->
   140  ### Standard Options
   141  
   142  Here are the standard options specific to koofr (Koofr).
   143  
   144  #### --koofr-user
   145  
   146  Your Koofr user name
   147  
   148  - Config:      user
   149  - Env Var:     RCLONE_KOOFR_USER
   150  - Type:        string
   151  - Default:     ""
   152  
   153  #### --koofr-password
   154  
   155  Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
   156  
   157  - Config:      password
   158  - Env Var:     RCLONE_KOOFR_PASSWORD
   159  - Type:        string
   160  - Default:     ""
   161  
   162  ### Advanced Options
   163  
   164  Here are the advanced options specific to koofr (Koofr).
   165  
   166  #### --koofr-endpoint
   167  
   168  The Koofr API endpoint to use
   169  
   170  - Config:      endpoint
   171  - Env Var:     RCLONE_KOOFR_ENDPOINT
   172  - Type:        string
   173  - Default:     "https://app.koofr.net"
   174  
   175  #### --koofr-mountid
   176  
   177  Mount ID of the mount to use. If omitted, the primary mount is used.
   178  
   179  - Config:      mountid
   180  - Env Var:     RCLONE_KOOFR_MOUNTID
   181  - Type:        string
   182  - Default:     ""
   183  
   184  <!--- autogenerated options stop -->
   185  
   186  ### Limitations ###
   187  
   188  Note that Koofr is case insensitive so you can't have a file called
   189  "Hello.doc" and one called "hello.doc".