mirror of
https://github.com/rclone/rclone.git
synced 2024-11-27 10:54:56 +01:00
118a8b949e
Implemented a Koofr REST API backend. Added said backend to tests. Added documentation for said backend.
190 lines
4.3 KiB
Markdown
190 lines
4.3 KiB
Markdown
---
|
|
title: "Koofr"
|
|
description: "Rclone docs for Koofr"
|
|
date: "2019-02-25"
|
|
---
|
|
|
|
<i class="fa fa-suitcase"></i> Koofr
|
|
-----------------------------------------
|
|
|
|
Paths are specified as `remote:path`
|
|
|
|
Paths may be as deep as required, eg `remote:directory/subdirectory`.
|
|
|
|
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:
|
|
|
|
```
|
|
No remotes found - make a new one
|
|
n) New remote
|
|
s) Set configuration password
|
|
q) Quit config
|
|
n/s/q> n
|
|
name> koofr
|
|
Type of storage to configure.
|
|
Enter a string value. Press Enter for the default ("").
|
|
Choose a number from below, or type in your own value
|
|
1 / A stackable unification remote, which can appear to merge the contents of several remotes
|
|
\ "union"
|
|
2 / Alias for a existing remote
|
|
\ "alias"
|
|
3 / Amazon Drive
|
|
\ "amazon cloud drive"
|
|
4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)
|
|
\ "s3"
|
|
5 / Backblaze B2
|
|
\ "b2"
|
|
6 / Box
|
|
\ "box"
|
|
7 / Cache a remote
|
|
\ "cache"
|
|
8 / Dropbox
|
|
\ "dropbox"
|
|
9 / Encrypt/Decrypt a remote
|
|
\ "crypt"
|
|
10 / FTP Connection
|
|
\ "ftp"
|
|
11 / Google Cloud Storage (this is not Google Drive)
|
|
\ "google cloud storage"
|
|
12 / Google Drive
|
|
\ "drive"
|
|
13 / Hubic
|
|
\ "hubic"
|
|
14 / JottaCloud
|
|
\ "jottacloud"
|
|
15 / Koofr
|
|
\ "koofr"
|
|
16 / Local Disk
|
|
\ "local"
|
|
17 / Mega
|
|
\ "mega"
|
|
18 / Microsoft Azure Blob Storage
|
|
\ "azureblob"
|
|
19 / Microsoft OneDrive
|
|
\ "onedrive"
|
|
20 / OpenDrive
|
|
\ "opendrive"
|
|
21 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
|
|
\ "swift"
|
|
22 / Pcloud
|
|
\ "pcloud"
|
|
23 / QingCloud Object Storage
|
|
\ "qingstor"
|
|
24 / SSH/SFTP Connection
|
|
\ "sftp"
|
|
25 / Webdav
|
|
\ "webdav"
|
|
26 / Yandex Disk
|
|
\ "yandex"
|
|
27 / http Connection
|
|
\ "http"
|
|
Storage> koofr
|
|
** See help for koofr backend at: https://rclone.org/koofr/ **
|
|
|
|
Your Koofr user name
|
|
Enter a string value. Press Enter for the default ("").
|
|
user> USER@NAME
|
|
Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
|
|
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/n)
|
|
y) Yes
|
|
n) No
|
|
y/n> n
|
|
Remote config
|
|
--------------------
|
|
[koofr]
|
|
type = koofr
|
|
baseurl = https://app.koofr.net
|
|
user = USER@NAME
|
|
password = *** ENCRYPTED ***
|
|
--------------------
|
|
y) Yes this is OK
|
|
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
|
|
|
|
rclone copy /home/source remote:backup
|
|
|
|
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/koofr/koofr.go then run make backenddocs -->
|
|
### Standard Options
|
|
|
|
Here are the standard options specific to koofr (Koofr).
|
|
|
|
#### --koofr-user
|
|
|
|
Your Koofr user name
|
|
|
|
- Config: user
|
|
- Env Var: RCLONE_KOOFR_USER
|
|
- Type: string
|
|
- Default: ""
|
|
|
|
#### --koofr-password
|
|
|
|
Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)
|
|
|
|
- Config: password
|
|
- Env Var: RCLONE_KOOFR_PASSWORD
|
|
- Type: string
|
|
- Default: ""
|
|
|
|
### Advanced Options
|
|
|
|
Here are the advanced options specific to koofr (Koofr).
|
|
|
|
#### --koofr-baseurl
|
|
|
|
Base URL of the Koofr API to connect to
|
|
|
|
- Config: baseurl
|
|
- Env Var: RCLONE_KOOFR_BASEURL
|
|
- Type: string
|
|
- Default: "https://app.koofr.net"
|
|
|
|
#### --koofr-mountid
|
|
|
|
Mount ID of the mount to use. If omitted, the primary mount is used.
|
|
|
|
- Config: mountid
|
|
- Env Var: RCLONE_KOOFR_MOUNTID
|
|
- Type: string
|
|
- Default: ""
|
|
|
|
<!--- autogenerated options stop -->
|
|
|
|
### Limitations ###
|
|
|
|
Note that Koofr is case insensitive so you can't have a file called
|
|
"Hello.doc" and one called "hello.doc".
|