github.com/xhghs/rclone@v1.51.1-0.20200430155106-e186a28cced8/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  [snip]
    36  XX / Koofr
    37     \ "koofr"
    38  [snip]
    39  Storage> koofr
    40  ** See help for koofr backend at: https://rclone.org/koofr/ **
    41  
    42  Your Koofr user name
    43  Enter a string value. Press Enter for the default ("").
    44  user> USER@NAME
    45  Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
    46  y) Yes type in my own password
    47  g) Generate random password
    48  y/g> y
    49  Enter the password:
    50  password:
    51  Confirm the password:
    52  password:
    53  Edit advanced config? (y/n)
    54  y) Yes
    55  n) No
    56  y/n> n
    57  Remote config
    58  --------------------
    59  [koofr]
    60  type = koofr
    61  baseurl = https://app.koofr.net
    62  user = USER@NAME
    63  password = *** ENCRYPTED ***
    64  --------------------
    65  y) Yes this is OK
    66  e) Edit this remote
    67  d) Delete this remote
    68  y/e/d> y
    69  ```
    70  
    71  You can choose to edit advanced config in order to enter your own service URL
    72  if you use an on-premise or white label Koofr instance, or choose an alternative
    73  mount instead of your primary storage.
    74  
    75  Once configured you can then use `rclone` like this,
    76  
    77  List directories in top level of your Koofr
    78  
    79      rclone lsd koofr:
    80  
    81  List all the files in your Koofr
    82  
    83      rclone ls koofr:
    84  
    85  To copy a local directory to an Koofr directory called backup
    86  
    87      rclone copy /home/source remote:backup
    88  
    89  #### Restricted filename characters
    90  
    91  In addition to the [default restricted characters set](/overview/#restricted-characters)
    92  the following characters are also replaced:
    93  
    94  | Character | Value | Replacement |
    95  | --------- |:-----:|:-----------:|
    96  | \         | 0x5C  | ＼           |
    97  
    98  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
    99  as they can't be used in XML strings.
   100  
   101  <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/koofr/koofr.go then run make backenddocs -->
   102  ### Standard Options
   103  
   104  Here are the standard options specific to koofr (Koofr).
   105  
   106  #### --koofr-user
   107  
   108  Your Koofr user name
   109  
   110  - Config:      user
   111  - Env Var:     RCLONE_KOOFR_USER
   112  - Type:        string
   113  - Default:     ""
   114  
   115  #### --koofr-password
   116  
   117  Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
   118  
   119  - Config:      password
   120  - Env Var:     RCLONE_KOOFR_PASSWORD
   121  - Type:        string
   122  - Default:     ""
   123  
   124  ### Advanced Options
   125  
   126  Here are the advanced options specific to koofr (Koofr).
   127  
   128  #### --koofr-endpoint
   129  
   130  The Koofr API endpoint to use
   131  
   132  - Config:      endpoint
   133  - Env Var:     RCLONE_KOOFR_ENDPOINT
   134  - Type:        string
   135  - Default:     "https://app.koofr.net"
   136  
   137  #### --koofr-mountid
   138  
   139  Mount ID of the mount to use. If omitted, the primary mount is used.
   140  
   141  - Config:      mountid
   142  - Env Var:     RCLONE_KOOFR_MOUNTID
   143  - Type:        string
   144  - Default:     ""
   145  
   146  #### --koofr-setmtime
   147  
   148  Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend.
   149  
   150  - Config:      setmtime
   151  - Env Var:     RCLONE_KOOFR_SETMTIME
   152  - Type:        bool
   153  - Default:     true
   154  
   155  #### --koofr-encoding
   156  
   157  This sets the encoding for the backend.
   158  
   159  See: the [encoding section in the overview](/overview/#encoding) for more info.
   160  
   161  - Config:      encoding
   162  - Env Var:     RCLONE_KOOFR_ENCODING
   163  - Type:        MultiEncoder
   164  - Default:     Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
   165  
   166  <!--- autogenerated options stop -->
   167  
   168  ### Limitations ###
   169  
   170  Note that Koofr is case insensitive so you can't have a file called
   171  "Hello.doc" and one called "hello.doc".