github.com/rclone/rclone@v1.66.1-0.20240517100346-7b89735ae726/docs/content/koofr.md (about) 1 --- 2 title: "Koofr" 3 description: "Rclone docs for Koofr" 4 versionIntroduced: "v1.47" 5 --- 6 7 # {{< icon "fa fa-suitcase" >}} Koofr 8 9 Paths are specified as `remote:path` 10 11 Paths may be as deep as required, e.g. `remote:directory/subdirectory`. 12 13 ## Configuration 14 15 The initial setup for Koofr involves creating an application password for 16 rclone. You can do that by opening the Koofr 17 [web application](https://app.koofr.net/app/admin/preferences/password), 18 giving the password a nice name like `rclone` and clicking on generate. 19 20 Here is an example of how to make a remote called `koofr`. First run: 21 22 rclone config 23 24 This will guide you through an interactive setup process: 25 26 ``` 27 No remotes found, make a new one? 28 n) New remote 29 s) Set configuration password 30 q) Quit config 31 n/s/q> n 32 name> koofr 33 Option Storage. 34 Type of storage to configure. 35 Choose a number from below, or type in your own value. 36 [snip] 37 22 / Koofr, Digi Storage and other Koofr-compatible storage providers 38 \ (koofr) 39 [snip] 40 Storage> koofr 41 Option provider. 42 Choose your storage provider. 43 Choose a number from below, or type in your own value. 44 Press Enter to leave empty. 45 1 / Koofr, https://app.koofr.net/ 46 \ (koofr) 47 2 / Digi Storage, https://storage.rcs-rds.ro/ 48 \ (digistorage) 49 3 / Any other Koofr API compatible storage service 50 \ (other) 51 provider> 1 52 Option user. 53 Your user name. 54 Enter a value. 55 user> USERNAME 56 Option password. 57 Your password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password). 58 Choose an alternative below. 59 y) Yes, type in my own password 60 g) Generate random password 61 y/g> y 62 Enter the password: 63 password: 64 Confirm the password: 65 password: 66 Edit advanced config? 67 y) Yes 68 n) No (default) 69 y/n> n 70 Remote config 71 -------------------- 72 [koofr] 73 type = koofr 74 provider = koofr 75 user = USERNAME 76 password = *** ENCRYPTED *** 77 -------------------- 78 y) Yes this is OK (default) 79 e) Edit this remote 80 d) Delete this remote 81 y/e/d> y 82 ``` 83 84 You can choose to edit advanced config in order to enter your own service URL 85 if you use an on-premise or white label Koofr instance, or choose an alternative 86 mount instead of your primary storage. 87 88 Once configured you can then use `rclone` like this, 89 90 List directories in top level of your Koofr 91 92 rclone lsd koofr: 93 94 List all the files in your Koofr 95 96 rclone ls koofr: 97 98 To copy a local directory to an Koofr directory called backup 99 100 rclone copy /home/source koofr:backup 101 102 ### Restricted filename characters 103 104 In addition to the [default restricted characters set](/overview/#restricted-characters) 105 the following characters are also replaced: 106 107 | Character | Value | Replacement | 108 | --------- |:-----:|:-----------:| 109 | \ | 0x5C | ＼ | 110 111 Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), 112 as they can't be used in XML strings. 113 114 {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/koofr/koofr.go then run make backenddocs" >}} 115 ### Standard options 116 117 Here are the Standard options specific to koofr (Koofr, Digi Storage and other Koofr-compatible storage providers). 118 119 #### --koofr-provider 120 121 Choose your storage provider. 122 123 Properties: 124 125 - Config: provider 126 - Env Var: RCLONE_KOOFR_PROVIDER 127 - Type: string 128 - Required: false 129 - Examples: 130 - "koofr" 131 - Koofr, https://app.koofr.net/ 132 - "digistorage" 133 - Digi Storage, https://storage.rcs-rds.ro/ 134 - "other" 135 - Any other Koofr API compatible storage service 136 137 #### --koofr-endpoint 138 139 The Koofr API endpoint to use. 140 141 Properties: 142 143 - Config: endpoint 144 - Env Var: RCLONE_KOOFR_ENDPOINT 145 - Provider: other 146 - Type: string 147 - Required: true 148 149 #### --koofr-user 150 151 Your user name. 152 153 Properties: 154 155 - Config: user 156 - Env Var: RCLONE_KOOFR_USER 157 - Type: string 158 - Required: true 159 160 #### --koofr-password 161 162 Your password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password). 163 164 **NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/). 165 166 Properties: 167 168 - Config: password 169 - Env Var: RCLONE_KOOFR_PASSWORD 170 - Provider: koofr 171 - Type: string 172 - Required: true 173 174 ### Advanced options 175 176 Here are the Advanced options specific to koofr (Koofr, Digi Storage and other Koofr-compatible storage providers). 177 178 #### --koofr-mountid 179 180 Mount ID of the mount to use. 181 182 If omitted, the primary mount is used. 183 184 Properties: 185 186 - Config: mountid 187 - Env Var: RCLONE_KOOFR_MOUNTID 188 - Type: string 189 - Required: false 190 191 #### --koofr-setmtime 192 193 Does the backend support setting modification time. 194 195 Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. 196 197 Properties: 198 199 - Config: setmtime 200 - Env Var: RCLONE_KOOFR_SETMTIME 201 - Type: bool 202 - Default: true 203 204 #### --koofr-encoding 205 206 The encoding for the backend. 207 208 See the [encoding section in the overview](/overview/#encoding) for more info. 209 210 Properties: 211 212 - Config: encoding 213 - Env Var: RCLONE_KOOFR_ENCODING 214 - Type: Encoding 215 - Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot 216 217 #### --koofr-description 218 219 Description of the remote 220 221 Properties: 222 223 - Config: description 224 - Env Var: RCLONE_KOOFR_DESCRIPTION 225 - Type: string 226 - Required: false 227 228 {{< rem autogenerated options stop >}} 229 230 ## Limitations 231 232 Note that Koofr is case insensitive so you can't have a file called 233 "Hello.doc" and one called "hello.doc". 234 235 ## Providers 236 237 ### Koofr 238 239 This is the original [Koofr](https://koofr.eu) storage provider used as main example and described in the [configuration](#configuration) section above. 240 241 ### Digi Storage 242 243 [Digi Storage](https://www.digi.ro/servicii/online/digi-storage) is a cloud storage service run by [Digi.ro](https://www.digi.ro/) that 244 provides a Koofr API. 245 246 Here is an example of how to make a remote called `ds`. First run: 247 248 rclone config 249 250 This will guide you through an interactive setup process: 251 252 ``` 253 No remotes found, make a new one? 254 n) New remote 255 s) Set configuration password 256 q) Quit config 257 n/s/q> n 258 name> ds 259 Option Storage. 260 Type of storage to configure. 261 Choose a number from below, or type in your own value. 262 [snip] 263 22 / Koofr, Digi Storage and other Koofr-compatible storage providers 264 \ (koofr) 265 [snip] 266 Storage> koofr 267 Option provider. 268 Choose your storage provider. 269 Choose a number from below, or type in your own value. 270 Press Enter to leave empty. 271 1 / Koofr, https://app.koofr.net/ 272 \ (koofr) 273 2 / Digi Storage, https://storage.rcs-rds.ro/ 274 \ (digistorage) 275 3 / Any other Koofr API compatible storage service 276 \ (other) 277 provider> 2 278 Option user. 279 Your user name. 280 Enter a value. 281 user> USERNAME 282 Option password. 283 Your password for rclone (generate one at https://storage.rcs-rds.ro/app/admin/preferences/password). 284 Choose an alternative below. 285 y) Yes, type in my own password 286 g) Generate random password 287 y/g> y 288 Enter the password: 289 password: 290 Confirm the password: 291 password: 292 Edit advanced config? 293 y) Yes 294 n) No (default) 295 y/n> n 296 -------------------- 297 [ds] 298 type = koofr 299 provider = digistorage 300 user = USERNAME 301 password = *** ENCRYPTED *** 302 -------------------- 303 y) Yes this is OK (default) 304 e) Edit this remote 305 d) Delete this remote 306 y/e/d> y 307 ``` 308 309 ### Other 310 311 You may also want to use another, public or private storage provider that runs a Koofr API compatible service, by simply providing the base URL to connect to. 312 313 Here is an example of how to make a remote called `other`. First run: 314 315 rclone config 316 317 This will guide you through an interactive setup process: 318 319 ``` 320 No remotes found, make a new one? 321 n) New remote 322 s) Set configuration password 323 q) Quit config 324 n/s/q> n 325 name> other 326 Option Storage. 327 Type of storage to configure. 328 Choose a number from below, or type in your own value. 329 [snip] 330 22 / Koofr, Digi Storage and other Koofr-compatible storage providers 331 \ (koofr) 332 [snip] 333 Storage> koofr 334 Option provider. 335 Choose your storage provider. 336 Choose a number from below, or type in your own value. 337 Press Enter to leave empty. 338 1 / Koofr, https://app.koofr.net/ 339 \ (koofr) 340 2 / Digi Storage, https://storage.rcs-rds.ro/ 341 \ (digistorage) 342 3 / Any other Koofr API compatible storage service 343 \ (other) 344 provider> 3 345 Option endpoint. 346 The Koofr API endpoint to use. 347 Enter a value. 348 endpoint> https://koofr.other.org 349 Option user. 350 Your user name. 351 Enter a value. 352 user> USERNAME 353 Option password. 354 Your password for rclone (generate one at your service's settings page). 355 Choose an alternative below. 356 y) Yes, type in my own password 357 g) Generate random password 358 y/g> y 359 Enter the password: 360 password: 361 Confirm the password: 362 password: 363 Edit advanced config? 364 y) Yes 365 n) No (default) 366 y/n> n 367 -------------------- 368 [other] 369 type = koofr 370 provider = other 371 endpoint = https://koofr.other.org 372 user = USERNAME 373 password = *** ENCRYPTED *** 374 -------------------- 375 y) Yes this is OK (default) 376 e) Edit this remote 377 d) Delete this remote 378 y/e/d> y 379 ```