rclone/docs/content/jottacloud.md
Oliver Heyme 0d4a3520ad jottacloud: add device registration
jottacloud: Updated documenation
2019-04-11 16:31:27 +01:00

6.7 KiB
Raw Blame History

title description date
Jottacloud Rclone docs for Jottacloud 2018-08-07

Jottacloud

Paths are specified as remote:path

Paths may be as deep as required, eg remote:directory/subdirectory.

To configure Jottacloud you will need to enter your username and password and select a mountpoint.

Here is an example of how to make a remote called remote. 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> remote
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
[snip]
13 / JottaCloud
   \ "jottacloud"
[snip]
Storage> jottacloud
User Name
Enter a string value. Press Enter for the default ("").
user> user
The mountpoint to use.
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
 1 / Will be synced by the official client.
   \ "Sync"
 2 / Archive
   \ "Archive"
mountpoint> Archive
Edit advanced config? (y/n)
y) Yes
n) No
y/n> n
Remote config

Do you want to create a machine specific API key?

Rclone has it's own Jottacloud API KEY which works fine as long as one only uses rclone on a single machine. When you want to use rclone with this account on more than one machine it's recommended to create a machine specific API key. These keys can NOT be shared between machines.

y) Yes
n) No
y/n> y
Your Jottacloud password is only required during config and will not be stored.
password:
--------------------
[remote]
type = jottacloud
user = olihey
mountpoint = Archive
client_id = .....
client_secret = ........
token = {........}
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d> y

Once configured you can then use rclone like this,

List directories in top level of your Jottacloud

rclone lsd remote:

List all the files in your Jottacloud

rclone ls remote:

To copy a local directory to an Jottacloud directory called backup

rclone copy /home/source remote:backup

--fast-list

This remote supports --fast-list which allows you to use fewer
transactions in exchange for more memory. See the rclone
docs
for more details.

Note that the implementation in Jottacloud always uses only a single
API request to get the entire list, so for large folders this could
lead to long wait time before the first results are shown.

Modified time and hashes

Jottacloud allows modification times to be set on objects accurate to 1
second. These will be used to detect whether objects need syncing or
not.

Jottacloud supports MD5 type hashes, so you can use the --checksum
flag.

Note that Jottacloud requires the MD5 hash before upload so if the
source does not have an MD5 checksum then the file will be cached
temporarily on disk (wherever the TMPDIR environment variable points
to) before it is uploaded. Small files will be cached in memory - see
the --jottacloud-md5-memory-limit flag.

Deleting files

By default rclone will send all files to the trash when deleting files.
Due to a lack of API documentation emptying the trash is currently
only possible via the Jottacloud website. If deleting permanently
is required then use the --jottacloud-hard-delete flag,
or set the equivalent environment variable.

Versions

Jottacloud supports file versioning. When rclone uploads a new version of a file it creates a new version of it. Currently rclone only supports retrieving the current version but older versions can be accessed via the Jottacloud Website.

Quota information

To view your current quota you can use the rclone about remote:
command which will display your usage limit (unless it is unlimited)
and the current usage.

Device IDs

Jottacloud requires each 'device' to be registered. Rclone brings such a registration to easily access your account but if you want to use Jottacloud together with rclone on multiple machines you NEED to create a seperate deviceID/deviceSecrect on each machine. You will asked during setting up the remote. Please be aware that this also means that copying the rclone config from one machine to another does NOT work with Jottacloud accounts. You have to create it on each machine.

Standard Options

Here are the standard options specific to jottacloud (JottaCloud).

--jottacloud-user

User Name:

  • Config: user
  • Env Var: RCLONE_JOTTACLOUD_USER
  • Type: string
  • Default: ""

--jottacloud-mountpoint

The mountpoint to use.

  • Config: mountpoint
  • Env Var: RCLONE_JOTTACLOUD_MOUNTPOINT
  • Type: string
  • Default: ""
  • Examples:
    • "Sync"
      • Will be synced by the official client.
    • "Archive"
      • Archive

Advanced Options

Here are the advanced options specific to jottacloud (JottaCloud).

--jottacloud-md5-memory-limit

Files bigger than this will be cached on disk to calculate the MD5 if required.

  • Config: md5_memory_limit
  • Env Var: RCLONE_JOTTACLOUD_MD5_MEMORY_LIMIT
  • Type: SizeSuffix
  • Default: 10M

--jottacloud-hard-delete

Delete files permanently rather than putting them into the trash.

  • Config: hard_delete
  • Env Var: RCLONE_JOTTACLOUD_HARD_DELETE
  • Type: bool
  • Default: false

Remove existing public link to file/folder with link command rather than creating.
Default is false, meaning link command will create or retrieve public link.

  • Config: unlink
  • Env Var: RCLONE_JOTTACLOUD_UNLINK
  • Type: bool
  • Default: false

--jottacloud-upload-resume-limit

Files bigger than this can be resumed if the upload fail's.

  • Config: upload_resume_limit
  • Env Var: RCLONE_JOTTACLOUD_UPLOAD_RESUME_LIMIT
  • Type: SizeSuffix
  • Default: 10M

Limitations

Note that Jottacloud is case insensitive so you can't have a file called
"Hello.doc" and one called "hello.doc".

There are quite a few characters that can't be in Jottacloud file names. Rclone will map these names to and from an identical looking unicode equivalent. For example if a file has a ? in it will be mapped to instead.

Jottacloud only supports filenames up to 255 characters in length.

Troubleshooting

Jottacloud exhibits some inconsistent behaviours regarding deleted files and folders which may cause Copy, Move and DirMove operations to previously deleted paths to fail. Emptying the trash should help in such cases.