2019-02-22 16:50:04 +01:00
---
title: "Koofr"
description: "Rclone docs for Koofr"
2022-12-20 21:05:05 +01:00
versionIntroduced: "v1.47"
2019-02-22 16:50:04 +01:00
---
2021-07-20 20:45:41 +02:00
# {{< icon "fa fa-suitcase" >}} Koofr
2019-02-22 16:50:04 +01:00
Paths are specified as `remote:path`
2020-10-13 23:49:58 +02:00
Paths may be as deep as required, e.g. `remote:directory/subdirectory` .
2019-02-22 16:50:04 +01:00
2021-10-14 15:40:18 +02:00
## Configuration
2019-02-22 16:50:04 +01:00
The initial setup for Koofr involves creating an application password for
rclone. You can do that by opening the Koofr
[web application ](https://app.koofr.net/app/admin/preferences/password ),
giving the password a nice name like `rclone` and clicking on generate.
Here is an example of how to make a remote called `koofr` . First run:
rclone config
This will guide you through an interactive setup process:
```
2021-11-01 21:34:46 +01:00
No remotes found, make a new one?
2019-02-22 16:50:04 +01:00
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n
2022-03-07 14:43:29 +01:00
name> koofr
Option Storage.
2019-02-22 16:50:04 +01:00
Type of storage to configure.
2022-03-07 14:43:29 +01:00
Choose a number from below, or type in your own value.
2019-08-26 11:47:17 +02:00
[snip]
2022-03-07 14:43:29 +01:00
22 / Koofr, Digi Storage and other Koofr-compatible storage providers
\ (koofr)
2019-08-26 11:47:17 +02:00
[snip]
2019-02-22 16:50:04 +01:00
Storage> koofr
2022-03-07 14:43:29 +01:00
Option provider.
Choose your storage provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
1 / Koofr, https://app.koofr.net/
\ (koofr)
2022-03-08 11:56:53 +01:00
2 / Digi Storage, https://storage.rcs-rds.ro/
\ (digistorage)
2022-03-07 14:43:29 +01:00
3 / Any other Koofr API compatible storage service
\ (other)
provider> 1
Option user.
Your user name.
Enter a value.
user> USERNAME
Option password.
Your password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password).
Choose an alternative below.
y) Yes, type in my own password
2019-02-22 16:50:04 +01:00
g) Generate random password
y/g> y
Enter the password:
password:
Confirm the password:
password:
2022-03-07 14:43:29 +01:00
Edit advanced config?
2019-02-22 16:50:04 +01:00
y) Yes
2022-03-07 14:43:29 +01:00
n) No (default)
2019-02-22 16:50:04 +01:00
y/n> n
2022-03-08 11:56:53 +01:00
Remote config
2019-02-22 16:50:04 +01:00
--------------------
[koofr]
type = koofr
2022-03-07 14:43:29 +01:00
provider = koofr
user = USERNAME
2019-02-22 16:50:04 +01:00
password = ** * ENCRYPTED ** *
--------------------
2022-03-07 14:43:29 +01:00
y) Yes this is OK (default)
2019-02-22 16:50:04 +01:00
e) Edit this remote
d) Delete this remote
y/e/d> y
```
You can choose to edit advanced config in order to enter your own service URL
if you use an on-premise or white label Koofr instance, or choose an alternative
mount instead of your primary storage.
Once configured you can then use `rclone` like this,
List directories in top level of your Koofr
rclone lsd koofr:
List all the files in your Koofr
rclone ls koofr:
To copy a local directory to an Koofr directory called backup
2022-03-07 14:43:29 +01:00
rclone copy /home/source koofr:backup
2019-02-22 16:50:04 +01:00
2021-10-14 15:40:18 +02:00
### Restricted filename characters
2019-05-19 17:55:26 +02:00
In addition to the [default restricted characters set ](/overview/#restricted-characters )
the following characters are also replaced:
| Character | Value | Replacement |
| --------- |:-----:|:-----------:|
| \ | 0x5C | \ |
Invalid UTF-8 bytes will also be [replaced ](/overview/#invalid-utf8 ),
as they can't be used in XML strings.
2020-05-22 13:22:52 +02:00
{{< rem autogenerated options start " - DO NOT EDIT - instead edit fs . RegInfo in backend / koofr / koofr . go then run make backenddocs " > }}
2021-11-01 16:42:05 +01:00
### Standard options
2019-02-22 16:50:04 +01:00
2022-07-09 19:08:20 +02:00
Here are the Standard options specific to koofr (Koofr, Digi Storage and other Koofr-compatible storage providers).
2022-03-07 14:43:29 +01:00
#### --koofr-provider
Choose your storage provider.
Properties:
- Config: provider
- Env Var: RCLONE_KOOFR_PROVIDER
- Type: string
- Required: false
- Examples:
- "koofr"
- Koofr, https://app.koofr.net/
2022-03-08 11:56:53 +01:00
- "digistorage"
- Digi Storage, https://storage.rcs-rds.ro/
2022-03-07 14:43:29 +01:00
- "other"
- Any other Koofr API compatible storage service
#### --koofr-endpoint
The Koofr API endpoint to use.
Properties:
- Config: endpoint
- Env Var: RCLONE_KOOFR_ENDPOINT
- Provider: other
- Type: string
- Required: true
2019-02-22 16:50:04 +01:00
#### --koofr-user
2022-03-07 14:43:29 +01:00
Your user name.
Properties:
2019-02-22 16:50:04 +01:00
- Config: user
- Env Var: RCLONE_KOOFR_USER
- Type: string
2022-03-07 14:43:29 +01:00
- Required: true
2019-02-22 16:50:04 +01:00
#### --koofr-password
2022-03-07 14:43:29 +01:00
Your password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password).
2019-02-22 16:50:04 +01:00
2020-09-02 17:59:04 +02:00
**NB** Input to this must be obscured - see [rclone obscure ](/commands/rclone_obscure/ ).
2022-03-07 14:43:29 +01:00
Properties:
2019-02-22 16:50:04 +01:00
- Config: password
- Env Var: RCLONE_KOOFR_PASSWORD
2022-03-07 14:43:29 +01:00
- Provider: koofr
2019-02-22 16:50:04 +01:00
- Type: string
2022-03-07 14:43:29 +01:00
- Required: true
2019-02-22 16:50:04 +01:00
2022-03-07 14:43:29 +01:00
#### --koofr-password
2019-02-22 16:50:04 +01:00
2022-03-07 14:43:29 +01:00
Your password for rclone (generate one at https://storage.rcs-rds.ro/app/admin/preferences/password).
2019-02-22 16:50:04 +01:00
2022-03-07 14:43:29 +01:00
**NB** Input to this must be obscured - see [rclone obscure ](/commands/rclone_obscure/ ).
2019-02-22 16:50:04 +01:00
2022-03-07 14:43:29 +01:00
Properties:
2019-02-22 16:50:04 +01:00
2022-03-07 14:43:29 +01:00
- Config: password
- Env Var: RCLONE_KOOFR_PASSWORD
2022-03-08 11:56:53 +01:00
- Provider: digistorage
2019-02-22 16:50:04 +01:00
- Type: string
2022-03-07 14:43:29 +01:00
- Required: true
#### --koofr-password
Your password for rclone (generate one at your service's settings page).
**NB** Input to this must be obscured - see [rclone obscure ](/commands/rclone_obscure/ ).
Properties:
- Config: password
- Env Var: RCLONE_KOOFR_PASSWORD
- Provider: other
- Type: string
- Required: true
### Advanced options
2022-07-09 19:08:20 +02:00
Here are the Advanced options specific to koofr (Koofr, Digi Storage and other Koofr-compatible storage providers).
2019-02-22 16:50:04 +01:00
#### --koofr-mountid
2021-11-01 16:42:05 +01:00
Mount ID of the mount to use.
If omitted, the primary mount is used.
2019-02-22 16:50:04 +01:00
2022-03-07 14:43:29 +01:00
Properties:
2019-02-22 16:50:04 +01:00
- Config: mountid
- Env Var: RCLONE_KOOFR_MOUNTID
- Type: string
2022-03-07 14:43:29 +01:00
- Required: false
2019-02-22 16:50:04 +01:00
2019-08-26 16:25:20 +02:00
#### --koofr-setmtime
2021-11-01 16:42:05 +01:00
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.
2019-08-26 16:25:20 +02:00
2022-03-07 14:43:29 +01:00
Properties:
2019-08-26 16:25:20 +02:00
- Config: setmtime
- Env Var: RCLONE_KOOFR_SETMTIME
- Type: bool
- Default: true
2020-02-01 11:31:42 +01:00
#### --koofr-encoding
2022-03-07 14:43:29 +01:00
The encoding for the backend.
2020-02-01 11:31:42 +01:00
2021-11-01 16:42:05 +01:00
See the [encoding section in the overview ](/overview/#encoding ) for more info.
2020-02-01 11:31:42 +01:00
2022-03-07 14:43:29 +01:00
Properties:
2020-02-01 11:31:42 +01:00
- Config: encoding
- Env Var: RCLONE_KOOFR_ENCODING
- Type: MultiEncoder
- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
2020-05-22 13:22:52 +02:00
{{< rem autogenerated options stop > }}
2019-02-22 16:50:04 +01:00
2021-10-14 15:40:18 +02:00
## Limitations
2019-02-22 16:50:04 +01:00
Note that Koofr is case insensitive so you can't have a file called
"Hello.doc" and one called "hello.doc".
2022-03-07 14:43:29 +01:00
## Providers
### Koofr
This is the original [Koofr ](https://koofr.eu ) storage provider used as main example and described in the [configuration ](#configuration ) section above.
2022-03-08 11:56:53 +01:00
### Digi Storage
2022-03-07 14:43:29 +01:00
2022-03-08 11:56:53 +01:00
[Digi Storage ](https://www.digi.ro/servicii/online/digi-storage ) is a cloud storage service run by [Digi.ro ](https://www.digi.ro/ ) that
2022-03-07 14:43:29 +01:00
provides a Koofr API.
Here is an example of how to make a remote called `ds` . First run:
rclone config
This will guide you through an interactive setup process:
```
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n
name> ds
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
22 / Koofr, Digi Storage and other Koofr-compatible storage providers
\ (koofr)
[snip]
Storage> koofr
Option provider.
Choose your storage provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
1 / Koofr, https://app.koofr.net/
\ (koofr)
2022-03-08 11:56:53 +01:00
2 / Digi Storage, https://storage.rcs-rds.ro/
\ (digistorage)
2022-03-07 14:43:29 +01:00
3 / Any other Koofr API compatible storage service
\ (other)
provider> 2
Option user.
Your user name.
Enter a value.
user> USERNAME
Option password.
Your password for rclone (generate one at https://storage.rcs-rds.ro/app/admin/preferences/password).
Choose an alternative below.
y) Yes, type in my own password
g) Generate random password
y/g> y
Enter the password:
password:
Confirm the password:
password:
Edit advanced config?
y) Yes
n) No (default)
y/n> n
--------------------
[ds]
type = koofr
2022-03-08 11:56:53 +01:00
provider = digistorage
2022-03-07 14:43:29 +01:00
user = USERNAME
password = ** * ENCRYPTED ** *
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y
```
2022-03-08 11:56:53 +01:00
2022-03-07 14:43:29 +01:00
### Other
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.
Here is an example of how to make a remote called `other` . First run:
rclone config
This will guide you through an interactive setup process:
```
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n
name> other
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
22 / Koofr, Digi Storage and other Koofr-compatible storage providers
\ (koofr)
[snip]
Storage> koofr
Option provider.
Choose your storage provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
1 / Koofr, https://app.koofr.net/
\ (koofr)
2022-03-08 11:56:53 +01:00
2 / Digi Storage, https://storage.rcs-rds.ro/
\ (digistorage)
2022-03-07 14:43:29 +01:00
3 / Any other Koofr API compatible storage service
\ (other)
provider> 3
Option endpoint.
The Koofr API endpoint to use.
Enter a value.
endpoint> https://koofr.other.org
Option user.
Your user name.
Enter a value.
user> USERNAME
Option password.
Your password for rclone (generate one at your service's settings page).
Choose an alternative below.
y) Yes, type in my own password
g) Generate random password
y/g> y
Enter the password:
password:
Confirm the password:
password:
Edit advanced config?
y) Yes
n) No (default)
y/n> n
--------------------
[other]
type = koofr
provider = other
endpoint = https://koofr.other.org
user = USERNAME
password = ** * ENCRYPTED ** *
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y
```