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

     1  ---
     2  title: "Koofr"
     3  description: "Rclone docs for Koofr"
     4  ---
     5  
     6  {{< icon "fa fa-suitcase" >}} Koofr
     7  -----------------------------------------
     8  
     9  Paths are specified as `remote:path`
    10  
    11  Paths may be as deep as required, eg `remote:directory/subdirectory`.
    12  
    13  The initial setup for Koofr involves creating an application password for
    14  rclone. You can do that by opening the Koofr
    15  [web application](https://app.koofr.net/app/admin/preferences/password),
    16  giving the password a nice name like `rclone` and clicking on generate.
    17  
    18  Here is an example of how to make a remote called `koofr`.  First run:
    19  
    20       rclone config
    21  
    22  This will guide you through an interactive setup process:
    23  
    24  ```
    25  No remotes found - make a new one
    26  n) New remote
    27  s) Set configuration password
    28  q) Quit config
    29  n/s/q> n
    30  name> koofr 
    31  Type of storage to configure.
    32  Enter a string value. Press Enter for the default ("").
    33  Choose a number from below, or type in your own value
    34  [snip]
    35  XX / Koofr
    36     \ "koofr"
    37  [snip]
    38  Storage> koofr
    39  ** See help for koofr backend at: https://rclone.org/koofr/ **
    40  
    41  Your Koofr user name
    42  Enter a string value. Press Enter for the default ("").
    43  user> USER@NAME
    44  Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
    45  y) Yes type in my own password
    46  g) Generate random password
    47  y/g> y
    48  Enter the password:
    49  password:
    50  Confirm the password:
    51  password:
    52  Edit advanced config? (y/n)
    53  y) Yes
    54  n) No
    55  y/n> n
    56  Remote config
    57  --------------------
    58  [koofr]
    59  type = koofr
    60  baseurl = https://app.koofr.net
    61  user = USER@NAME
    62  password = *** ENCRYPTED ***
    63  --------------------
    64  y) Yes this is OK
    65  e) Edit this remote
    66  d) Delete this remote
    67  y/e/d> y
    68  ```
    69  
    70  You can choose to edit advanced config in order to enter your own service URL
    71  if you use an on-premise or white label Koofr instance, or choose an alternative
    72  mount instead of your primary storage.
    73  
    74  Once configured you can then use `rclone` like this,
    75  
    76  List directories in top level of your Koofr
    77  
    78      rclone lsd koofr:
    79  
    80  List all the files in your Koofr
    81  
    82      rclone ls koofr:
    83  
    84  To copy a local directory to an Koofr directory called backup
    85  
    86      rclone copy /home/source remote:backup
    87  
    88  #### Restricted filename characters
    89  
    90  In addition to the [default restricted characters set](/overview/#restricted-characters)
    91  the following characters are also replaced:
    92  
    93  | Character | Value | Replacement |
    94  | --------- |:-----:|:-----------:|
    95  | \         | 0x5C  | ＼           |
    96  
    97  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
    98  as they can't be used in XML strings.
    99  
   100  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/koofr/koofr.go then run make backenddocs" >}}
   101  ### Standard Options
   102  
   103  Here are the standard options specific to koofr (Koofr).
   104  
   105  #### --koofr-user
   106  
   107  Your Koofr user name
   108  
   109  - Config:      user
   110  - Env Var:     RCLONE_KOOFR_USER
   111  - Type:        string
   112  - Default:     ""
   113  
   114  #### --koofr-password
   115  
   116  Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
   117  
   118  **NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
   119  
   120  - Config:      password
   121  - Env Var:     RCLONE_KOOFR_PASSWORD
   122  - Type:        string
   123  - Default:     ""
   124  
   125  ### Advanced Options
   126  
   127  Here are the advanced options specific to koofr (Koofr).
   128  
   129  #### --koofr-endpoint
   130  
   131  The Koofr API endpoint to use
   132  
   133  - Config:      endpoint
   134  - Env Var:     RCLONE_KOOFR_ENDPOINT
   135  - Type:        string
   136  - Default:     "https://app.koofr.net"
   137  
   138  #### --koofr-mountid
   139  
   140  Mount ID of the mount to use. If omitted, the primary mount is used.
   141  
   142  - Config:      mountid
   143  - Env Var:     RCLONE_KOOFR_MOUNTID
   144  - Type:        string
   145  - Default:     ""
   146  
   147  #### --koofr-setmtime
   148  
   149  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.
   150  
   151  - Config:      setmtime
   152  - Env Var:     RCLONE_KOOFR_SETMTIME
   153  - Type:        bool
   154  - Default:     true
   155  
   156  #### --koofr-encoding
   157  
   158  This sets the encoding for the backend.
   159  
   160  See: the [encoding section in the overview](/overview/#encoding) for more info.
   161  
   162  - Config:      encoding
   163  - Env Var:     RCLONE_KOOFR_ENCODING
   164  - Type:        MultiEncoder
   165  - Default:     Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
   166  
   167  {{< rem autogenerated options stop >}}
   168  
   169  ### Limitations ###
   170  
   171  Note that Koofr is case insensitive so you can't have a file called
   172  "Hello.doc" and one called "hello.doc".