<p>Make sure you have at least <ahref="https://golang.org/">Go</a> 1.7 installed. <ahref="https://golang.org/dl/">Download go</a> if necessary. The latest release is recommended. Then</p>
<p>You can also build and install rclone in the <ahref="https://github.com/golang/go/wiki/GOPATH">GOPATH</a> (which defaults to <code>~/go</code>) with:</p>
<p>and this will build the binary in <code>$GOPATH/bin</code> (<code>~/go/bin/rclone</code> by default) after downloading the source to <code>$GOPATH/src/github.com/ncw/rclone</code> (<code>~/go/src/github.com/ncw/rclone</code> by default).</p>
<p>First, you'll need to configure rclone. As the object storage systems have quite complicated authentication these are kept in a config file. (See the <code>--config</code> entry for how to find the config file and choose its location.)</p>
<p>Source and destination paths are specified by the name you gave the storage system in the config file then the sub path, eg "drive:myfolder" to look at "myfolder" in Google drive.</p>
<p>You can define as many storage paths as you like in the config file.</p>
<p>Enter an interactive configuration session where you can setup new remotes and manage existing ones. You may also set or remove a password to protect your configuration.</p>
<p>Copy the source to the destination. Doesn't transfer unchanged files, testing by size and modification time or MD5SUM. Doesn't delete files from the destination.</p>
<p>Note that it is always the contents of the directory that is synced, not the directory so when source:path is a directory, it's the contents of source:path that are copied, not the directory name and contents.</p>
<p>If dest:path doesn't exist, it is created and the source:path contents go there.</p>
<p>Let's say there are two files in sourcepath</p>
<pre><code>sourcepath/one.txt
sourcepath/two.txt</code></pre>
<p>This copies them to</p>
<pre><code>destpath/one.txt
destpath/two.txt</code></pre>
<p>Not to</p>
<pre><code>destpath/sourcepath/one.txt
destpath/sourcepath/two.txt</code></pre>
<p>If you are familiar with <code>rsync</code>, rclone always works as if you had written a trailing / - meaning "copy the contents of this directory". This applies to all commands and whether you are talking about the source or destination.</p>
<p>See the <ahref="/docs/#no-traverse">--no-traverse</a> option for controlling whether rclone lists the destination directory or not. Supplying this option when copying a small number of files into a large destination can speed transfers up greatly.</p>
<p>For example, if you have many files in /path/to/src but only a few of them change every day, you can to copy all the files which have changed recently very efficiently like this:</p>
<p>Sync the source to the destination, changing the destination only. Doesn't transfer unchanged files, testing by size and modification time or MD5SUM. Destination is updated to match source, including deleting files if necessary.</p>
<p><strong>Important</strong>: Since this can cause data loss, test first with the <code>--dry-run</code> flag to see exactly what would be copied and deleted.</p>
<p>Note that files in the destination won't be deleted if there were any errors at any point.</p>
<p>It is always the contents of the directory that is synced, not the directory so when source:path is a directory, it's the contents of source:path that are copied, not the directory name and contents. See extended explanation in the <code>copy</code> command above if unsure.</p>
<p>If dest:path doesn't exist, it is created and the source:path contents go there.</p>
<p>Moves the contents of the source directory to the destination directory. Rclone will error if the source and destination overlap and the remote does not support a server side directory move operation.</p>
<p>If no filters are in use and if possible this will server side move <code>source:path</code> into <code>dest:path</code>. After this <code>source:path</code> will no longer longer exist.</p>
<p>Otherwise for each file in <code>source:path</code> selected by the filters (if any) this will move it into <code>dest:path</code>. If possible a server side move will be used, otherwise it will copy it (server side if possible) into <code>dest:path</code> then delete the original (if no errors on copy) in <code>source:path</code>.</p>
<p>See the <ahref="/docs/#no-traverse">--no-traverse</a> option for controlling whether rclone lists the destination directory or not. Supplying this option when moving a small number of files into a large destination can speed transfers up greatly.</p>
<p>Remove the files in path. Unlike <code>purge</code> it obeys include/exclude filters so can be used to selectively delete files.</p>
<p><code>rclone delete</code> only deletes objects but leaves the directory structure alone. If you want to delete a directory and all of its contents use <code>rclone purge</code></p>
<p>Remove the path and all of its contents. Note that this does not obey include/exclude filters - everything will be removed. Use <code>delete</code> if you want to selectively delete files.</p>
<p>Checks the files in the source and destination match. It compares sizes and hashes (MD5 or SHA1) and logs a report of files which don't match. It doesn't alter the source or destination.</p>
<p>If you supply the --size-only flag, it will only compare the sizes not the hashes as well. Use this for a quick check.</p>
<p>If you supply the --download flag, it will download the data from both remotes and check them against each other on the fly. This can be useful for remotes that don't support hashes or if you really want to check all the data.</p>
<p>If you supply the --one-way flag, it will only check that files in source match the files in destination, not the other way around. Meaning extra files in destination that are not in the source will not trigger an error.</p>
<p>Any of the filtering options can be applied to this commmand.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse format</li>
<li><code>lsjson</code> to list objects and directories in JSON format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use "--max-depth 1" to stop the recursion.</p>
<p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use "-R" to make them recurse.</p>
<p>Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p>
<p>Lists the directories in the source path to standard output. Does not recurse by default. Use the -R flag to recurse.</p>
<p>This command lists the total size of the directory (if known, -1 if not), the modification time (if known, the current time if not), the number of objects in the directory (if known, -1 if not) and the name of the directory, Eg</p>
<pre><code>$ rclone lsd swift:
494000 2018-04-26 08:43:20 10000 10000files
65 2018-04-26 08:43:20 1 1File</code></pre>
<p>Or</p>
<pre><code>$ rclone lsd drive:test
-1 2016-10-17 17:41:53 -1 1000files
-1 2017-01-03 14:40:54 -1 2500files
-1 2017-07-08 14:39:28 -1 4000files</code></pre>
<p>If you just want the directory names use "rclone lsf --dirs-only".</p>
<p>Any of the filtering options can be applied to this commmand.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse format</li>
<li><code>lsjson</code> to list objects and directories in JSON format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use "--max-depth 1" to stop the recursion.</p>
<p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use "-R" to make them recurse.</p>
<p>Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p>
<p>Any of the filtering options can be applied to this commmand.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse format</li>
<li><code>lsjson</code> to list objects and directories in JSON format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use "--max-depth 1" to stop the recursion.</p>
<p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use "-R" to make them recurse.</p>
<p>Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p>
<p>By default <code>dedupe</code> interactively finds duplicate files and offers to delete all but one or rename them to be different. Only useful with Google Drive which can have duplicate file names.</p>
<p>In the first pass it will merge directories with the same name. It will do this iteratively until all the identical directories have been merged.</p>
<p>The <code>dedupe</code> command will delete all but one of any identical (same md5sum) files it finds without confirmation. This means that for most duplicated files the <code>dedupe</code> command will not be interactive. You can use <code>--dry-run</code> to see what would happen without doing anything.</p>
<p>Get quota information from the remote, like bytes used/free/quota and bytes used in the trash. Not supported by all remotes.</p>
<p>This will print to stdout something like this:</p>
<pre><code>Total: 17G
Used: 7.444G
Free: 1.315G
Trashed: 100.000M
Other: 8.241G</code></pre>
<p>Where the fields are:</p>
<ul>
<li>Total: total size available.</li>
<li>Used: total size used</li>
<li>Free: total amount this user could upload.</li>
<li>Trashed: total amount in the trash</li>
<li>Other: total amount in other storage (eg Gmail, Google Photos)</li>
<li>Objects: total number of objects in the storage</li>
</ul>
<p>Note that not all the backends provide all the fields - they will be missing if they are not known for that backend. Where it is known that the value is unlimited the value will also be omitted.</p>
<p>Use the --full flag to see the numbers written out in full, eg</p>
<pre><code>Total: 18253611008
Used: 7993453766
Free: 1411001220
Trashed: 104857602
Other: 8849156022</code></pre>
<p>Use the --json flag for a computer readable output, eg</p>
<pre><code>{
"total": 18253611008,
"used": 7993453766,
"trashed": 104857602,
"other": 8849156022,
"free": 1411001220
}</code></pre>
<pre><code>rclone about remote: [flags]</code></pre>
<h3id="options-18">Options</h3>
<pre><code> --full Full numbers instead of SI units
<p>Use the --head flag to print characters only at the start, --tail for the end and --offset and --count to print a section in the middle. Note that if offset is negative it will count from the end, so --offset -1 --count 1 is equivalent to --tail 1.</p>
<p>Note that if the config process would normally ask a question the default is taken. Each time that happens rclone will print a message saying how to affect the value taken.</p>
<p>So for example if you wanted to configure a Google Drive remote but using remote authorization you would do this:</p>
<p>Enter an interactive configuration session where you can setup new remotes and manage existing ones. You may also set or remove a password to protect your configuration.</p>
<p>If source:path is a file or directory then it copies it to a file or directory named dest:path.</p>
<p>This can be used to upload single files to other than their current name. If the source is a directory then it acts exactly like the copy command.</p>
<p>So</p>
<pre><code>rclone copyto src dst</code></pre>
<p>where src and dst are rclone paths, either remote:path or /path/to/local or C:.</p>
<p>This will:</p>
<pre><code>if src is file
copy it to dst, overwriting an existing file if it exists
if src is directory
copy it to dst, overwriting existing files if they exist
see copy command for full details</code></pre>
<p>This doesn't transfer unchanged files, testing by size and modification time or MD5SUM. It doesn't delete files from the destination.</p>
<p>rclone cryptcheck checks a remote against a crypted remote. This is the equivalent of running rclone check, but able to check the checksums of the crypted remote.</p>
<p>For it to work the underlying remote of the cryptedremote must support some kind of checksum.</p>
<p>It works by reading the nonce from each file on the cryptedremote: and using that to encrypt each file on the remote:. It then checks the checksum of the underlying file on the cryptedremote: against the checksum of the file it has just encrypted.</p>
<p>If you supply the --one-way flag, it will only check that files in source match the files in destination, not the other way around. Meaning extra files in destination that are not in the source will not trigger an error.</p>
<p>Produces a Dropbox hash file for all the objects in the path. The hashes are calculated according to <ahref="https://www.dropbox.com/developers/reference/content-hash">Dropbox content hash rules</a>. The output is in the same format as md5sum and sha1sum.</p>
<p>Remove a single file from remote. Unlike <code>delete</code> it cannot be used to remove a directory and it doesn't obey include/exclude filters - if the specified file exists, it will always be removed.</p>
<p>This produces markdown docs for the rclone commands to the directory supplied. These are in a format suitable for hugo to render into the rclone.org website.</p>
<p>Produces a hash file for all the objects in the path using the hash named. The output is in the same format as the standard md5sum/sha1sum tool.</p>
<p>Run without a hash to see the list of supported hashes, eg</p>
<p>rclone link will create or retrieve a public link to the given file or folder.</p>
<pre><code>rclone link remote:path/to/file
rclone link remote:path/to/folder/</code></pre>
<p>If successful, the last line of the output will contain the link. Exact capabilities depend on the remote, but the link will always be created with the least constraints – e.g. no expiry, no password protection, accessible without account.</p>
<pre><code>rclone link remote:path [flags]</code></pre>
<p>List the contents of the source path (directories and objects) to standard output in a form which is easy to parse by scripts. By default this will just be the names of the objects and directories, one per line. The directories will have a / suffix.</p>
<p>So if you wanted the path, size and modification time, you would use --format "pst", or maybe --format "tsp" to put the path last.</p>
<p>If you specify "h" in the format you will get the MD5 hash by default, use the "--hash" flag to change which hash you want. Note that this can be returned as an empty string if it isn't available on the object (and for directories), "ERROR" if there was an error reading it from the object and "UNSUPPORTED" if that object does not support that hash type.</p>
<p>For example to emulate the md5sum command you can use</p>
<p>(Though "rclone md5sum ." is an easier way of typing this.)</p>
<p>By default the separator is ";" this can be changed with the --separator flag. Note that separators aren't escaped in the path so putting it last is a good strategy.</p>
<p>Any of the filtering options can be applied to this commmand.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse format</li>
<li><code>lsjson</code> to list objects and directories in JSON format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use "--max-depth 1" to stop the recursion.</p>
<p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use "-R" to make them recurse.</p>
<p>Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p>
<p>If --encrypted is not specified the Encrypted won't be emitted.</p>
<p>The Path field will only show folders below the remote path being listed. If "remote:path" contains the file "subfolder/file.txt", the Path for "file.txt" will be "subfolder/file.txt", not "remote:path/subfolder/file.txt". When used without --recursive the Path will always be the same as Name.</p>
<p>The time is in RFC3339 format with up to nanosecond precision. The number of decimal digits in the seconds will depend on the precision that the remote can hold the times, so if times are accurate to the nearest millisecond (eg Google Drive) then 3 digits will always be shown ("2017-05-31T16:15:57.034+01:00") whereas if the times are accurate to the nearest second (Dropbox, Box, WebDav etc) no digits will be shown ("2017-05-31T16:15:57+01:00").</p>
<p>Any of the filtering options can be applied to this commmand.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse format</li>
<li><code>lsjson</code> to list objects and directories in JSON format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use "--max-depth 1" to stop the recursion.</p>
<p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use "-R" to make them recurse.</p>
<p>Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p>
<p>When the program ends, either via Ctrl+C or receiving a SIGINT or SIGTERM signal, the mount is automatically stopped.</p>
<p>The umount operation can fail, for example when the mountpoint is busy. When that happens, it is the user's responsibility to stop the mount manually with</p>
<h3id="installing-on-windows">Installing on Windows</h3>
<p>To run rclone mount on Windows, you will need to download and install <ahref="http://www.secfs.net/winfsp/">WinFsp</a>.</p>
<p>WinFsp is an <ahref="https://github.com/billziss-gh/winfsp">open source</a> Windows File System Proxy which makes it easy to write user space file systems for Windows. It provides a FUSE emulation layer which rclone uses combination with <ahref="https://github.com/billziss-gh/cgofuse">cgofuse</a>. Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone mount for Windows.</p>
<h4id="windows-caveats">Windows caveats</h4>
<p>Note that drives created as Administrator are not visible by other accounts (including the account that was elevated as Administrator). So if you start a Windows drive from an Administrative Command Prompt and then try to access the same drive from Explorer (which does not run as Administrator), you will not be able to see the new drive.</p>
<p>The easiest way around this is to start the drive from a normal command prompt. It is also possible to start a drive from the SYSTEM account (using <ahref="https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture">the WinFsp.Launcher infrastructure</a>) which creates drives accessible for everyone on the system or alternatively using <ahref="https://nssm.cc/usage">the nssm service manager</a>.</p>
<p>Without the use of "--vfs-cache-mode" this can only write files sequentially, it can only seek when reading. This means that many applications won't work with their files on an rclone mount without "--vfs-cache-mode writes" or "--vfs-cache-mode full". See the <ahref="#file-caching">File Caching</a> section for more info.</p>
<p>The bucket based remotes (eg Swift, S3, Google Compute Storage, B2, Hubic) won't work from the root - you will need to specify a bucket, or a path within the bucket. So <code>swift:</code> won't work whereas <code>swift:bucket</code> will as will <code>swift:bucket/path</code>. None of these support the concept of directories, so empty directories will have a tendency to disappear once they fall out of the directory cache.</p>
<p>File systems expect things to be 100% reliable, whereas cloud storage systems are a long way from 100% reliable. The rclone sync/copy commands cope with this with lots of retries. However rclone mount can't use retries in the same way without making local copies of the uploads. Look at the <ahref="#file-caching">file caching</a> for solutions to make mount more reliable.</p>
<p>The default is "1s" which caches files just long enough to avoid too many callbacks to rclone from the kernel.</p>
<p>In theory 0s should be the correct value for filesystems which can change outside the control of the kernel. However this causes quite a few problems such as <ahref="https://github.com/ncw/rclone/issues/2157">rclone using too much memory</a>, <ahref="https://forum.rclone.org/t/rclone-1-39-vs-1-40-mount-issue/5112">rclone not serving files to samba</a> and <ahref="https://github.com/ncw/rclone/issues/2095#issuecomment-371141147">excessive time listing directories</a>.</p>
<p>The kernel can cache the info about a file for the time given by "--attr-timeout". You may see corruption if the remote file changes length during this window. It will show up as either a truncated file or a file with garbage on the end. With "--attr-timeout 1s" this is very unlikely but not impossible. The higher you set "--attr-timeout" the more likely it is. The default setting of "1s" is the lowest setting which mitigates the problems above.</p>
<p>If you set it higher ('10s' or '1m' say) then the kernel will call back to rclone less often making it more efficient, however there is more chance of the corruption issue above.</p>
<p>If files don't change on the remote outside of the control of rclone then there is no chance of corruption.</p>
<p>When running rclone mount as a systemd service, it is possible to use Type=notify. In this case the service will enter the started state after the mountpoint has been successfully set up. Units having the rclone mount service specified as a requirement will see all files and folders immediately in this mode.</p>
<p>--vfs-read-chunk-size will enable reading the source objects in parts. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read at the cost of an increased number of requests.</p>
<p>When --vfs-read-chunk-size-limit is also specified and greater than --vfs-read-chunk-size, the chunk size for each open file will get doubled for each chunk read, until the specified value is reached. A value of -1 will disable the limit and the chunk size will grow indefinitely.</p>
<p>With --vfs-read-chunk-size 100M and --vfs-read-chunk-size-limit 0 the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When --vfs-read-chunk-size-limit 500M is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.</p>
<p>Chunked reading will only work with --vfs-cache-mode < full, as the file will always be copied to the vfs cache before opening with --vfs-cache-mode full.</p>
<p>Using the <code>--dir-cache-time</code> flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate the cache. However, changes done on the remote will only be picked up once the cache expires.</p>
<p>Alternatively, you can send a <code>SIGHUP</code> signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this:</p>
<p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p>
<p>Each open file descriptor will try to keep the specified amount of data in memory at all times. The buffered data is bound to one file descriptor and won't be shared between multiple open file descriptors of the same file.</p>
<p>This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p>
<p>These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system.</p>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed so if rclone is quit or dies with open files then these won't get written back to the remote. However they will still be in the on disk cache.</p>
<p>If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.</p>
<p>This is very similar to "off" except that files opened for read AND write will be buffered to disks. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<p>This may be appropriate for your needs, or you may prefer to look at the cache backend which does a much more sophisticated job of caching, including caching directory hierarchies and chunks of files.</p>
<p>In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to <code>--vfs-cache-max-age</code>.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload or download fails it will be retried up to --low-level-retries times.</p>
--fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp. Repeat if required.
--gid uint32 Override the gid field set by the filesystem. (default 502)
-h, --help help for mount
--max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. (default 128k)
--no-checksum Don't compare checksums on up/download.
--no-modtime Don't read/write the modification time (can speed things up).
--no-seek Don't allow seeking in files.
-o, --option stringArray Option for libfuse/WinFsp. Repeat if required.
--poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s)
--read-only Mount read-only.
--uid uint32 Override the uid field set by the filesystem. (default 502)
--umask int Override the permission bits set by the filesystem.
--vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off)
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s)
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M)
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off)
--volname string Set the volume name (not supported by all OSes).
--write-back-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used.</code></pre>
<p>If source:path is a file or directory then it moves it to a file or directory named dest:path.</p>
<p>This can be used to rename files or upload single files to other than their existing name. If the source is a directory then it acts exacty like the move command.</p>
<p>So</p>
<pre><code>rclone moveto src dst</code></pre>
<p>where src and dst are rclone paths, either remote:path or /path/to/local or C:.</p>
<p>This will:</p>
<pre><code>if src is file
move it to dst, overwriting an existing file if it exists
if src is directory
move it to dst, overwriting existing files if they exist
see move command for full details</code></pre>
<p>This doesn't transfer unchanged files, testing by size and modification time or MD5SUM. src will be deleted on successful transfer.</p>
<p><strong>Important</strong>: Since this can cause data loss, test first with the --dry-run flag.</p>
<p>This displays a text based user interface allowing the navigation of a remote. It is most useful for answering the question - "What is using all my disk space?".</p>
<p>To make the user interface it first scans the entire remote given and builds an in memory representation. rclone ncdu can be used during this scanning phase and you will see it building up the directory structure as it goes along.</p>
<p>Here are the keys - press '?' to toggle the help on and off</p>
<p>This an homage to the <ahref="https://dev.yorhel.nl/ncdu">ncdu tool</a> but for rclone remotes. It is missing lots of features at the moment but is useful as it stands.</p>
<p>Note that it might take some time to delete big files/folders. The UI won't respond in the meantime since the deletion is done synchronously.</p>
<p>This runs a command against a running rclone. Use the --url flag to specify an non default URL to connect on. This can be either a ":port" which is taken to mean "http://localhost:port" or a "host:port" which is taken to mean "http://host:port"</p>
<p>A username and password can be passed in with --user and --pass.</p>
<p>Note that --rc-addr, --rc-user, --rc-pass will be read also for --url, --user, --pass.</p>
<p>The --json parameter can be used to pass in a JSON blob as an input instead of key=value arguments. This is the only way of passing in more complicated values.</p>
<p>If the remote file already exists, it will be overwritten.</p>
<p>rcat will try to upload small files in a single request, which is usually more efficient than the streaming/chunked upload endpoints, which use multiple requests. Exact behaviour depends on the remote. What is considered a small file may be set through <code>--streaming-upload-cutoff</code>. Uploading only starts after the cutoff is reached or if the file ends before that. The data must fit into RAM. The cutoff needs to be small enough to adhere the limits of your remote, please see there. Generally speaking, setting this cutoff too high will decrease your performance.</p>
<p>Note that the upload can also not be retried because the data is not kept around until the upload succeeds. If you need to transfer a lot of data, you're better off caching locally and then <code>rclone move</code> it to the destination.</p>
<p>This is useful if you are controlling rclone via the rc API.</p>
<p>If you pass in a path to a directory, rclone will serve that directory for GET requests on the URL passed in. It will also open the URL in the browser when rclone is run.</p>
<p>See the <ahref="https://rclone.org/rc/">rc documentation</a> for more info on the rc flags.</p>
<pre><code>rclone rcd <path to files to serve>* [flags]</code></pre>
<p>This removes any empty directories (or directories that only contain empty directories) under the path that it finds, including the path if it has nothing in.</p>
<p>rclone serve dlna is a DLNA media server for media stored in a rclone remote. Many devices, such as the Xbox and PlayStation, can automatically discover this server in the LAN and play audio/video from it. VLC is also supported. Service discovery uses UDP multicast packets (SSDP) and will thus only work on LANs.</p>
<p>Rclone will list all files present in the remote, without filtering based on media formats or file extensions. Additionally, there is no media transcoding support. This means that some players might show files that they are not able to play back correctly.</p>
<p>Using the <code>--dir-cache-time</code> flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate the cache. However, changes done on the remote will only be picked up once the cache expires.</p>
<p>Alternatively, you can send a <code>SIGHUP</code> signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this:</p>
<p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p>
<p>Each open file descriptor will try to keep the specified amount of data in memory at all times. The buffered data is bound to one file descriptor and won't be shared between multiple open file descriptors of the same file.</p>
<p>This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p>
<h3id="file-caching-1">File Caching</h3>
<p>These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system.</p>
<p>You'll need to enable VFS caching if you want, for example, to read and write simultaneously to a file. See below for more details.</p>
<p>Note that the VFS cache works in addition to the cache backend and you may find that you need one or the other or both.</p>
<pre><code>--cache-dir string Directory rclone will use for caching.
--vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s)
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed so if rclone is quit or dies with open files then these won't get written back to the remote. However they will still be in the on disk cache.</p>
<p>If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.</p>
<p>This is very similar to "off" except that files opened for read AND write will be buffered to disks. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<p>In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first.</p>
<p>This may be appropriate for your needs, or you may prefer to look at the cache backend which does a much more sophisticated job of caching, including caching directory hierarchies and chunks of files.</p>
<p>In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to <code>--vfs-cache-max-age</code>.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload or download fails it will be retried up to --low-level-retries times.</p>
--gid uint32 Override the gid field set by the filesystem. (default 502)
-h, --help help for dlna
--no-checksum Don't compare checksums on up/download.
--no-modtime Don't read/write the modification time (can speed things up).
--no-seek Don't allow seeking in files.
--poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s)
--read-only Mount read-only.
--uid uint32 Override the uid field set by the filesystem. (default 502)
--umask int Override the permission bits set by the filesystem. (default 2)
--vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off)
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s)
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M)
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off)</code></pre>
<h2id="rclone-serve-ftp">rclone serve ftp</h2>
<p>Serve remote:path over FTP.</p>
<h3id="synopsis-56">Synopsis</h3>
<p>rclone serve ftp implements a basic ftp server to serve the remote over FTP protocol. This can be viewed with a ftp client or you can make a remote of type ftp to read and write it.</p>
<h3id="server-options-1">Server options</h3>
<p>Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.</p>
<p>If you set --addr to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info.</p>
<h4id="authentication">Authentication</h4>
<p>By default this will serve files without needing a login.</p>
<p>You can set a single username and password with the --user and --pass flags.</p>
<h3id="directory-cache-2">Directory Cache</h3>
<p>Using the <code>--dir-cache-time</code> flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate the cache. However, changes done on the remote will only be picked up once the cache expires.</p>
<p>Alternatively, you can send a <code>SIGHUP</code> signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this:</p>
<p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p>
<p>Each open file descriptor will try to keep the specified amount of data in memory at all times. The buffered data is bound to one file descriptor and won't be shared between multiple open file descriptors of the same file.</p>
<p>This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p>
<h3id="file-caching-2">File Caching</h3>
<p>These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system.</p>
<p>You'll need to enable VFS caching if you want, for example, to read and write simultaneously to a file. See below for more details.</p>
<p>Note that the VFS cache works in addition to the cache backend and you may find that you need one or the other or both.</p>
<pre><code>--cache-dir string Directory rclone will use for caching.
--vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s)
--vfs-cache-max-size int Max total size of objects in the cache. (default off)</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed so if rclone is quit or dies with open files then these won't get written back to the remote. However they will still be in the on disk cache.</p>
<p>If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.</p>
<p>This is very similar to "off" except that files opened for read AND write will be buffered to disks. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<p>In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first.</p>
<p>This may be appropriate for your needs, or you may prefer to look at the cache backend which does a much more sophisticated job of caching, including caching directory hierarchies and chunks of files.</p>
<p>In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to <code>--vfs-cache-max-age</code>.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload or download fails it will be retried up to --low-level-retries times.</p>
--gid uint32 Override the gid field set by the filesystem. (default 502)
-h, --help help for ftp
--no-checksum Don't compare checksums on up/download.
--no-modtime Don't read/write the modification time (can speed things up).
--no-seek Don't allow seeking in files.
--pass string Password for authentication. (empty value allow every password)
--passive-port string Passive port range to use. (default "30000-32000")
--poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s)
--read-only Mount read-only.
--uid uint32 Override the uid field set by the filesystem. (default 502)
--umask int Override the permission bits set by the filesystem. (default 2)
--user string User name for authentication. (default "anonymous")
--vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off)
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s)
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M)
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off)</code></pre>
<p>rclone serve http implements a basic web server to serve the remote over HTTP. This can be viewed in a web browser or you can make a remote of type http read from it.</p>
<p>You can use the filter flags (eg --include, --exclude) to control what is served.</p>
<p>The server will log errors. Use -v to see access logs.</p>
<p>--bwlimit will be respected for file transfers. Use --stats to control the stats printing.</p>
<p>Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.</p>
<p>If you set --addr to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info.</p>
<p>--server-read-timeout and --server-write-timeout can be used to control the timeouts on the server. Note that this is the total time for a transfer.</p>
<p>--max-header-bytes controls the maximum number of bytes the server will accept in the HTTP header.</p>
<p>By default this will serve files without needing a login.</p>
<p>You can either use an htpasswd file which can take lots of users, or set a single username and password with the --user and --pass flags.</p>
<p>Use --htpasswd /path/to/htpasswd to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended.</p>
<p>To create an htpasswd file:</p>
<pre><code>touch htpasswd
htpasswd -B htpasswd user
htpasswd -B htpasswd anotherUser</code></pre>
<p>The password file can be updated while rclone is running.</p>
<p>Use --realm to set the authentication realm.</p>
<h4id="ssltls">SSL/TLS</h4>
<p>By default this will serve over http. If you want you can serve over https. You will need to supply the --cert and --key flags. If you wish to do client side certificate validation then you will need to supply --client-ca also.</p>
<p>--cert should be a either a PEM encoded certificate or a concatenation of that with the CA certificate. --key should be the PEM encoded private key and --client-ca should be the PEM encoded client certificate authority certificate.</p>
<p>Using the <code>--dir-cache-time</code> flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate the cache. However, changes done on the remote will only be picked up once the cache expires.</p>
<p>Alternatively, you can send a <code>SIGHUP</code> signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this:</p>
<p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p>
<p>Each open file descriptor will try to keep the specified amount of data in memory at all times. The buffered data is bound to one file descriptor and won't be shared between multiple open file descriptors of the same file.</p>
<p>This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p>
<p>These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system.</p>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed so if rclone is quit or dies with open files then these won't get written back to the remote. However they will still be in the on disk cache.</p>
<p>If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.</p>
<p>This is very similar to "off" except that files opened for read AND write will be buffered to disks. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<p>This may be appropriate for your needs, or you may prefer to look at the cache backend which does a much more sophisticated job of caching, including caching directory hierarchies and chunks of files.</p>
<p>In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to <code>--vfs-cache-max-age</code>.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload or download fails it will be retried up to --low-level-retries times.</p>
--gid uint32 Override the gid field set by the filesystem. (default 502)
-h, --help help for http
--htpasswd string htpasswd file - if not provided no authentication is done
--key string SSL PEM Private key
--max-header-bytes int Maximum size of request header (default 4096)
--no-checksum Don't compare checksums on up/download.
--no-modtime Don't read/write the modification time (can speed things up).
--no-seek Don't allow seeking in files.
--pass string Password for authentication.
--poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s)
--read-only Mount read-only.
--realm string realm for authentication (default "rclone")
--server-read-timeout duration Timeout for server reading data (default 1h0m0s)
--server-write-timeout duration Timeout for server writing data (default 1h0m0s)
--uid uint32 Override the uid field set by the filesystem. (default 502)
--umask int Override the permission bits set by the filesystem. (default 2)
--user string User name for authentication.
--vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off)
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s)
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M)
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off)</code></pre>
<p>rclone serve restic implements restic's REST backend API over HTTP. This allows restic to use rclone as a data storage mechanism for cloud providers that restic does not support directly.</p>
<p><ahref="https://restic.net/">Restic</a> is a command line program for doing backups.</p>
<p>The server will log errors. Use -v to see access logs.</p>
<p>--bwlimit will be respected for file transfers. Use --stats to control the stats printing.</p>
<h3id="setting-up-rclone-for-use-by-restic">Setting up rclone for use by restic</h3>
<p>First <ahref="/docs/#configure">set up a remote for your chosen cloud provider</a>.</p>
<p>Once you have set up the remote, check it is working with, for example "rclone lsd remote:". You may have called the remote something other than "remote:" - just substitute whatever you called it in the following instructions.</p>
<p>Where you can replace "backup" in the above by whatever path in the remote you wish to use.</p>
<p>By default this will serve on "localhost:8080" you can change this with use of the "--addr" flag.</p>
<p>You might wish to start this server on boot.</p>
<h3id="setting-up-restic-to-use-rclone">Setting up restic to use rclone</h3>
<p>Now you can <ahref="http://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#rest-server">follow the restic instructions</a> on setting up restic.</p>
<p>Note that you will need restic 0.8.2 or later to interoperate with rclone.</p>
<p>For the example above you will want to use "http://localhost:8080/" as the URL for the REST server.</p>
<p>Note that you can use the endpoint to host multiple repositories. Do this by adding a directory name or path after the URL. Note that these <strong>must</strong> end with /. Eg</p>
<p>Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.</p>
<p>If you set --addr to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info.</p>
<p>--server-read-timeout and --server-write-timeout can be used to control the timeouts on the server. Note that this is the total time for a transfer.</p>
<p>--max-header-bytes controls the maximum number of bytes the server will accept in the HTTP header.</p>
<p>By default this will serve files without needing a login.</p>
<p>You can either use an htpasswd file which can take lots of users, or set a single username and password with the --user and --pass flags.</p>
<p>Use --htpasswd /path/to/htpasswd to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended.</p>
<p>To create an htpasswd file:</p>
<pre><code>touch htpasswd
htpasswd -B htpasswd user
htpasswd -B htpasswd anotherUser</code></pre>
<p>The password file can be updated while rclone is running.</p>
<p>Use --realm to set the authentication realm.</p>
<h4id="ssltls-1">SSL/TLS</h4>
<p>By default this will serve over http. If you want you can serve over https. You will need to supply the --cert and --key flags. If you wish to do client side certificate validation then you will need to supply --client-ca also.</p>
<p>--cert should be a either a PEM encoded certificate or a concatenation of that with the CA certificate. --key should be the PEM encoded private key and --client-ca should be the PEM encoded client certificate authority certificate.</p>
<p>rclone serve webdav implements a basic webdav server to serve the remote over HTTP via the webdav protocol. This can be viewed with a webdav client or you can make a remote of type webdav to read and write it.</p>
<p>This controls the ETag header. Without this flag the ETag will be based on the ModTime and Size of the object.</p>
<p>If this flag is set to "auto" then rclone will choose the first supported hash on the backend or you can use a named hash such as "MD5" or "SHA-1".</p>
<p>Use "rclone hashsum" to see the full list.</p>
<p>Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.</p>
<p>If you set --addr to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info.</p>
<p>--server-read-timeout and --server-write-timeout can be used to control the timeouts on the server. Note that this is the total time for a transfer.</p>
<p>--max-header-bytes controls the maximum number of bytes the server will accept in the HTTP header.</p>
<p>By default this will serve files without needing a login.</p>
<p>You can either use an htpasswd file which can take lots of users, or set a single username and password with the --user and --pass flags.</p>
<p>Use --htpasswd /path/to/htpasswd to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended.</p>
<p>To create an htpasswd file:</p>
<pre><code>touch htpasswd
htpasswd -B htpasswd user
htpasswd -B htpasswd anotherUser</code></pre>
<p>The password file can be updated while rclone is running.</p>
<p>Use --realm to set the authentication realm.</p>
<h4id="ssltls-2">SSL/TLS</h4>
<p>By default this will serve over http. If you want you can serve over https. You will need to supply the --cert and --key flags. If you wish to do client side certificate validation then you will need to supply --client-ca also.</p>
<p>--cert should be a either a PEM encoded certificate or a concatenation of that with the CA certificate. --key should be the PEM encoded private key and --client-ca should be the PEM encoded client certificate authority certificate.</p>
<p>Using the <code>--dir-cache-time</code> flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate the cache. However, changes done on the remote will only be picked up once the cache expires.</p>
<p>Alternatively, you can send a <code>SIGHUP</code> signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this:</p>
<p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p>
<p>Each open file descriptor will try to keep the specified amount of data in memory at all times. The buffered data is bound to one file descriptor and won't be shared between multiple open file descriptors of the same file.</p>
<p>This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p>
<p>These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system.</p>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed so if rclone is quit or dies with open files then these won't get written back to the remote. However they will still be in the on disk cache.</p>
<p>If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.</p>
<p>This is very similar to "off" except that files opened for read AND write will be buffered to disks. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<p>This may be appropriate for your needs, or you may prefer to look at the cache backend which does a much more sophisticated job of caching, including caching directory hierarchies and chunks of files.</p>
<p>In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to <code>--vfs-cache-max-age</code>.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload or download fails it will be retried up to --low-level-retries times.</p>
--gid uint32 Override the gid field set by the filesystem. (default 502)
-h, --help help for webdav
--htpasswd string htpasswd file - if not provided no authentication is done
--key string SSL PEM Private key
--max-header-bytes int Maximum size of request header (default 4096)
--no-checksum Don't compare checksums on up/download.
--no-modtime Don't read/write the modification time (can speed things up).
--no-seek Don't allow seeking in files.
--pass string Password for authentication.
--poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s)
--read-only Mount read-only.
--realm string realm for authentication (default "rclone")
--server-read-timeout duration Timeout for server reading data (default 1h0m0s)
--server-write-timeout duration Timeout for server writing data (default 1h0m0s)
--uid uint32 Override the uid field set by the filesystem. (default 502)
--umask int Override the permission bits set by the filesystem. (default 2)
--user string User name for authentication.
--vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off)
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s)
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M)
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off)</code></pre>
<p>rclone settier changes storage tier or class at remote if supported. Few cloud storage services provides different storage classes on objects, for example AWS S3 and Glacier, Azure Blob storage - Hot, Cool and Archive, Google Cloud Storage, Regional Storage, Nearline, Coldline etc.</p>
<p>Note that, certain tier chages make objects not available to access immediately. For example tiering to archive in azure blob storage makes objects in frozen state, user can restore by setting tier to Hot/Cool, similarly S3 to Glacier makes object inaccessible.true</p>
-C, --no-create Do not create the file if it does not exist.
-t, --timestamp string Change the modification times to the specified time instead of the current time of day. The argument is of the form 'YYMMDD' (ex. 17.10.30) or 'YYYY-MM-DDTHH:MM:SS' (ex. 2006-01-02T15:04:05)</code></pre>
<p>rclone tree lists the contents of a remote in a similar way to the unix tree command.</p>
<p>For example</p>
<pre><code>$ rclone tree remote:path
/
├── file1
├── file2
├── file3
└── subdir
├── file4
└── file5
1 directories, 5 files</code></pre>
<p>You can use any of the filtering options with the tree command (eg --include and --exclude). You can also use --fast-list.</p>
<p>The tree command has many options for controlling the listing which are compatible with the tree command. Note that not all of them have short options as they conflict with rclone's short options.</p>
<pre><code>rclone tree remote:path [flags]</code></pre>
<p>rclone normally syncs or copies directories. However, if the source remote points to a file, rclone will just copy that file. The destination remote must point to a directory - rclone will give the error <code>Failed to create file system for "remote:file": is a file not a directory</code> if it isn't.</p>
<p>It is recommended to use <code>copy</code> when copying individual files, not <code>sync</code>. They have pretty much the same effect but <code>copy</code> will use a lot less memory.</p>
<h2id="syntax-of-remote-paths">Syntax of remote paths</h2>
<p>The syntax of the paths passed to the rclone command are as follows.</p>
<h3id="pathtodir">/path/to/dir</h3>
<p>This refers to the local file system.</p>
<p>On Windows only <code>\</code> may be used instead of <code>/</code> in local paths <strong>only</strong>, non local paths must use <code>/</code>.</p>
<p>These paths needn't start with a leading <code>/</code> - if they don't then they will be relative to the current directory.</p>
<h3id="remotepathtodir">remote:path/to/dir</h3>
<p>This refers to a directory <code>path/to/dir</code> on <code>remote:</code> as defined in the config file (configured with <code>rclone config</code>).</p>
<p>On most backends this is refers to the same directory as <code>remote:path/to/dir</code> and that format should be preferred. On a very small number of remotes (FTP, SFTP, Dropbox for business) this will refer to a different directory. On these, paths without a leading <code>/</code> will refer to your "home" directory and paths with a leading <code>/</code> will refer to the root.</p>
<p>This is an advanced form for creating remotes on the fly. <code>backend</code> should be the name or prefix of a backend (the <code>type</code> in the config file) and all the configuration for the backend should be provided on the command line (or in environment variables).</p>
<h2id="quoting-and-the-shell">Quoting and the shell</h2>
<p>When you are typing commands to your computer you are using something called the command line shell. This interprets various characters in an OS specific way.</p>
<p>Here are some gotchas which may help users unfamiliar with the shell rules</p>
<h3id="linux-osx">Linux / OSX</h3>
<p>If your names have spaces or shell metacharacters (eg <code>*</code>, <code>?</code>, <code>$</code>, <code>'</code>, <code>"</code> etc) then you must quote them. Use single quotes <code>'</code> by default.</p>
<h2id="copying-files-or-directories-with-in-the-names">Copying files or directories with <code>:</code> in the names</h2>
<p>rclone uses <code>:</code> to mark a remote name. This is, however, a valid filename component in non-Windows OSes. The remote name parser will only search for a <code>:</code> up to the first <code>/</code> so if you need to act on a file or directory like this then use the full path starting with a <code>/</code>, or use <code>./</code> as a current directory prefix.</p>
<p>So to sync a directory called <code>sync:me</code> to a remote called <code>remote:</code> use</p>
<p>This means if you want to copy one folder to another then rclone won't download all the files and re-upload them; it will instruct the server to copy them in place.</p>
<p>Server side copies are used with <code>sync</code> and <code>copy</code> and will be identified in the log when using the <code>-v</code> flag. The <code>move</code> command may also use them if remote doesn't support server side move directly. This is done by issuing a server side copy then a delete which is much quicker than a download and re-upload.</p>
<p>Options that take parameters can have the values passed in two ways, <code>--option=value</code> or <code>--option value</code>. However boolean (true/false) options behave slightly differently to the other options in that <code>--boolean</code> sets the option to <code>true</code> and the absence of the flag sets it to <code>false</code>. It is also possible to specify <code>--boolean=false</code> or <code>--boolean=true</code>. Note that <code>--boolean false</code> is not valid - this is parsed as <code>--boolean</code> and the <code>false</code> is parsed as an extra command line argument for rclone.</p>
<p>Options which use TIME use the go time parser. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".</p>
<p>Options which use SIZE use kByte by default. However, a suffix of <code>b</code> for bytes, <code>k</code> for kBytes, <code>M</code> for MBytes, <code>G</code> for GBytes, <code>T</code> for TBytes and <code>P</code> for PBytes may be used. These are the binary units, eg 1, 2**10, 2**20, 2**30 respectively.</p>
<p>When using <code>sync</code>, <code>copy</code> or <code>move</code> any files which would have been overwritten or deleted are moved in their original hierarchy into this directory.</p>
<p>If <code>--suffix</code> is set, then the moved files will have the suffix added to them. If there is a file with the same path (after the suffix has been added) in DIR, then it will be overwritten.</p>
<p>The remote in use must support server side move or copy and you must use the same remote as the destination of the sync. The backup directory must not overlap the destination directory.</p>
<p>will sync <code>/path/to/local</code> to <code>remote:current</code>, but for any files which would have been updated or deleted will be stored in <code>remote:old</code>.</p>
<p>If running rclone from a script you might want to use today's date as the directory name passed to <code>--backup-dir</code> to store the old files, or you might want to pass <code>--suffix</code> with today's date.</p>
<p>Local address to bind to for outgoing connections. This can be an IPv4 address (1.2.3.4), an IPv6 address (1234::789A) or host name. If the host name doesn't resolve or resolves to more than one IP address it will give an error.</p>
<p>This option controls the bandwidth limit. Limits can be specified in two ways: As a single limit, or as a timetable.</p>
<p>Single limits last for the duration of the session. To use a single limit, specify the desired bandwidth in kBytes/s, or use a suffix b|k|M|G. The default is <code>0</code> which means to not limit bandwidth.</p>
<p>It is also possible to specify a "timetable" of limits, which will cause certain limits to be applied at certain times. To specify a timetable, format your entries as "WEEKDAY-HH:MM,BANDWIDTH WEEKDAY-HH:MM,BANDWIDTH..." where: WEEKDAY is optional element. It could be writen as whole world or only using 3 first characters. HH:MM is an hour from 00:00 to 23:59.</p>
<p>In this example, the transfer bandwidth will be every day set to 512kBytes/sec at 8am. At noon, it will raise to 10Mbytes/s, and drop back to 512kBytes/sec at 1pm. At 6pm, the bandwidth limit will be set to 30MBytes/s, and at 11pm it will be completely disabled (full speed). Anything between 11pm and 8am will remain unlimited.</p>
<p>An example of timetable with WEEKDAY could be:</p>
<p>It mean that, the transfer bandwidh will be set to 512kBytes/sec on Monday. It will raise to 10Mbytes/s before the end of Friday. At 10:00 on Sunday it will be set to 1Mbyte/s. From 20:00 at Sunday will be unlimited.</p>
<p>Timeslots without weekday are extended to whole week. So this one example:</p>
<p>Note that the units are Bytes/s, not Bits/s. Typically connections are measured in Bits/s - to convert divide by 8. For example, let's say you have a 10 Mbit/s connection and you wish rclone to use half of it - 5 Mbit/s. This is 5/8 = 0.625MByte/s so you would use a <code>--bwlimit 0.625M</code> parameter for rclone.</p>
<p>On Unix systems (Linux, MacOS, …) the bandwidth limiter can be toggled by sending a <code>SIGUSR2</code> signal to rclone. This allows to remove the limitations of a long running rclone transfer and to restore it back to the value specified with <code>--bwlimit</code> quickly when needed. Assuming there is only one rclone instance running, you can toggle the limiter like this:</p>
<p>When using <code>mount</code> or <code>cmount</code> each open file descriptor will use this much memory for buffering. See the <ahref="/commands/rclone_mount/#file-buffering">mount</a> documentation for more details.</p>
<p>The number of checkers to run in parallel. Checkers do the equality checking of files during a sync. For some storage systems (eg S3, Swift, Dropbox) this can take a significant amount of time so they are run in parallel.</p>
<p>The default is to run 8 checkers in parallel.</p>
<h3id="c---checksum">-c, --checksum</h3>
<p>Normally rclone will look at modification time and size of files to see if they are equal. If you set this flag then rclone will check the file hash and size to determine if files are equal.</p>
<p>This is useful when the remote doesn't support setting modified time and a more accurate sync is desired than just checking the file size.</p>
<p>This is very useful when transferring between remotes which store the same hash type on the object, eg Drive and Swift. For details of which remotes support which hash type see the table in the <ahref="https://rclone.org/overview/">overview section</a>.</p>
<p>Specify the location of the rclone config file.</p>
<p>Normally the config file is in your home directory as a file called <code>.config/rclone/rclone.conf</code> (or <code>.rclone.conf</code> if created with an older version). If <code>$XDG_CONFIG_HOME</code> is set it will be at <code>$XDG_CONFIG_HOME/rclone/rclone.conf</code></p>
<p>Set the connection timeout. This should be in go time format which looks like <code>5s</code> for 5 seconds, <code>10m</code> for 10 minutes, or <code>3h30m</code>.</p>
<p>The connection timeout is the amount of time rclone will wait for a connection to go through to a remote object storage system. It is <code>1m</code> by default.</p>
<p>Mode to run dedupe command in. One of <code>interactive</code>, <code>skip</code>, <code>first</code>, <code>newest</code>, <code>oldest</code>, <code>rename</code>. The default is <code>interactive</code>. See the dedupe command for more information as to what these options mean.</p>
<p>This disables a comma separated list of optional features. For example to disable server side move and server side copy use:</p>
<pre><code>--disable move,copy</code></pre>
<p>The features can be put in in any case.</p>
<p>To see a list of which features can be disabled use:</p>
<pre><code>--disable help</code></pre>
<p>See the overview <ahref="/overview/#features">features</a> and <ahref="/overview/#optional-features">optional features</a> to get an idea of which feature does what.</p>
<p>This flag can be useful for debugging and in exceptional circumstances (eg Google Drive limiting the total volume of Server Side Copies to 100GB/day).</p>
<p>Do a trial run with no permanent changes. Use this to see what rclone would do without actually doing it. Useful when setting up the <code>sync</code> command which deletes files in the destination.</p>
<p>Normally rclone will check that the checksums of transferred files match, and give an error "corrupted on transfer" if they don't.</p>
<p>You can use this option to skip that check. You should only use it if you have had the "corrupted on transfer" error message and you are sure you might want to transfer potentially corrupted data.</p>
<p>Using this option will make rclone unconditionally skip all files that exist on the destination, no matter the content of these files.</p>
<p>While this isn't a generally recommended option, it can be useful in cases where your files change due to encryption. However, it cannot correct partial transfers in case a transfer was interrupted.</p>
<p>Normally rclone will look at modification time and size of files to see if they are equal. If you set this flag then rclone will check only the modification time. If <code>--checksum</code> is set then it only checks the checksum.</p>
<p>It will also cause rclone to skip verifying the sizes are the same after transfer.</p>
<p>This can be useful for transferring files to and from OneDrive which occasionally misreports the size of image files (see <ahref="https://github.com/ncw/rclone/issues/399">#399</a> for more info).</p>
<p>Using this option will cause rclone to unconditionally upload all files regardless of the state of files on the destination.</p>
<p>Normally rclone would skip any files that have the same modification time and are the same size (or have the same checksum if using <code>--checksum</code>).</p>
<p>Treat source and destination files as immutable and disallow modification.</p>
<p>With this option set, files will be created and deleted as requested, but existing files will never be updated. If an existing file does not match between the source and destination, rclone will give the error <code>Source and destination exist but do not match: immutable file modified</code>.</p>
<p>Note that only commands which transfer files (e.g. <code>sync</code>, <code>copy</code>, <code>move</code>) are affected by this behavior, and only modification is disallowed. Files may still be deleted explicitly (e.g. <code>delete</code>, <code>purge</code>) or implicitly (e.g. <code>sync</code>, <code>move</code>). Use <code>copy --immutable</code> if it is desired to avoid deletion as well as modification.</p>
<p>This can be useful as an additional layer of protection for immutable or append-only data sets (notably backup archives), where modification implies corruption and should not be propagated.</p>
<p>Log all of rclone's output to FILE. This is not active by default. This can be useful for tracking down problems with syncs in combination with the <code>-v</code> flag. See the <ahref="#logging">Logging section</a> for more info.</p>
<p>Note that if you are using the <code>logrotate</code> program to manage rclone's logs, then you should use the <code>copytruncate</code> option as rclone doesn't have a signal to rotate logs.</p>
<p>Comma separated list of log format options. <code>date</code>, <code>time</code>, <code>microseconds</code>, <code>longfile</code>, <code>shortfile</code>, <code>UTC</code>. The default is "<code>date</code>,<code>time</code>".</p>
<p><code>DEBUG</code> is equivalent to <code>-vv</code>. It outputs lots of debug info - useful for bug reports and really finding out what rclone is doing.</p>
<p><code>INFO</code> is equivalent to <code>-v</code>. It outputs information about each transfer and prints stats once a minute by default.</p>
<p><code>NOTICE</code> is the default log level if no logging flags are supplied. It outputs very little when things are working normally. It outputs warnings and significant events.</p>
<p>This controls the number of low level retries rclone does.</p>
<p>A low level retry is used to retry a failing operation - typically one HTTP request. This might be uploading a chunk of a big file for example. You will see low level retries in the log with the <code>-v</code> flag.</p>
<p>This shouldn't need to be changed from the default in normal operations. However, if you get a lot of low level retries you may wish to reduce the value so rclone moves on to a high level retry (see the <code>--retries</code> flag) quicker.</p>
<p>This is the maximum allowable backlog of files in a sync/copy/move queued for being checked or transferred.</p>
<p>This can be set arbitrarily large. It will only use memory when the queue is in use. Note that it will use in the order of N kB of memory when the backlog is in use.</p>
<p>Setting this large allows rclone to calculate how many files are pending more accurately and give a more accurate estimated finish time.</p>
<p>Setting this small will make rclone more synchronous to the listings of the remote which may be desirable.</p>
<p>This tells rclone not to delete more than N files. If that limit is exceeded then a fatal error will be generated and rclone will stop the operation in progress.</p>
<p>This modifies the recursion depth for all the commands except purge.</p>
<p>So if you do <code>rclone --max-depth 1 ls remote:path</code> you will see only the files in the top level directory. Using <code>--max-depth 2</code> means you will see all the files in first two directory levels and so on.</p>
<p>For historical reasons the <code>lsd</code> command defaults to using a <code>--max-depth</code> of 1 - you can override this with the command line flag.</p>
<p>You can use this command to disable recursion (with <code>--max-depth 1</code>).</p>
<p>Note that if you use this with <code>sync</code> and <code>--delete-excluded</code> the files not recursed through are considered excluded and will be deleted on the destination. Test first with <code>--dry-run</code> if you are not sure what will happen.</p>
<p>When checking whether a file has been modified, this is the maximum allowed time difference that a file can have and still be considered equivalent.</p>
<p>The default is <code>1ns</code> unless this is overridden by a remote. For example OS X only stores modification times to the nearest second so if you are reading and writing to an OS X filing system this will be <code>1s</code> by default.</p>
<p>This command line flag allows you to override that computed default.</p>
<p>Don't set <code>Accept-Encoding: gzip</code>. This means that rclone won't ask the server for compressed files automatically. Useful if you've set the server to return files with <code>Content-Encoding: gzip</code> but you uploaded compressed files.</p>
<p>There is no need to set this in normal operation, and doing so will decrease the network transfer efficiency of rclone.</p>
<p>This flag makes rclone update the stats in a static block in the terminal providing a realtime overview of the transfer.</p>
<p>Any log messages will scroll above the static block. Log messages will push the static block down to the bottom of the terminal where it will stay.</p>
<p>Normally this is updated every 500mS but this period can be overridden with the <code>--stats</code> flag.</p>
<p>This can be used with the <code>--stats-one-line</code> flag for a simpler display.</p>
<p>Note: On Windows until<ahref="https://github.com/Azure/go-ansiterm/issues/26">this bug</a> is fixed all non-ASCII characters will be replaced with <code>.</code> when <code>--progress</code> is in use.</p>
<p>Normally rclone will look at modification time and size of files to see if they are equal. If you set this flag then rclone will check only the size.</p>
<p>This can be useful transferring files from Dropbox which have been modified by the desktop sync client which doesn't set checksums of modification times in the same way as rclone.</p>
<p>Commands which transfer data (<code>sync</code>, <code>copy</code>, <code>copyto</code>, <code>move</code>, <code>moveto</code>) will print data transfer stats at regular intervals to show their progress.</p>
<p>If you set the stats interval then all commands can show stats. This can be useful when running other commands, <code>check</code> or <code>mount</code> for example.</p>
<p>Stats are logged at <code>INFO</code> level by default which means they won't show at default log level <code>NOTICE</code>. Use <code>--stats-log-level NOTICE</code> or <code>-v</code> to make them show. See the <ahref="#logging">Logging section</a> for more info on log levels.</p>
<p>By default, the <code>--stats</code> output will truncate file names and paths longer than 40 characters. This is equivalent to providing <code>--stats-file-name-length 40</code>. Use <code>--stats-file-name-length 0</code> to disable any truncation of file names printed by stats.</p>
<p>Log level to show <code>--stats</code> output at. This can be <code>DEBUG</code>, <code>INFO</code>, <code>NOTICE</code>, or <code>ERROR</code>. The default is <code>INFO</code>. This means at the default level of logging which is <code>NOTICE</code> the stats won't show - if you want them to then use <code>--stats-log-level NOTICE</code>. See the <ahref="#logging">Logging section</a> for more info on log levels.</p>
<p>This is for use with <code>--backup-dir</code> only. If this isn't set then <code>--backup-dir</code> will move files with their original name. If it is set then the files will have SUFFIX added on to them.</p>
<p>See <code>--backup-dir</code> for more info.</p>
<h3id="syslog">--syslog</h3>
<p>On capable OSes (not Windows or Plan9) send all log output to syslog.</p>
<p>If using <code>--syslog</code> this sets the syslog facility (eg <code>KERN</code>, <code>USER</code>). See <code>man syslog</code> for a list of possible facilities. The default facility is <code>DAEMON</code>.</p>
<p>Limit HTTP transactions per second to this. Default is 0 which is used to mean unlimited transactions per second.</p>
<p>For example to limit rclone to 10 HTTP transactions per second use <code>--tpslimit 10</code>, or to 1 transaction every 2 seconds use <code>--tpslimit 0.5</code>.</p>
<p>Use this when the number of transactions per second from rclone is causing a problem with the cloud storage provider (eg getting you banned or rate limited).</p>
<p>This can be very useful for <code>rclone mount</code> to control the behaviour of applications using it.</p>
<p>Max burst of transactions for <code>--tpslimit</code>. (default 1)</p>
<p>Normally <code>--tpslimit</code> will do exactly the number of transaction per second specified. However if you supply <code>--tps-burst</code> then rclone can save up some transactions from when it was idle giving a burst of up to the parameter supplied.</p>
<p>For example if you provide <code>--tpslimit-burst 10</code> then if rclone has been idle for more than 10*<code>--tpslimit</code> then it can do 10 transactions very quickly before they are limited again.</p>
<p>This may be used to increase performance of <code>--tpslimit</code> without changing the long term average number of transactions per second.</p>
<p>By default, rclone doesn't keep track of renamed files, so if you rename a file locally then sync it to a remote, rclone will delete the old file on the remote and upload a new copy.</p>
<p>If you use this flag, and the remote supports server side copy or server side move, and the source and destination have a compatible hash, then this will track renames during <code>sync</code> operations and perform renaming server-side.</p>
<p>If the destination does not support server-side copy or move, rclone will fall back to the default behaviour and log an error level message to the console. Note: Encrypted destinations are not supported by <code>--track-renames</code>.</p>
<p>Note that <code>--track-renames</code> is incompatible with <code>--no-traverse</code> and that it uses extra memory to keep track of all the rename candidates.</p>
<p>Note also that <code>--track-renames</code> is incompatible with <code>--delete-before</code> and will select <code>--delete-after</code> instead of <code>--delete-during</code>.</p>
<p>Specifying the value <code>--delete-before</code> will delete all files present on the destination, but not on the source <em>before</em> starting the transfer of any new or updated files. This uses two passes through the file systems, one for the deletions and one for the copies.</p>
<p>Specifying <code>--delete-during</code> will delete files while checking and uploading files. This is the fastest option and uses the least memory.</p>
<p>Specifying <code>--delete-after</code> (the default value) will delay deletion of files until all new/updated files have been successfully transferred. The files to be deleted are collected in the copy pass then deleted after the copy pass has completed successfully. The files to be deleted are held in memory so this mode may use more memory. This is the safest mode as it will only delete files if there have been no errors subsequent to that. If there have been errors before the deletions start then you will get the message <code>not deleting files as there were IO errors</code>.</p>
<h3id="fast-list">--fast-list</h3>
<p>When doing anything which involves a directory listing (eg <code>sync</code>, <code>copy</code>, <code>ls</code> - in fact nearly every command), rclone normally lists a directory and processes it before using more directory lists to process any subdirectories. This can be parallelised and works very quickly using the least amount of memory.</p>
<p>However, some remotes have a way of listing all files beneath a directory in one (or a small number) of transactions. These tend to be the bucket based remotes (eg S3, B2, GCS, Swift, Hubic).</p>
<p>If you use the <code>--fast-list</code> flag then rclone will use this method for listing directories. This will have the following consequences for the listing:</p>
<ul>
<li>It <strong>will</strong> use fewer transactions (important if you pay for them)</li>
<li>It <strong>will</strong> use more memory. Rclone has to load the whole listing into memory.</li>
<li>It <em>may</em> be faster because it uses fewer transactions</li>
<li>It <em>may</em> be slower because it can't be parallelized</li>
</ul>
<p>rclone should always give identical results with and without <code>--fast-list</code>.</p>
<p>If you pay for transactions and can fit your entire sync listing into memory then <code>--fast-list</code> is recommended. If you have a very big sync to do then don't use <code>--fast-list</code> otherwise you will run out of memory.</p>
<p>If you use <code>--fast-list</code> on a remote which doesn't support it, then rclone will just ignore it.</p>
<p>This sets the IO idle timeout. If a transfer has started but then becomes idle for this long it is considered broken and disconnected.</p>
<p>The default is <code>5m</code>. Set to 0 to disable.</p>
<h3id="transfersn">--transfers=N</h3>
<p>The number of file transfers to run in parallel. It can sometimes be useful to set this to a smaller number if the remote is giving a lot of timeouts or bigger if you have lots of bandwidth and a fast remote.</p>
<p>The default is to run 4 file transfers in parallel.</p>
<p>This forces rclone to skip any files which exist on the destination and have a modified time that is newer than the source file.</p>
<p>If an existing destination file has a modification time equal (within the computed modify window precision) to the source file's, it will be updated if the sizes are different.</p>
<p>On remotes which don't support mod time directly the time checked will be the uploaded time. This means that if uploading to one of these remotes, rclone will skip any files which exist on the destination and have an uploaded time that is newer than the modification time of the source file.</p>
<p>This can be useful when transferring to a remote which doesn't support mod times directly as it is more accurate than a <code>--size-only</code> check and faster than using <code>--checksum</code>.</p>
<p>If this flag is set then rclone will use anonymous memory allocated by mmap on Unix based platforms and VirtualAlloc on Windows for its transfer buffers (size controlled by <code>--buffer-size</code>). Memory allocated like this does not go on the Go heap and can be returned to the OS immediately when it is finished with.</p>
<p>If this flag is not set then rclone will allocate and free the buffers using the Go memory allocator which may use more memory as memory pages are returned less aggressively to the OS.</p>
<p>It is possible this does not work well on all platforms so it is disabled by default; in the future it may be enabled by default.</p>
<p>Some object-store backends (e.g, Swift, S3) do not preserve file modification times (modtime). On these backends, rclone stores the original modtime as additional metadata on the object. By default it will make an API call to retrieve the metadata when the modtime is needed by an operation.</p>
<p>Use this flag to disable the extra API call and rely instead on the server's modified time. In cases such as a local to remote sync, knowing the local file is newer than the time it was last uploaded to the remote is sufficient. In those cases, this flag can speed up the process and reduce the number of API calls necessary.</p>
<p>With <code>-v</code> rclone will tell you about each file that is transferred and a small number of significant events.</p>
<p>With <code>-vv</code> rclone will become very verbose telling you about every file it considers and transfers. Please send bug reports with a log with this setting.</p>
<p>Your configuration file contains information for logging in to your cloud services. This means that you should keep your <code>.rclone.conf</code> file in a secure location.</p>
<p>If you are in an environment where that isn't possible, you can add a password to your configuration. This means that you will have to enter the password every time you start rclone.</p>
<p>To add a password to your rclone configuration, execute <code>rclone config</code>.</p>
<pre><code>>rclone config
Current remotes:
e) Edit existing remote
n) New remote
d) Delete remote
s) Set configuration password
q) Quit config
e/n/d/s/q></code></pre>
<p>Go into <code>s</code>, Set configuration password:</p>
<pre><code>e/n/d/s/q> s
Your configuration is not encrypted.
If you add a password, you will protect your login information to cloud services.
<p>Your configuration is now encrypted, and every time you start rclone you will now be asked for the password. In the same menu, you can change the password or completely remove encryption from your configuration.</p>
<p>rclone uses <ahref="https://godoc.org/golang.org/x/crypto/nacl/secretbox">nacl secretbox</a> which in turn uses XSalsa20 and Poly1305 to encrypt and authenticate your configuration with secret-key cryptography. The password is SHA-256 hashed, which produces the key for secretbox. The hashed password is not stored.</p>
<p>While this provides very good security, we do not recommend storing your encrypted rclone configuration in public if it contains sensitive information, maybe except if you use a very strong password.</p>
<p>If it is safe in your environment, you can set the <code>RCLONE_CONFIG_PASS</code> environment variable to contain your password, in which case it will be used for decrypting the configuration.</p>
<p>Then source the file when you want to use it. From the shell you would do <code>source set-rclone-password</code>. It will then ask you for the password and set it in the environment variable.</p>
<p>If you are running rclone inside a script, you might want to disable password prompts. To do that, pass the parameter <code>--ask-password=false</code> to rclone. This will make rclone fail instead of asking for a password if <code>RCLONE_CONFIG_PASS</code> doesn't contain a valid password.</p>
<p>These options are useful when developing or debugging rclone. There are also some more remote specific options which aren't documented here which are used for testing. These start with remote name eg <code>--drive-test-option</code> - see the docs for the remote in question.</p>
<h3id="cpuprofilefile">--cpuprofile=FILE</h3>
<p>Write CPU profile to file. This can be analysed with <code>go tool pprof</code>.</p>
<p>The <code>--dump</code> flag takes a comma separated list of flags to dump info about. These are:</p>
<h4id="dump-headers">--dump headers</h4>
<p>Dump HTTP headers with <code>Authorization:</code> lines removed. May still contain sensitive info. Can be very verbose. Useful for debugging only.</p>
<p>Use <code>--dump auth</code> if you do want the <code>Authorization:</code> headers.</p>
<p>Like <code>--dump bodies</code> but dumps the request bodies and the response headers. Useful for debugging download problems.</p>
<h4id="dump-responses">--dump responses</h4>
<p>Like <code>--dump bodies</code> but dumps the response bodies and the request headers. Useful for debugging upload problems.</p>
<h4id="dump-auth">--dump auth</h4>
<p>Dump HTTP headers - will contain sensitive info such as <code>Authorization:</code> headers - use <code>--dump headers</code> to dump without <code>Authorization:</code> headers. Can be very verbose. Useful for debugging only.</p>
<p>This dumps a list of the running go-routines at the end of the command to standard output.</p>
<h4id="dump-openfiles">--dump openfiles</h4>
<p>This dumps a list of the open files at the end of the command. It uses the <code>lsof</code> command to do that so you'll need that installed to use it.</p>
<p><code>--no-check-certificate</code> controls whether a client verifies the server's certificate chain and host name. If <code>--no-check-certificate</code> is true, TLS accepts any certificate presented by the server and any host name in that certificate. In this mode, TLS is susceptible to man-in-the-middle attacks.</p>
<p>This option defaults to <code>false</code>.</p>
<p><strong>This should be used only for testing.</strong></p>
<p>The <code>--no-traverse</code> flag controls whether the destination file system is traversed when using the <code>copy</code> or <code>move</code> commands. <code>--no-traverse</code> is not compatible with <code>sync</code> and will be ignored if you supply it with <code>sync</code>.</p>
<p>If you are only copying a small number of files (or are filtering most of the files) and/or have a large number of files on the destination then <code>--no-traverse</code> will stop rclone listing the destination and save time.</p>
<p>However, if you are copying a large number of files, especially if you are doing a copy where lots of the files under consideration haven't changed and won't need copying then you shouldn't use <code>--no-traverse</code>.</p>
<p>See <ahref="https://rclone.org/commands/rclone_copy/">rclone copy</a> for an example of how to use it.</p>
<p>By default, rclone logs to standard error. This means you can redirect standard error and still see the normal output of rclone commands (eg <code>rclone ls</code>).</p>
<p>By default, rclone will produce <code>Error</code> and <code>Notice</code> level messages.</p>
<p>If you use the <code>-v</code> flag, rclone will produce <code>Error</code>, <code>Notice</code> and <code>Info</code> messages.</p>
<p>If you use the <code>-vv</code> flag, rclone will produce <code>Error</code>, <code>Notice</code>, <code>Info</code> and <code>Debug</code> messages.</p>
<p>You can also control the log levels with the <code>--log-level</code> flag.</p>
<p>If you use the <code>--log-file=FILE</code> option, rclone will redirect <code>Error</code>, <code>Info</code> and <code>Debug</code> messages along with standard error to FILE.</p>
<p>If you use the <code>--syslog</code> flag then rclone will log to syslog and the <code>--syslog-facility</code> control which facility it uses.</p>
<p>Rclone prefixes all log messages with their level in capitals, eg INFO which makes it easy to grep the log file for different kinds of information.</p>
<p>If any errors occur during the command execution, rclone will exit with a non-zero exit code. This allows scripts to detect when rclone operations have failed.</p>
<p>During the startup phase, rclone will exit immediately if an error is detected in the configuration. There will always be a log message immediately before exiting.</p>
<p>When rclone is running it will accumulate errors as it goes along, and only exit with a non-zero exit code if (after retries) there were still failed transfers. For every error counted there will be a high priority log message (visible with <code>-q</code>) showing the message and which file caused the problem. A high priority message is also shown when starting a retry so the user can see that any previous error messages may not be valid after the retry. If rclone has done a retry it will log a high priority message if the retry was successful.</p>
<p>To find the name of the environment variable, first, take the long option name, strip the leading <code>--</code>, change <code>-</code> to <code>_</code>, make upper case and prepend <code>RCLONE_</code>.</p>
<p>For example, to always set <code>--stats 5s</code>, set the environment variable <code>RCLONE_STATS=5s</code>. If you set stats on the command line this will override the environment variable setting.</p>
<p>Or to always use the trash in drive <code>--drive-use-trash</code>, set <code>RCLONE_DRIVE_USE_TRASH=true</code>.</p>
<p>The same parser is used for the options and the environment variables so they take exactly the same form.</p>
<h3id="config-file">Config file</h3>
<p>You can set defaults for values in the config file on an individual remote basis. If you want to use this feature, you will need to discover the name of the config items that you want. The easiest way is to run through <code>rclone config</code> by hand, then look in the config file to see what the values are (the config file can be found by looking at the help for <code>--config</code> in <code>rclone help</code>).</p>
<p>To find the name of the environment variable, you need to set, take <code>RCLONE_CONFIG_</code> + name of remote + <code>_</code> + name of config file option and make it all uppercase.</p>
<h1id="configuring-rclone-on-a-remote-headless-machine">Configuring rclone on a remote / headless machine</h1>
<p>Some of the configurations (those involving oauth2) require an Internet connected web browser.</p>
<p>If you are trying to set rclone up on a remote or headless box with no browser available on it (eg a NAS or a server in a datacenter) then you will need to use an alternative means of configuration. There are two ways of doing it, described below.</p>
<h2id="configuring-using-rclone-authorize">Configuring using rclone authorize</h2>
<p>On the headless box</p>
<pre><code>...
Remote config
Use auto config?
* Say Y if not sure
* Say N if you are working on a remote or headless machine
y) Yes
n) No
y/n> n
For this to work, you will need rclone available on a machine that has a web browser available.
<p>Find the config file by running <code>rclone config file</code>, for example</p>
<pre><code>$ rclone config file
Configuration file is stored at:
/home/user/.rclone.conf</code></pre>
<p>Now transfer it to the remote box (scp, cut paste, ftp, sftp etc) and place it in the correct place (use <code>rclone config file</code> on the remote box to find out where).</p>
<h1id="filtering-includes-and-excludes">Filtering, includes and excludes</h1>
<p>Rclone has a sophisticated set of include and exclude rules. Some of these are based on patterns and some on other things like file size.</p>
<p>The filters are applied for the <code>copy</code>, <code>sync</code>, <code>move</code>, <code>ls</code>, <code>lsl</code>, <code>md5sum</code>, <code>sha1sum</code>, <code>size</code>, <code>delete</code> and <code>check</code> operations. Note that <code>purge</code> does not obey the filters.</p>
<p>Each path as it passes through rclone is matched against the include and exclude rules like <code>--include</code>, <code>--exclude</code>, <code>--include-from</code>, <code>--exclude-from</code>, <code>--filter</code>, or <code>--filter-from</code>. The simplest way to try them out is using the <code>ls</code> command, or <code>--dry-run</code> together with <code>-v</code>.</p>
<p>If the pattern starts with a <code>/</code> then it only matches at the top level of the directory tree, <strong>relative to the root of the remote</strong> (not necessarily the root of the local drive). If it doesn't start with <code>/</code> then it is matched starting at the <strong>end of the path</strong>, but it will only match a complete path element:</p>
- doesn't match "directory/file.jpg"
- doesn't match "adir/file.jpg"</code></pre>
<p>A <code>?</code> matches any character except a slash <code>/</code>.</p>
<pre><code>l?ss - matches "less"
- matches "lass"
- doesn't match "floss"</code></pre>
<p>A <code>[</code> and <code>]</code> together make a a character class, such as <code>[a-z]</code> or <code>[aeiou]</code> or <code>[[:alpha:]]</code>. See the <ahref="https://golang.org/pkg/regexp/syntax/">go regexp docs</a> for more info on these.</p>
<pre><code>h[ae]llo - matches "hello"
- matches "hallo"
- doesn't match "hullo"</code></pre>
<p>A <code>{</code> and <code>}</code> define a choice between elements. It should contain a comma separated list of patterns, any of which might match. These patterns can contain wildcards.</p>
<p>Note also that rclone filter globs can only be used in one of the filter command line flags, not in the specification of the remote, so <code>rclone copy "remote:dir*.jpg" /path/to/dir</code> won't work - what is required is <code>rclone --include "*.jpg" copy remote:dir /path/to/dir</code></p>
<h3id="directories">Directories</h3>
<p>Rclone keeps track of directories that could match any file patterns.</p>
<p>Directory matches are <strong>only</strong> used to optimise directory access patterns - you must still match the files that you want to match. Directory matches won't optimise anything on bucket based remotes (eg s3, swift, google compute storage, b2) which don't have a concept of directory.</p>
<p>Rclone maintains a combined list of include rules and exclude rules.</p>
<p>Each file is matched in order, starting from the top, against the rule in the list until it finds a match. The file is then included or excluded according to the rule type.</p>
<p>If the matcher fails to find a match after testing against all the entries in the list then the path is included.</p>
<p>A similar process is done on directory entries before recursing into them. This only works on remotes which have a concept of directory (Eg local, google drive, onedrive, amazon drive) and not on bucket based remotes (eg s3, swift, google compute storage, b2).</p>
<p><strong>Important</strong> You should not use <code>--include*</code> together with <code>--exclude*</code>. It may produce different results than you expected. In that case try to use: <code>--filter*</code>.</p>
<p>Note that all the options of the same type are processed together in the order above, regardless of what order they were placed on the command line.</p>
<p>So all <code>--include</code> options are processed first in the order they appeared on the command line, then all <code>--include-from</code> options etc.</p>
<p>To mix up the order includes and excludes, the <code>--filter</code> flag can be used.</p>
<p>Prepare a file like this <code>exclude-file.txt</code></p>
<pre><code># a sample exclude rule file
*.bak
file2.jpg</code></pre>
<p>Then use as <code>--exclude-from exclude-file.txt</code>. This will sync all files except those ending in <code>bak</code> and <code>file2.jpg</code>.</p>
<p>This is useful if you have a lot of rules.</p>
<h3id="include---include-files-matching-pattern"><code>--include</code> - Include files matching pattern</h3>
<p>Add a single include rule with <code>--include</code>.</p>
<p>Eg <code>--include *.{png,jpg}</code> to include all <code>png</code> and <code>jpg</code> files in the backup and no others.</p>
<p>This adds an implicit <code>--exclude *</code> at the very end of the filter list. This means you can mix <code>--include</code> and <code>--include-from</code> with the other filters (eg <code>--exclude</code>) but you must include all the files you want in the include statement. If this doesn't provide enough flexibility then you must use <code>--filter-from</code>.</p>
<h3id="include-from---read-include-patterns-from-file"><code>--include-from</code> - Read include patterns from file</h3>
<p>Prepare a file like this <code>include-file.txt</code></p>
<pre><code># a sample include rule file
*.jpg
*.png
file2.avi</code></pre>
<p>Then use as <code>--include-from include-file.txt</code>. This will sync all <code>jpg</code>, <code>png</code> files and <code>file2.avi</code>.</p>
<p>This is useful if you have a lot of rules.</p>
<p>This adds an implicit <code>--exclude *</code> at the very end of the filter list. This means you can mix <code>--include</code> and <code>--include-from</code> with the other filters (eg <code>--exclude</code>) but you must include all the files you want in the include statement. If this doesn't provide enough flexibility then you must use <code>--filter-from</code>.</p>
<h3id="filter---add-a-file-filtering-rule"><code>--filter</code> - Add a file-filtering rule</h3>
<p>This can be used to add a single include or exclude rule. Include rules start with <code>+</code> and exclude rules start with <code>-</code>. A special rule called <code>!</code> can be used to clear the existing rules.</p>
<p>This example will include all <code>jpg</code> and <code>png</code> files, exclude any files matching <code>secret*.jpg</code> and include <code>file2.avi</code>. It will also include everything in the directory <code>dir</code> at the root of the sync, except <code>dir/Trash</code> which it will exclude. Everything else will be excluded from the sync.</p>
<p>This reads a list of file names from the file passed in and <strong>only</strong> these files are transferred. The <strong>filtering rules are ignored</strong> completely if you use this option.</p>
<p>Rclone will not scan any directories if you use <code>--files-from</code> it will just look at the files specified. Rclone will not error if any of the files are missing from the source.</p>
<p>Paths within the <code>--files-from</code> file will be interpreted as starting with the root specified in the command. Leading <code>/</code> characters are ignored.</p>
<p>For example, suppose you had <code>files-from.txt</code> with this content:</p>
<p>To copy these you'd find a common subdirectory - in this case <code>/home</code> and put the remaining files in <code>files-from.txt</code> with or without leading <code>/</code>, eg</p>
<pre><code>user1/important
user1/dir/file
user2/stuff</code></pre>
<p>You could then copy these to a remote like this</p>
<h3id="min-size---dont-transfer-any-file-smaller-than-this"><code>--min-size</code> - Don't transfer any file smaller than this</h3>
<p>This option controls the minimum size file which will be transferred. This defaults to <code>kBytes</code> but a suffix of <code>k</code>, <code>M</code>, or <code>G</code> can be used.</p>
<p>For example <code>--min-size 50k</code> means no files smaller than 50kByte will be transferred.</p>
<h3id="max-size---dont-transfer-any-file-larger-than-this"><code>--max-size</code> - Don't transfer any file larger than this</h3>
<p>This option controls the maximum size file which will be transferred. This defaults to <code>kBytes</code> but a suffix of <code>k</code>, <code>M</code>, or <code>G</code> can be used.</p>
<p>For example <code>--max-size 1G</code> means no files larger than 1GByte will be transferred.</p>
<h3id="max-age---dont-transfer-any-file-older-than-this"><code>--max-age</code> - Don't transfer any file older than this</h3>
<p>This option controls the maximum age of files to transfer. Give in seconds or with a suffix of:</p>
<ul>
<li><code>ms</code> - Milliseconds</li>
<li><code>s</code> - Seconds</li>
<li><code>m</code> - Minutes</li>
<li><code>h</code> - Hours</li>
<li><code>d</code> - Days</li>
<li><code>w</code> - Weeks</li>
<li><code>M</code> - Months</li>
<li><code>y</code> - Years</li>
</ul>
<p>For example <code>--max-age 2d</code> means no files older than 2 days will be transferred.</p>
<h3id="min-age---dont-transfer-any-file-younger-than-this"><code>--min-age</code> - Don't transfer any file younger than this</h3>
<p>This option controls the minimum age of files to transfer. Give in seconds or with a suffix (see <code>--max-age</code> for list of suffixes)</p>
<p>For example <code>--min-age 2d</code> means no files younger than 2 days will be transferred.</p>
<h3id="delete-excluded---delete-files-on-dest-excluded-from-sync"><code>--delete-excluded</code> - Delete files on dest excluded from sync</h3>
<p><strong>Important</strong> this flag is dangerous - use with <code>--dry-run</code> and <code>-v</code> first.</p>
<p>When doing <code>rclone sync</code> this will delete any files which are excluded from the sync on the destination.</p>
<p>If for example you did a sync from <code>A</code> to <code>B</code> without the <code>--min-size 50k</code> flag</p>
<pre><code>rclone sync A: B:</code></pre>
<p>Then you repeated it like this with the <code>--delete-excluded</code></p>
<h3id="ignore-case---make-searches-case-insensitive"><code>--ignore-case</code> - make searches case insensitive</h3>
<p>Normally filter patterns are case sensitive. If this flag is supplied then filter patterns become case insensitive.</p>
<p>Normally a <code>--include "file.txt"</code> will not match a file called <code>FILE.txt</code>. However if you use the <code>--ignore-case</code> flag then <code>--include "file.txt"</code> this will match a file called <code>FILE.txt</code>.</p>
<h2id="exclude-directory-based-on-a-file">Exclude directory based on a file</h2>
<p>It is possible to exclude a directory based on a file, which is present in this directory. Filename should be specified using the <code>--exclude-if-present</code> flag. This flag has a priority over the other filtering flags.</p>
<p>Imagine, you have the following directory structure:</p>
<pre><code>dir1/file1
dir1/dir2/file2
dir1/dir2/dir3/file3
dir1/dir2/dir3/.ignore</code></pre>
<p>You can exclude <code>dir3</code> from sync by running the following command:</p>
<p>Enable the serving of remote objects via the HTTP interface. This means objects will be accessible at http://127.0.0.1:5572/ by default, so you can browse to http://127.0.0.1:5572/ or http://127.0.0.1:5572/* to see a listing of the remotes. Objects may be requested from remotes using this syntax http://127.0.0.1:5572/[remote:path]/path/to/object</p>
<p>Path to local files to serve on the HTTP server.</p>
<p>If this is set then rclone will serve the files in that directory. It will also open the root in the web browser if specified. This is for implementing browser based GUIs for rclone functions.</p>
<p>If <code>--rc-user</code> or <code>--rc-pass</code> is set then the URL that is opened will have the authorization in the URL in the <code>http://user:pass@localhost/</code> style.</p>
<p>Default Off.</p>
<h3id="rc-no-auth">--rc-no-auth</h3>
<p>By default rclone will require authorisation to have been set up on the rc interface in order to use any methods which access any rclone remotes. Eg <code>operations/list</code> is denied as it involved creating a remote as is <code>sync/copy</code>.</p>
<p>If this is set then no authorisation will be required on the server to use these methods. The alternative is to use <code>--rc-user</code> and <code>--rc-pass</code> and use these credentials in the request.</p>
<p>The rc interface supports some special parameters which apply to <strong>all</strong> commands. These start with <code>_</code> to show they are different.</p>
<h3id="running-asynchronous-jobs-with-_async-true">Running asynchronous jobs with _async = true</h3>
<p>If <code>_async</code> has a true value when supplied to an rc call then it will return immediately with a job id and the task will be run in the background. The <code>job/status</code> call can be used to get information of the background job. The job can be queried for up to 1 minute after it has finished.</p>
<p>It is recommended that potentially long running jobs, eg <code>sync/sync</code>, <code>sync/copy</code>, <code>sync/move</code>, <code>operations/purge</code> are run with the <code>_async</code> flag to avoid any potential problems with the HTTP request and response timing out.</p>
<p>Starting a job with the <code>_async</code> flag:</p>
<p>Query the status to see if the job has finished. For more information on the meaning of these return parameters see the <code>job/status</code> call.</p>
<!--- autogenerated start - run make rcdocs - don't edit here -->
<h3id="cacheexpire-purge-a-remote-from-cache">cache/expire: Purge a remote from cache</h3>
<p>Purge a remote from the cache backend. Supports either a directory or a file. Params: - remote = path to remote (required) - withData = true/false to delete cached data (chunks) as well (optional)</p>
<p>Ensure the specified file chunks are cached on disk.</p>
<p>The chunks= parameter specifies the file chunks to check. It takes a comma separated list of array slice indices. The slice indices are similar to Python slices: start[:end]</p>
<p>start is the 0 based chunk number from the beginning of the file to fetch inclusive. end is 0 based chunk number from the beginning of the file to fetch exclusive. Both values can be negative, in which case they count from the back of the file. The value "-5:" represents the last 5 chunks of a file.</p>
<p>Some valid examples are: ":5,-5:" -> the first and last five chunks "0,-2" -> the first and the second last chunk "0:10" -> the first ten chunks</p>
<p>Any parameter with a key that starts with "file" can be used to specify files to fetch, eg</p>
<h3id="configcreate-create-the-config-for-a-remote.">config/create: create the config for a remote.</h3>
<p>This takes the following parameters</p>
<ul>
<li>name - name of remote</li>
<li>type - type of new remote</li>
<li>type - type of the new remote</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_config_create/">config create command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="configdelete-delete-a-remote-in-the-config-file.">config/delete: Delete a remote in the config file.</h3>
<p>Parameters: - name - name of remote to delete</p>
<p>See the <ahref="https://rclone.org/commands/rclone_config_delete/">config delete command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="configdump-dumps-the-config-file.">config/dump: Dumps the config file.</h3>
<p>Returns a JSON object: - key: value</p>
<p>Where keys are remote names and values are the config parameters.</p>
<p>See the <ahref="https://rclone.org/commands/rclone_config_dump/">config dump command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="configget-get-a-remote-in-the-config-file.">config/get: Get a remote in the config file.</h3>
<p>Parameters: - name - name of remote to get</p>
<p>See the <ahref="https://rclone.org/commands/rclone_config_dump/">config dump command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="configlistremotes-lists-the-remotes-in-the-config-file.">config/listremotes: Lists the remotes in the config file.</h3>
<p>Returns - remotes - array of remote names</p>
<p>See the <ahref="https://rclone.org/commands/rclone_listremotes/">listremotes command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="configpassword-password-the-config-for-a-remote.">config/password: password the config for a remote.</h3>
<p>This takes the following parameters</p>
<ul>
<li>name - name of remote</li>
<li>type - type of new remote</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_config_password/">config password command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="configproviders-shows-how-providers-are-configured-in-the-config-file.">config/providers: Shows how providers are configured in the config file.</h3>
<p>Returns a JSON object: - providers - array of objects</p>
<p>See the <ahref="https://rclone.org/commands/rclone_config_providers/">config providers command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="configupdate-update-the-config-for-a-remote.">config/update: update the config for a remote.</h3>
<p>This takes the following parameters</p>
<ul>
<li>name - name of remote</li>
<li>type - type of new remote</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_config_update/">config update command</a> command for more information on the above.</p>
<h3id="coregc-runs-a-garbage-collection.">core/gc: Runs a garbage collection.</h3>
<p>This tells the go runtime to do a garbage collection run. It isn't necessary to call this normally, but it can be useful for debugging memory problems.</p>
<h3id="corememstats-returns-the-memory-statistics">core/memstats: Returns the memory statistics</h3>
<p>This returns the memory statistics of the running program. What the values mean are explained in the go docs: https://golang.org/pkg/runtime/#MemStats</p>
<p>The most interesting values for most people are:</p>
<ul>
<li>HeapAlloc: This is the amount of memory rclone is actually using</li>
<li>HeapSys: This is the amount of memory rclone has obtained from the OS</li>
<li>Sys: this is the total amount of memory requested from the OS</li>
<li>It is virtual memory so may include unused memory</li>
"transfers": number of transferred files,
"deletes" : number of deleted files,
"elapsedTime": time in seconds since the start of the process,
"lastError": last occurred error,
"transferring": an array of currently active file transfers:
[
{
"bytes": total transferred bytes for this file,
"eta": estimated time in seconds until file transfer completion
"name": name of the file,
"percentage": progress of the file transfer in percent,
"speed": speed in bytes/sec,
"speedAvg": speed in bytes/sec as an exponentially weighted moving average,
"size": size of the file in bytes
}
],
"checking": an array of names of currently active file checks
[]
}</code></pre>
<p>Values for "transferring", "checking" and "lastError" are only assigned if data is available. The value for "eta" is null if an eta cannot be determined.</p>
<h3id="coreversion-shows-the-current-version-of-rclone-and-the-go-runtime.">core/version: Shows the current version of rclone and the go runtime.</h3>
<p>This shows the current version of go and the go runtime - version - rclone version, eg "v1.44" - decomposed - version number as [major, minor, patch, subpatch] - note patch and subpatch will be 999 for a git compiled version - isGit - boolean - true if this was compiled from the git version - os - OS in use as according to Go - arch - cpu architecture in use according to Go - goVersion - version of Go runtime in use</p>
<h3id="joblist-lists-the-ids-of-the-running-jobs">job/list: Lists the IDs of the running jobs</h3>
<p>Parameters - None</p>
<p>Results - jobids - array of integer job ids</p>
<h3id="jobstatus-reads-the-status-of-the-job-id">job/status: Reads the status of the job ID</h3>
<p>Parameters - jobid - id of the job (integer)</p>
<p>Results - finished - boolean - duration - time in seconds that the job ran for - endTime - time the job finished (eg "2018-10-26T18:50:20.528746884+01:00") - error - error from the job or empty string for no error - finished - boolean whether the job has finished or not - id - as passed in above - startTime - time the job started (eg "2018-10-26T18:50:20.528336039+01:00") - success - boolean - true for success false otherwise - output - output of the job as would have been returned if called synchronously</p>
<h3id="operationsabout-return-the-space-used-on-the-remote">operations/about: Return the space used on the remote</h3>
<p>This takes the following parameters</p>
<ul>
<li>fs - a remote name string eg "drive:"</li>
<li>remote - a path within that remote eg "dir"</li>
</ul>
<p>The result is as returned from rclone about --json</p>
<p>Authentication is required for this call.</p>
<h3id="operationscleanup-remove-trashed-files-in-the-remote-or-path">operations/cleanup: Remove trashed files in the remote or path</h3>
<p>This takes the following parameters</p>
<ul>
<li>fs - a remote name string eg "drive:"</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_cleanup/">cleanup command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="operationscopyfile-copy-a-file-from-source-remote-to-destination-remote">operations/copyfile: Copy a file from source remote to destination remote</h3>
<p>This takes the following parameters</p>
<ul>
<li>srcFs - a remote name string eg "drive:" for the source</li>
<li>srcRemote - a path within that remote eg "file.txt" for the source</li>
<li>dstFs - a remote name string eg "drive2:" for the destination</li>
<li>dstRemote - a path within that remote eg "file2.txt" for the destination</li>
</ul>
<p>Authentication is required for this call.</p>
<h3id="operationscopyurl-copy-the-url-to-the-object">operations/copyurl: Copy the URL to the object</h3>
<p>This takes the following parameters</p>
<ul>
<li>fs - a remote name string eg "drive:"</li>
<li>remote - a path within that remote eg "dir"</li>
<li>url - string, URL to read from</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_copyurl/">copyurl command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="operationsdelete-remove-files-in-the-path">operations/delete: Remove files in the path</h3>
<p>This takes the following parameters</p>
<ul>
<li>fs - a remote name string eg "drive:"</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_delete/">delete command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="operationsdeletefile-remove-the-single-file-pointed-to">operations/deletefile: Remove the single file pointed to</h3>
<p>This takes the following parameters</p>
<ul>
<li>fs - a remote name string eg "drive:"</li>
<li>remote - a path within that remote eg "dir"</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_deletefile/">deletefile command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="operationslist-list-the-given-remote-and-path-in-json-format">operations/list: List the given remote and path in JSON format</h3>
<p>This takes the following parameters</p>
<ul>
<li>fs - a remote name string eg "drive:"</li>
<li>remote - a path within that remote eg "dir"</li>
<li>opt - a dictionary of options to control the listing (optional)
<ul>
<li>recurse - If set recurse directories</li>
<li>noModTime - If set return modification time</li>
<li>showEncrypted - If set show decrypted names</li>
<li>showOrigIDs - If set show the IDs for each item if known</li>
<li>showHash - If set return a dictionary of hashes</li>
</ul></li>
</ul>
<p>The result is</p>
<ul>
<li>list
<ul>
<li>This is an array of objects as described in the lsjson command</li>
</ul></li>
</ul>
<p>See the lsjson command for more information on the above and examples.</p>
<p>Authentication is required for this call.</p>
<h3id="operationsmkdir-make-a-destination-directory-or-container">operations/mkdir: Make a destination directory or container</h3>
<p>This takes the following parameters</p>
<ul>
<li>fs - a remote name string eg "drive:"</li>
<li>remote - a path within that remote eg "dir"</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_mkdir/">mkdir command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="operationsmovefile-move-a-file-from-source-remote-to-destination-remote">operations/movefile: Move a file from source remote to destination remote</h3>
<p>This takes the following parameters</p>
<ul>
<li>srcFs - a remote name string eg "drive:" for the source</li>
<li>srcRemote - a path within that remote eg "file.txt" for the source</li>
<li>dstFs - a remote name string eg "drive2:" for the destination</li>
<li>dstRemote - a path within that remote eg "file2.txt" for the destination</li>
</ul>
<p>Authentication is required for this call.</p>
<h3id="operationspurge-remove-a-directory-or-container-and-all-of-its-contents">operations/purge: Remove a directory or container and all of its contents</h3>
<p>This takes the following parameters</p>
<ul>
<li>fs - a remote name string eg "drive:"</li>
<li>remote - a path within that remote eg "dir"</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_purge/">purge command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="operationsrmdir-remove-an-empty-directory-or-container">operations/rmdir: Remove an empty directory or container</h3>
<p>This takes the following parameters</p>
<ul>
<li>fs - a remote name string eg "drive:"</li>
<li>remote - a path within that remote eg "dir"</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_rmdir/">rmdir command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="operationsrmdirs-remove-all-the-empty-directories-in-the-path">operations/rmdirs: Remove all the empty directories in the path</h3>
<p>This takes the following parameters</p>
<ul>
<li>fs - a remote name string eg "drive:"</li>
<li>remote - a path within that remote eg "dir"</li>
<li>leaveRoot - boolean, set to true not to delete the root</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_rmdirs/">rmdirs command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="operationssize-count-the-number-of-bytes-and-files-in-remote">operations/size: Count the number of bytes and files in remote</h3>
<p>This takes the following parameters</p>
<ul>
<li>fs - a remote name string eg "drive:path/to/dir"</li>
</ul>
<p>Returns</p>
<ul>
<li>count - number of files</li>
<li>bytes - number of bytes in those files</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_size/">size command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="optionsblocks-list-all-the-option-blocks">options/blocks: List all the option blocks</h3>
<p>Returns - options - a list of the options block names</p>
<h3id="optionsget-get-all-the-options">options/get: Get all the options</h3>
<p>Returns an object where keys are option block names and values are an object with the current option values in.</p>
<p>This shows the internal names of the option within rclone which should map to the external options very easily with a few exceptions.</p>
<h3id="optionsset-set-an-option">options/set: Set an option</h3>
<p>Parameters</p>
<ul>
<li>option block name containing an object with</li>
<li>key: value</li>
</ul>
<p>Repeated as often as required.</p>
<p>Only supply the options you wish to change. If an option is unknown it will be silently ignored. Not all options will have an effect when changed like this.</p>
<h3id="rcerror-this-returns-an-error">rc/error: This returns an error</h3>
<p>This returns an error with the input as part of its error string. Useful for testing error handling.</p>
<h3id="rclist-list-all-the-registered-remote-control-commands">rc/list: List all the registered remote control commands</h3>
<p>This lists all the registered remote control commands as a JSON map in the commands response.</p>
<h3id="rcnoop-echo-the-input-to-the-output-parameters">rc/noop: Echo the input to the output parameters</h3>
<p>This echoes the input parameters to the output parameters for testing purposes. It can be used to check that rclone is still alive and to check that parameter passing is working properly.</p>
<h3id="rcnoopauth-echo-the-input-to-the-output-parameters-requiring-auth">rc/noopauth: Echo the input to the output parameters requiring auth</h3>
<p>This echoes the input parameters to the output parameters for testing purposes. It can be used to check that rclone is still alive and to check that parameter passing is working properly.</p>
<p>Authentication is required for this call.</p>
<h3id="synccopy-copy-a-directory-from-source-remote-to-destination-remote">sync/copy: copy a directory from source remote to destination remote</h3>
<p>This takes the following parameters</p>
<ul>
<li>srcFs - a remote name string eg "drive:src" for the source</li>
<li>dstFs - a remote name string eg "drive:dst" for the destination</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_copy/">copy command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="syncmove-move-a-directory-from-source-remote-to-destination-remote">sync/move: move a directory from source remote to destination remote</h3>
<p>This takes the following parameters</p>
<ul>
<li>srcFs - a remote name string eg "drive:src" for the source</li>
<li>dstFs - a remote name string eg "drive:dst" for the destination</li>
<li>deleteEmptySrcDirs - delete empty src directories if set</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_move/">move command</a> command for more information on the above.</p>
<p>Authentication is required for this call.</p>
<h3id="syncsync-sync-a-directory-from-source-remote-to-destination-remote">sync/sync: sync a directory from source remote to destination remote</h3>
<p>This takes the following parameters</p>
<ul>
<li>srcFs - a remote name string eg "drive:src" for the source</li>
<li>dstFs - a remote name string eg "drive:dst" for the destination</li>
</ul>
<p>See the <ahref="https://rclone.org/commands/rclone_sync/">sync command</a> command for more information on the above.</p>
<h3id="vfsforget-forget-files-or-directories-in-the-directory-cache.">vfs/forget: Forget files or directories in the directory cache.</h3>
<p>This forgets the paths in the directory cache causing them to be re-read from the remote when needed.</p>
<p>If no paths are passed in then it will forget all the paths in the directory cache.</p>
<pre><code>rclone rc vfs/forget</code></pre>
<p>Otherwise pass files or dirs in as file=path or dir=path. Any parameter key starting with file will forget that file and any starting with dir will forget that dir, eg</p>
<h3id="vfspoll-interval-get-the-status-or-update-the-value-of-the-poll-interval-option.">vfs/poll-interval: Get the status or update the value of the poll-interval option.</h3>
<p>Without any parameter given this returns the current status of the poll-interval setting.</p>
<p>When the interval=duration parameter is set, the poll-interval value is updated and the polling function is notified. Setting interval=0 disables poll-interval.</p>
<p>The timeout=duration parameter can be used to specify a time to wait for the current poll function to apply the new value. If timeout is less or equal 0, which is the default, wait indefinitely.</p>
<p>The new poll-interval value will only be active when the timeout is not reached.</p>
<p>If poll-interval is updated or disabled temporarily, some changes might not get picked up by the polling function, depending on the used remote.</p>
<h2id="accessing-the-remote-control-via-http">Accessing the remote control via HTTP</h2>
<p>Rclone implements a simple HTTP based protocol.</p>
<p>Each endpoint takes an JSON object and returns a JSON object or an error. The JSON objects are essentially a map of string names to values.</p>
<p>All calls must made using POST.</p>
<p>The input objects can be supplied using URL parameters, POST parameters or by supplying "Content-Type: application/json" and a JSON blob in the body. There are examples of these below using <code>curl</code>.</p>
<p>The response will be a JSON blob in the body of the response. This is formatted to be reasonably human readable.</p>
<p>If an error occurs then there will be an HTTP error status (eg 500) and the body of the response will contain a JSON encoded error object, eg</p>
<pre><code>{
"error": "Expecting string value for key \"remote\" (was float64)",
"input": {
"fs": "/tmp",
"remote": 3
},
"status": 400
"path": "operations/rmdir",
}</code></pre>
<p>The keys in the error response are - error - error string - input - the input parameters to the call - status - the HTTP status code - path - the path of the call</p>
<p>The sever implements basic CORS support and allows all origins for that. The response to a preflight OPTIONS request will echo the requested "Access-Control-Request-Headers" back.</p>
<p>See the <ahref="https://golang.org/pkg/net/http/pprof/">net/http/pprof docs</a> for more info on how to use the profiling and for a general overview see <ahref="https://blog.golang.org/profiling-go-programs">the Go team's blog post on profiling go programs</a>.</p>
<p>The profiling hook is <ahref="https://stackoverflow.com/q/26545159/164234">zero overhead unless it is used</a>.</p>
<p>Each cloud storage system is slightly different. Rclone attempts to provide a unified interface to them, but some underlying differences show through.</p>
<p>The cloud storage system supports various hash types of the objects. The hashes are used when transferring data as an integrity check and can be specifically used with the <code>--checksum</code> flag in syncs and in the <code>check</code> command.</p>
<p>To use the verify checksums when transferring between cloud storage systems they must support a common hash type.</p>
<p>† Note that Dropbox supports <ahref="https://www.dropbox.com/developers/reference/content-hash">its own custom hash</a>. This is an SHA256 sum of all the 4MB block SHA256s.</p>
<p>‡ SFTP supports checksums if the same login has shell access and <code>md5sum</code> or <code>sha1sum</code> as well as <code>echo</code> are in the remote's PATH.</p>
<p>‡‡ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive for business and SharePoint server support Microsoft's own <ahref="https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash">QuickXorHash</a>.</p>
<p>The cloud storage system supports setting modification times on objects. If it does then this enables a using the modification times as part of the sync. If not then only the size will be checked by default, though the MD5SUM can be checked with the <code>--checksum</code> flag.</p>
<p>All cloud storage systems support some kind of date on the object and these will be set when transferring from the cloud storage system.</p>
<h3id="case-insensitive">Case Insensitive</h3>
<p>If a cloud storage systems is case sensitive then it is possible to have two files which differ only in case, eg <code>file.txt</code> and <code>FILE.txt</code>. If a cloud storage system is case insensitive then that isn't possible.</p>
<p>This can cause problems when syncing between a case insensitive system and a case sensitive system. The symptom of this is that no matter how many times you run the sync it never completes fully.</p>
<p>MIME types (also known as media types) classify types of documents using a simple text classification, eg <code>text/html</code> or <code>application/pdf</code>.</p>
<p>Some cloud storage systems support reading (<code>R</code>) the MIME type of objects and some support writing (<code>W</code>) the MIME type of objects.</p>
<p>The MIME type can be important if you are serving files directly to HTTP from the storage system.</p>
<p>If you are copying from a remote which supports reading (<code>R</code>) to a remote which supports writing (<code>W</code>) then rclone will preserve the MIME types. Otherwise they will be guessed from the extension, or the remote itself may assign the MIME type.</p>
<h2id="optional-features">Optional Features</h2>
<p>All the remotes support a basic set of features, but there are some optional features supported by some remotes used to make some operations more efficient.</p>
<p>This deletes a directory quicker than just deleting all the files in the directory.</p>
<p>† Note Swift and Hubic implement this in order to delete directory markers but they don't actually have a quicker way of deleting files other than deleting them individually.</p>
<p>Used when copying an object to and from the same remote. This known as a server side copy so you can copy a file without downloading it and uploading it again. It is used if you use <code>rclone copy</code> or <code>rclone move</code> if the remote doesn't support <code>Move</code> directly.</p>
<p>If the server doesn't support <code>Copy</code> directly then for copy operations the file is downloaded then re-uploaded.</p>
<h3id="move">Move</h3>
<p>Used when moving/renaming an object on the same remote. This is known as a server side move of a file. This is used in <code>rclone move</code> if the server doesn't support <code>DirMove</code>.</p>
<p>If the server isn't capable of <code>Move</code> then rclone simulates it with <code>Copy</code> then delete. If the server doesn't support <code>Copy</code> then rclone will download the file and re-upload it.</p>
<h3id="dirmove">DirMove</h3>
<p>This is used to implement <code>rclone move</code> to move a directory if possible. If it isn't then it will use <code>Move</code> on each file (which falls back to <code>Copy</code> then download and upload - see <code>Move</code> section).</p>
<h3id="cleanup">CleanUp</h3>
<p>This is used for emptying the trash for a remote by <code>rclone cleanup</code>.</p>
<p>If the server can't do <code>CleanUp</code> then <code>rclone cleanup</code> will return an error.</p>
<p>The remote supports a recursive list to list all the contents beneath a directory quickly. This enables the <code>--fast-list</code> flag to work. See the <ahref="/docs/#fast-list">rclone docs</a> for more details.</p>
<p>Some remotes allow files to be uploaded without knowing the file size in advance. This allows certain operations to work without spooling the file to local disk first, e.g. <code>rclone rcat</code>.</p>
<p>Sets the necessary permissions on a file or folder and prints a link that allows others to access them, even if they don't have an account on the particular cloud provider.</p>
<h3id="about">About</h3>
<p>This is used to fetch quota information from the remote, like bytes used/free/quota and bytes used in the trash.</p>
<p>The <code>alias</code> remote provides a new name for another remote.</p>
<p>Paths may be as deep as required or a local path, eg <code>remote:directory/subdirectory</code> or <code>/directory/subdirectory</code>.</p>
<p>During the initial setup with <code>rclone config</code> you will specify the target remote. The target remote can either be a local path or another remote.</p>
<p>Subfolders can be used in target remote. Asume a alias remote named <code>backup</code> with the target <code>mydrive:private/backup</code>. Invoking <code>rclone mkdir backup:desktop</code> is exactly the same as invoking <code>rclone mkdir mydrive:private/backup/desktop</code>.</p>
<p>There will be no special handling of paths containing <code>..</code> segments. Invoking <code>rclone mkdir backup:../desktop</code> is exactly the same as invoking <code>rclone mkdir mydrive:private/backup/../desktop</code>. The empty path is not allowed as a remote. To alias the current directory use <code>.</code> instead.</p>
<p>Here is an example of how to make a alias called <code>remote</code> for local folder. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>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.
Choose a number from below, or type in your own value
1 / Alias for a existing remote
\ "alias"
2 / Amazon Drive
\ "amazon cloud drive"
3 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3"
4 / Backblaze B2
\ "b2"
5 / Box
\ "box"
6 / Cache a remote
\ "cache"
7 / Dropbox
\ "dropbox"
8 / Encrypt/Decrypt a remote
\ "crypt"
9 / FTP Connection
\ "ftp"
10 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage"
11 / Google Drive
\ "drive"
12 / Hubic
\ "hubic"
13 / Local Disk
\ "local"
14 / Microsoft Azure Blob Storage
\ "azureblob"
15 / Microsoft OneDrive
\ "onedrive"
16 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift"
17 / Pcloud
\ "pcloud"
18 / QingCloud Object Storage
\ "qingstor"
19 / SSH/SFTP Connection
\ "sftp"
20 / Webdav
\ "webdav"
21 / Yandex Disk
\ "yandex"
22 / http Connection
\ "http"
Storage> 1
Remote or path to alias.
Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path".
remote> /mnt/storage/backup
Remote config
--------------------
[remote]
remote = /mnt/storage/backup
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d> y
Current remotes:
Name Type
==== ====
remote alias
e) Edit existing remote
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q> q</code></pre>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level in <code>/mnt/storage/backup</code></p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in <code>/mnt/storage/backup</code></p>
<pre><code>rclone ls remote:</code></pre>
<p>Copy another local directory to the alias directory called source</p>
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/alias/alias.go then run make backenddocs -->
<h3id="standard-options">Standard Options</h3>
<p>Here are the standard options specific to alias (Alias for a existing remote).</p>
<h4id="alias-remote">--alias-remote</h4>
<p>Remote or path to alias. Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path".</p>
<p>Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage service run by Amazon for consumers.</p>
<h2id="status">Status</h2>
<p><strong>Important:</strong> rclone supports Amazon Drive only if you have your own set of API keys. Unfortunately the <ahref="https://developer.amazon.com/amazon-drive">Amazon Drive developer program</a> is now closed to new entries so if you don't already have your own set of keys you will not be able to use rclone with Amazon Drive.</p>
<p>For the history on why rclone no longer has a set of Amazon Drive API keys see <ahref="https://forum.rclone.org/t/rclone-has-been-banned-from-amazon-drive/2314">the forum</a>.</p>
<p>If you happen to know anyone who works at Amazon then please ask them to re-instate rclone into the Amazon Drive developer program - thanks!</p>
<p>The initial setup for Amazon Drive involves getting a token from Amazon which you need to do in your browser. <code>rclone config</code> walks you through it.</p>
<p>The configuration process for Amazon Drive may involve using an <ahref="https://github.com/ncw/oauthproxy">oauth proxy</a>. This is used to keep the Amazon credentials out of the source code. The proxy runs in Google's very secure App Engine environment and doesn't store any credentials which pass through it.</p>
<p>Since rclone doesn't currently have its own Amazon Drive credentials so you will either need to have your own <code>client_id</code> and <code>client_secret</code> with Amazon Drive, or use a a third party ouath proxy in which case you will need to enter <code>client_id</code>, <code>client_secret</code>, <code>auth_url</code> and <code>token_url</code>.</p>
<p>Note also if you are not using Amazon's <code>auth_url</code> and <code>token_url</code>, (ie you filled in something for those) then if setting up on a remote machine you can only use the <ahref="https://rclone.org/remote_setup/#configuring-by-copying-the-config-file">copying the config method of configuration</a> - <code>rclone authorize</code> will not work.</p>
<p>See the <ahref="https://rclone.org/remote_setup/">remote setup docs</a> for how to set it up on a machine with no Internet browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect the token as returned from Amazon. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your Amazon Drive</p>
<p>Any files you delete with rclone will end up in the trash. Amazon don't provide an API to permanently delete files, nor to empty the trash, so you will have to do that with one of Amazon's apps or via the Amazon Drive website. As of November 17, 2016, files are automatically deleted by Amazon from the trash after 30 days.</p>
<h3id="using-with-non-.com-amazon-accounts">Using with non <code>.com</code> Amazon accounts</h3>
<p>Let's say you usually use <code>amazon.co.uk</code>. When you authenticate with rclone it will take you to an <code>amazon.com</code> page to log in. Your <code>amazon.co.uk</code> email and password should work here just fine.</p>
<p>Sometimes Amazon Drive gives an error when a file has been fully uploaded but the file appears anyway after a little while. This happens sometimes for files over 1GB in size and nearly every time for files bigger than 10GB. This parameter controls the time rclone waits for the file to appear.</p>
<p>The default value for this parameter is 3 minutes per GB, so by default it will wait 3 minutes for every GB uploaded to see if the file appears.</p>
<p>You can disable this feature by setting it to 0. This may cause conflict errors as rclone retries the failed upload but the file will most likely appear correctly eventually.</p>
<p>These values were determined empirically by observing lots of uploads of big files for a range of file sizes.</p>
<p>Files >= this size will be downloaded via their tempLink.</p>
<p>Files this size or more will be downloaded via their "tempLink". This is to work around a problem with Amazon Drive which blocks downloads of files bigger than about 10GB. The default for this is 9GB which shouldn't need to be changed.</p>
<p>To download files above this threshold, rclone requests a "tempLink" which downloads the file through a temporary URL directly from the underlying S3 storage.</p>
<p>Note that Amazon Drive is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".</p>
<p>Amazon Drive has rate limiting so you may notice errors in the sync (429 errors). rclone will automatically retry the sync up to 3 times by default (see <code>--retries</code> flag) which should hopefully work around this problem.</p>
<p>Amazon Drive has an internal limit of file sizes that can be uploaded to the service. This limit is not officially published, but all files larger than this will fail.</p>
<p>At the time of writing (Jan 2016) is in the area of 50GB per file. This means that larger files are likely to fail.</p>
<p>Unfortunately there is no way for rclone to see that this failure is because of file size, so it will retry the operation, as any other failure. To avoid this problem, use <code>--max-size 50000M</code> option to limit the maximum size of uploaded files. Note that <code>--max-size</code> does not split files into segments, it only ignores files over this size.</p>
<p>Paths are specified as <code>remote:bucket</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, eg <code>remote:bucket/path/to/dir</code>.</p>
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
<p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <ahref="/docs/#fast-list">rclone docs</a> for more details.</p>
<h3id="update-and---use-server-modtime">--update and --use-server-modtime</h3>
<p>As noted below, the modified time is stored on metadata on the object. It is used by default for all operations that require checking the time a file was last updated. It allows rclone to treat the remote more like a true filesystem, but it is inefficient because it requires an extra API call to retrieve the metadata.</p>
<p>For many operations, the time the object was last uploaded to the remote is sufficient to determine if it is "dirty". By using <code>--update</code> along with <code>--use-server-modtime</code>, you can avoid the extra API call and simply upload files whose local modtime is newer than the time it was last uploaded.</p>
<p>rclone supports multipart uploads with S3 which means that it can upload files bigger than 5GB.</p>
<p>Note that files uploaded <em>both</em> with multipart upload <em>and</em> through crypt remotes do not have MD5 sums.</p>
<p>Rclone switches from single part uploads to multipart uploads at the point specified by <code>--s3-upload-cutoff</code>. This can be a maximum of 5GB and a minimum of 0 (ie always upload mulipart files).</p>
<p>The chunk sizes used in the multipart upload are specified by <code>--s3-chunk-size</code> and the number of chunks uploaded concurrently is specified by <code>--s3-upload-concurrency</code>.</p>
<p>Multipart uploads will use <code>--transfers</code> * <code>--s3-upload-concurrency</code> * <code>--s3-chunk-size</code> extra memory. Single part uploads to not use extra memory.</p>
<p>Single part transfers can be faster than multipart transfers or slower depending on your latency from S3 - the more latency, the more likely single part transfers will be faster.</p>
<p>Increasing <code>--s3-upload-concurrency</code> will increase throughput (8 would be a sensible value) and increasing <code>--s3-chunk-size</code> also increases througput (16M would be sensible). Increasing either of these will use more memory. The default values are high enough to gain most of the possible performance without using too much memory.</p>
<h3id="buckets-and-regions">Buckets and Regions</h3>
<p>With Amazon S3 you can list buckets (<code>rclone lsd</code>) using any region, but you can only access the content of a bucket from the region it was created in. If you attempt to access a bucket from the wrong region, you will get an error, <code>incorrect region, the bucket is not in 'XXX' region</code>.</p>
<li>Or, use a <ahref="https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html">named profile</a>:
<ul>
<li>Profile files are standard files used by AWS CLI tools</li>
<li>By default it will use the profile in your home directory (eg <code>~/.aws/credentials</code> on unix based systems) file and the "default" profile, to change set these environment variables:
<ul>
<li><code>AWS_SHARED_CREDENTIALS_FILE</code> to control which file.</li>
<li><code>AWS_PROFILE</code> to control which profile to use.</li>
</ul></li>
</ul></li>
<li>Or, run <code>rclone</code> in an ECS task with an IAM role (AWS only).</li>
<li>Or, run <code>rclone</code> on an EC2 instance with an IAM role (AWS only).</li>
<p>If none of these option actually end up providing <code>rclone</code> with AWS credentials then S3 interaction will be non-authenticated (see below).</p>
<p>When using the <code>sync</code> subcommand of <code>rclone</code> the following minimum permissions are required to be available on the bucket being written to:</p>
<li>This is a policy that can be used when creating bucket. It assumes that <code>USER_NAME</code> has been created.</li>
<li>The Resource entry must include both resource ARNs, as one implies the bucket and the other implies the bucket's objects.</li>
</ol>
<p>For reference, <ahref="https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b">here's an Ansible script</a> that will generate one or more buckets that will work with <code>rclone sync</code>.</p>
<h3id="key-management-system-kms">Key Management System (KMS)</h3>
<p>If you are using server side encryption with KMS then you will find you can't transfer small objects. As a work-around you can use the <code>--ignore-checksum</code> flag.</p>
<p>A proper fix is being worked on in <ahref="https://github.com/ncw/rclone/issues/1824">issue #1824</a>.</p>
<p>You can upload objects using the glacier storage class or transition them to glacier using a <ahref="http://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html">lifecycle policy</a>. The bucket can still be synced or copied into normally, but if rclone tries to access data from the glacier storage class you will see an error like below.</p>
<pre><code>2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file</code></pre>
<p>In this case you need to <ahref="http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html">restore</a> the object(s) in question before using rclone.</p>
<p>Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)).</p>
<p>Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.</p>
<ul>
<li>Config: env_auth</li>
<li>Env Var: RCLONE_S3_ENV_AUTH</li>
<li>Type: bool</li>
<li>Default: false</li>
<li>Examples:
<ul>
<li>"false"
<ul>
<li>Enter AWS credentials in the next step</li>
</ul></li>
<li>"true"
<ul>
<li>Get AWS credentials from the environment (env vars or IAM)</li>
</ul></li>
</ul></li>
</ul>
<h4id="s3-access-key-id">--s3-access-key-id</h4>
<p>AWS Access Key ID. Leave blank for anonymous access or runtime credentials.</p>
<li>If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.</li>
</ul></li>
<li>"bucket-owner-full-control"
<ul>
<li>Both the object owner and the bucket owner get FULL_CONTROL over the object.</li>
<li>If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.</li>
</ul></li>
<li>"private"
<ul>
<li>Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS</li>
</ul></li>
<li>"public-read"
<ul>
<li>Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS</li>
</ul></li>
<li>"public-read-write"
<ul>
<li>Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS</li>
</ul></li>
<li>"authenticated-read"
<ul>
<li>Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS</li>
<p>Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)).</p>
<h4id="s3-bucket-acl">--s3-bucket-acl</h4>
<p>Canned ACL used when creating buckets.</p>
<p>For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl</p>
<p>Note that this ACL is applied when only when creating buckets. If it isn't set then "acl" is used instead.</p>
<ul>
<li>Config: bucket_acl</li>
<li>Env Var: RCLONE_S3_BUCKET_ACL</li>
<li>Type: string</li>
<li>Default: ""</li>
<li>Examples:
<ul>
<li>"private"
<ul>
<li>Owner gets FULL_CONTROL. No one else has access rights (default).</li>
</ul></li>
<li>"public-read"
<ul>
<li>Owner gets FULL_CONTROL. The AllUsers group gets READ access.</li>
</ul></li>
<li>"public-read-write"
<ul>
<li>Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.</li>
<li>Granting this on a bucket is generally not recommended.</li>
</ul></li>
<li>"authenticated-read"
<ul>
<li>Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.</li>
</ul></li>
</ul></li>
</ul>
<h4id="s3-upload-cutoff">--s3-upload-cutoff</h4>
<p>Cutoff for switching to chunked upload</p>
<p>Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5GB.</p>
<p>This is the number of chunks of the same file that are uploaded concurrently.</p>
<p>If you are uploading small numbers of large file over high speed link and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers.</p>
<p>If true use path style access if false use virtual hosted style.</p>
<p>If this is true (the default) then rclone will use path style access, if false then rclone will use virtual path style. See <ahref="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">the AWS S3 docs</a> for more info.</p>
<p>Some providers (eg Aliyun OSS or Netease COS) require this set to false.</p>
<ul>
<li>Config: force_path_style</li>
<li>Env Var: RCLONE_S3_FORCE_PATH_STYLE</li>
<li>Type: bool</li>
<li>Default: true</li>
</ul>
<h4id="s3-v2-auth">--s3-v2-auth</h4>
<p>If true use v2 authentication.</p>
<p>If this is false (the default) then rclone will use v4 authentication. If it is set then rclone will use v2 authentication.</p>
<p>Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH.</p>
<ul>
<li>Config: v2_auth</li>
<li>Env Var: RCLONE_S3_V2_AUTH</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<!--- autogenerated options stop -->
<h3id="anonymous-access-to-public-buckets">Anonymous access to public buckets</h3>
<p>If you want to use rclone to access a public bucket, configure with a blank <code>access_key_id</code> and <code>secret_access_key</code>. Your config should end up looking like this:</p>
<pre><code>[anons3]
type = s3
provider = AWS
env_auth = false
access_key_id =
secret_access_key =
region = us-east-1
endpoint =
location_constraint =
acl = private
server_side_encryption =
storage_class = </code></pre>
<p>Then use it as normal with the name of the public bucket, eg</p>
<p>You will be able to list and copy data but not upload it.</p>
<h3id="ceph">Ceph</h3>
<p><ahref="https://ceph.com/">Ceph</a> is an open source unified, distributed storage system designed for excellent performance, reliability and scalability. It has an S3 compatible object storage interface.</p>
<p>To use rclone with Ceph, configure as above but leave the region blank and set the endpoint. You should end up with something like this in your config:</p>
<pre><code>[ceph]
type = s3
provider = Ceph
env_auth = false
access_key_id = XXX
secret_access_key = YYY
region =
endpoint = https://ceph.endpoint.example.com
location_constraint =
acl =
server_side_encryption =
storage_class =</code></pre>
<p>Note also that Ceph sometimes puts <code>/</code> in the passwords it gives users. If you read the secret access key using the command line tools you will get a JSON blob with the <code>/</code> escaped as <code>\/</code>. Make sure you only write <code>/</code> in the secret access key.</p>
<p>Eg the dump from Ceph looks something like this (irrelevant keys removed).</p>
<pre><code>{
"user_id": "xxx",
"display_name": "xxxx",
"keys": [
{
"user": "xxx",
"access_key": "xxxxxx",
"secret_key": "xxxxxx\/xxxx"
}
],
}</code></pre>
<p>Because this is a json dump, it is encoding the <code>/</code> as <code>\/</code>, so if you use the secret key as <code>xxxxxx/xxxx</code> it will work fine.</p>
<h3id="dreamhost">Dreamhost</h3>
<p>Dreamhost <ahref="https://www.dreamhost.com/cloud/storage/">DreamObjects</a> is an object storage system based on CEPH.</p>
<p>To use rclone with Dreamhost, configure as above but leave the region blank and set the endpoint. You should end up with something like this in your config:</p>
<p><ahref="https://www.digitalocean.com/products/object-storage/">Spaces</a> is an <ahref="https://developers.digitalocean.com/documentation/spaces/">S3-interoperable</a> object storage service from cloud provider DigitalOcean.</p>
<p>To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the "<ahref="https://cloud.digitalocean.com/settings/api/tokens">Applications & API</a>" page of the DigitalOcean control panel. They will be needed when promted by <code>rclone config</code> for your <code>access_key_id</code> and <code>secret_access_key</code>.</p>
<p>When prompted for a <code>region</code> or <code>location_constraint</code>, press enter to use the default value. The region must be included in the <code>endpoint</code> setting (e.g. <code>nyc3.digitaloceanspaces.com</code>). The defualt values can be used for other settings.</p>
<p>Going through the whole process of creating a new remote by running <code>rclone config</code>, each prompt should be answered as shown below:</p>
<pre><code>Storage> s3
env_auth> 1
access_key_id> YOUR_ACCESS_KEY
secret_access_key> YOUR_SECRET_KEY
region>
endpoint> nyc3.digitaloceanspaces.com
location_constraint>
acl>
storage_class></code></pre>
<p>The resulting configuration file should look like:</p>
<pre><code>[spaces]
type = s3
provider = DigitalOcean
env_auth = false
access_key_id = YOUR_ACCESS_KEY
secret_access_key = YOUR_SECRET_KEY
region =
endpoint = nyc3.digitaloceanspaces.com
location_constraint =
acl =
server_side_encryption =
storage_class =</code></pre>
<p>Once configured, you can create a new Space and begin copying files. For example:</p>
<p>Information stored with IBM Cloud Object Storage is encrypted and dispersed across multiple geographic locations, and accessed through an implementation of the S3 API. This service makes use of the distributed storage technologies provided by IBM’s Cloud Object Storage System (formerly Cleversafe). For more information visit: (http://www.ibm.com/cloud/object-storage)</p>
<p>To configure access to IBM COS S3, follow the steps below:</p>
<olstyle="list-style-type: decimal">
<li><p>Run rclone config and select n for a new remote.</p>
<pre><code>2018/02/14 14:13:11 NOTICE: Config file "C:\\Users\\a\\.config\\rclone\\rclone.conf" not found - using defaults
<li><p>Specify a IBM COS Location Constraint. The location constraint must match endpoint when using IBM Cloud Public. For on-prem COS, do not make a selection from this list, hit enter</p>
<pre><code> 1 / US Cross Region Standard
\ "us-standard"
2 / US Cross Region Vault
\ "us-vault"
3 / US Cross Region Cold
\ "us-cold"
4 / US Cross Region Flex
\ "us-flex"
5 / US East Region Standard
\ "us-east-standard"
6 / US East Region Vault
\ "us-east-vault"
7 / US East Region Cold
\ "us-east-cold"
8 / US East Region Flex
\ "us-east-flex"
9 / US South Region Standard
\ "us-south-standard"
10 / US South Region Vault
\ "us-south-vault"
[snip]
32 / Toronto Flex
\ "tor01-flex"
location_constraint>1</code></pre></li>
<li><p>Specify a canned ACL. IBM Cloud (Strorage) supports "public-read" and "private". IBM Cloud(Infra) supports all the canned ACLs. On-Premise COS supports all the canned ACLs.</p>
1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS
\ "private"
2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS
\ "public-read"
3 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS
\ "public-read-write"
4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS
<p><ahref="https://www.scaleway.com/object-storage/">Scaleway</a> The Object Storage platform allows you to store anything from backups, logs and web assets to documents and photos. Files can be dropped from the Scaleway console or transferred through our API and CLI or using any S3-compatible tool.</p>
<p>Scaleway provides an S3 interface which can be configured for use with rclone like this:</p>
<p><ahref="https://wasabi.com">Wasabi</a> is a cloud-based object storage service for a broad range of applications and use cases. Wasabi is designed for individuals and organizations that require a high-performance, reliable, and secure data storage infrastructure at minimal cost.</p>
<p>Wasabi provides an S3 interface which can be configured for use with rclone like this.</p>
<pre><code>No remotes found - make a new one
n) New remote
s) Set configuration password
n/s> n
name> wasabi
Type of storage to configure.
Choose a number from below, or type in your own value
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
<p>For Netease NOS configure as per the configurator <code>rclone config</code> setting the provider <code>Netease</code>. This will automatically set <code>force_path_style = false</code> which is necessary for it to run properly.</p>
<p>B2 is <ahref="https://www.backblaze.com/b2/">Backblaze's cloud storage system</a>.</p>
<p>Paths are specified as <code>remote:bucket</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, eg <code>remote:bucket/path/to/dir</code>.</p>
<p>Here is an example of making a b2 configuration. First run</p>
<p>This will guide you through an interactive setup process. To authenticate you will either need your Account ID (a short hex number) and Master Application Key (a long hex number) OR an Application Key, which is the recommended method. See below for further details on generating and using an Application Key.</p>
<p>B2 supports multiple <ahref="https://www.backblaze.com/b2/docs/application_keys.html">Application Keys for different access permission to B2 Buckets</a>.</p>
<p>You can use these with rclone too; you will need to use rclone version 1.43 or later.</p>
<p>Follow Backblaze's docs to create an Application Key with the required permission and add the <code>applicationKeyId</code> as the <code>account</code> and the <code>Application Key</code> itself as the <code>key</code>.</p>
<p>Note that you must put the <em>applicationKeyId</em> as the <code>account</code>– you can't use the master Account ID. If you try then B2 will return 401 errors.</p>
<p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <ahref="/docs/#fast-list">rclone docs</a> for more details.</p>
<h3id="modified-time-1">Modified time</h3>
<p>The modified time is stored as metadata on the object as <code>X-Bz-Info-src_last_modified_millis</code> as milliseconds since 1970-01-01 in the Backblaze standard. Other tools should be able to use this as a modified time.</p>
<p>Modified times are used in syncing and are fully supported except in the case of updating a modification time on an existing object. In this case the object will be uploaded again as B2 doesn't have an API method to set the modification time independent of doing an upload.</p>
<h3id="sha1-checksums">SHA1 checksums</h3>
<p>The SHA1 checksums of the files are checked on upload and download and will be used in the syncing process.</p>
<p>Large files (bigger than the limit in <code>--b2-upload-cutoff</code>) which are uploaded in chunks will store their SHA1 on the object as <code>X-Bz-Info-large_file_sha1</code> as recommended by Backblaze.</p>
<p>For a large file to be uploaded with an SHA1 checksum, the source needs to support SHA1 checksums. The local disk supports SHA1 checksums so large file transfers from local disk will have an SHA1. See <ahref="/overview/#features">the overview</a> for exactly which remotes support SHA1.</p>
<p>Sources which don't support SHA1, in particular <code>crypt</code> will upload large files without SHA1 checksums. This may be fixed in the future (see <ahref="https://github.com/ncw/rclone/issues/1767">#1767</a>).</p>
<p>Files sizes below <code>--b2-upload-cutoff</code> will always have an SHA1 regardless of the source.</p>
<p>Backblaze recommends that you do lots of transfers simultaneously for maximum speed. In tests from my SSD equipped laptop the optimum setting is about <code>--transfers 32</code> though higher numbers may be used for a slight speed improvement. The optimum number for you may vary depending on your hardware, how big the files are, how much you want to load your computer, etc. The default of <code>--transfers 4</code> is definitely too low for Backblaze B2 though.</p>
<p>Note that uploading big files (bigger than 200 MB by default) will use a 96 MB RAM buffer by default. There can be at most <code>--transfers</code> of these in use at any moment, so this sets the upper limit on the memory used.</p>
<h3id="versions">Versions</h3>
<p>When rclone uploads a new version of a file it creates a <ahref="https://www.backblaze.com/b2/docs/file_versions.html">new version of it</a>. Likewise when you delete a file, the old version will be marked hidden and still be available. Conversely, you may opt in to a "hard delete" of files with the <code>--b2-hard-delete</code> flag which would permanently remove the file instead of hiding it.</p>
<p>Old versions of files, where available, are visible using the <code>--b2-versions</code> flag.</p>
<p>If you wish to remove all the old versions then you can use the <code>rclone cleanup remote:bucket</code> command which will delete all the old versions of files, leaving the current ones intact. You can also supply a path and only old versions under that path will be deleted, eg <code>rclone cleanup remote:bucket/path/to/stuff</code>.</p>
<p>Clean up all the old versions and show that they've gone.</p>
<pre><code>$ rclone -q cleanup b2:cleanup-test
$ rclone -q ls b2:cleanup-test
9 one.txt
$ rclone -q --b2-versions ls b2:cleanup-test
9 one.txt</code></pre>
<h3id="data-usage">Data usage</h3>
<p>It is useful to know how many requests are sent to the server in different scenarios.</p>
<p>All copy commands send the following 4 requests:</p>
<pre><code>/b2api/v1/b2_authorize_account
/b2api/v1/b2_create_bucket
/b2api/v1/b2_list_buckets
/b2api/v1/b2_list_file_names</code></pre>
<p>The <code>b2_list_file_names</code> request will be sent once for every 1k files in the remote path, providing the checksum and modification time of the listed files. As of version 1.33 issue <ahref="https://github.com/ncw/rclone/issues/818">#818</a> causes extra requests to be sent when using B2 with Crypt. When a copy operation does not require any files to be uploaded, no more requests will be sent.</p>
<p>Uploading files that do not require chunking, will send 2 requests per file upload:</p>
<pre><code>/b2api/v1/b2_get_upload_url
/b2api/v1/b2_upload_file/</code></pre>
<p>Uploading files requiring chunking, will send 2 requests (one each to start and finish the upload) and another 2 requests for each chunk:</p>
<pre><code>$ rclone -q --b2-versions ls b2:cleanup-test
9 one.txt
8 one-v2016-07-04-141032-000.txt
16 one-v2016-07-04-141003-000.txt
15 one-v2016-07-02-155621-000.txt</code></pre>
<p>Showing that the current version is unchanged but older versions can be seen. These have the UTC date that they were uploaded to the server to the nearest millisecond appended to them.</p>
<p>Note that when using <code>--b2-versions</code> no file write operations are permitted, so you can't upload files or delete them.</p>
<p>These will be set in the "X-Bz-Test-Mode" header which is documented in the <ahref="https://www.backblaze.com/b2/docs/integration_checklist.html">b2 integrations checklist</a>.</p>
<ul>
<li>Config: test_mode</li>
<li>Env Var: RCLONE_B2_TEST_MODE</li>
<li>Type: string</li>
<li>Default: ""</li>
</ul>
<h4id="b2-versions">--b2-versions</h4>
<p>Include old versions in directory listings. Note that when using this no file write operations are permitted, so you can't upload files or delete them.</p>
<ul>
<li>Config: versions</li>
<li>Env Var: RCLONE_B2_VERSIONS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4id="b2-upload-cutoff">--b2-upload-cutoff</h4>
<p>Cutoff for switching to chunked upload.</p>
<p>Files above this size will be uploaded in chunks of "--b2-chunk-size".</p>
<p>This value should be set no larger than 4.657GiB (== 5GB).</p>
<p>When uploading large files, chunk the file into this size. Note that these chunks are buffered in memory and there might a maximum of "--transfers" chunks in progress at once. 5,000,000 Bytes is the minimum size.</p>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p>
<p>The initial setup for Box involves getting a token from Box which you need to do in your browser. <code>rclone config</code> walks you through it.</p>
<p>Here is an example of how to make a remote called <code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>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.
Choose a number from below, or type in your own value
1 / Amazon Drive
\ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3"
3 / Backblaze B2
\ "b2"
4 / Box
\ "box"
5 / Dropbox
\ "dropbox"
6 / Encrypt/Decrypt a remote
\ "crypt"
7 / FTP Connection
\ "ftp"
8 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage"
9 / Google Drive
\ "drive"
10 / Hubic
\ "hubic"
11 / Local Disk
\ "local"
12 / Microsoft OneDrive
\ "onedrive"
13 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift"
14 / SSH/SFTP Connection
\ "sftp"
15 / Yandex Disk
\ "yandex"
16 / http Connection
\ "http"
Storage> box
Box App Client Id - leave blank normally.
client_id>
Box App Client Secret - leave blank normally.
client_secret>
Remote config
Use auto config?
* Say Y if not sure
* Say N if you are working on a remote or headless machine
y) Yes
n) No
y/n> y
If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
<p>See the <ahref="https://rclone.org/remote_setup/">remote setup docs</a> for how to set it up on a machine with no Internet browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect the token as returned from Box. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your Box</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your Box</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an Box directory called backup</p>
<h3id="using-rclone-with-an-enterprise-account-with-sso">Using rclone with an Enterprise account with SSO</h3>
<p>If you have an "Enterprise" account type with Box with single sign on (SSO), you need to create a password to use Box with rclone. This can be done at your Enterprise Box account by going to Settings, "Account" Tab, and then set the password in the "Authentication" field.</p>
<p>Once you have done this, you can setup your Enterprise Box account using the same procedure detailed above in the, using the password you have just set.</p>
<p>According to the <ahref="https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens">box docs</a>:</p>
<blockquote>
<p>Each refresh_token is valid for one use in 60 days.</p>
</blockquote>
<p>This means that if you</p>
<ul>
<li>Don't use the box remote for 60 days</li>
<li>Copy the config file with a box refresh token in and use it in two places</li>
<li>Get an error on a token refresh</li>
</ul>
<p>then rclone will return an error which includes the text <code>Invalid refresh token</code>.</p>
<p>To fix this you will need to use oauth2 again to update the refresh token. You can use the methods in <ahref="https://rclone.org/remote_setup/">the remote setup docs</a>, bearing in mind that if you use the copy the config file method, you should not use that remote on the computer you did the authentication on.</p>
<p>Here is how to do it.</p>
<pre><code>$ rclone config
Current remotes:
Name Type
==== ====
remote box
e) Edit existing remote
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q> e
Choose a number from below, or type in an existing value
<p>For files above 50MB rclone will use a chunked transfer. Rclone will upload up to <code>--transfers</code> chunks at the same time (shared among all the multipart uploads). Chunks are buffered in memory and are normally 8MB so increasing <code>--transfers</code> will increase memory use.</p>
<h3id="deleting-files-1">Deleting files</h3>
<p>Depending on the enterprise settings for your user, the item will either be actually deleted from Box or moved to the trash.</p>
<p>The <code>cache</code> remote wraps another existing remote and stores file structure and its data for long running tasks like <code>rclone mount</code>.</p>
<p>To get started you just need to have an existing remote which can be configured with <code>cache</code>.</p>
<p>Here is an example of how to make a remote called <code>test-cache</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found - make a new one
n) New remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
n/r/c/s/q> n
name> test-cache
Type of storage to configure.
Choose a number from below, or type in your own value
...
5 / Cache a remote
\ "cache"
...
Storage> 5
Remote to cache.
Normally should contain a ':' and a path, eg "myremote:path/to/dir",
"myremote:bucket" or maybe "myremote:" (not recommended).
remote> local:/test
Optional: The URL of the Plex server
plex_url> http://127.0.0.1:32400
Optional: The username of the Plex user
plex_username> dummyusername
Optional: The password of the Plex user
y) Yes type in my own password
g) Generate random password
n) No leave this optional password blank
y/g/n> y
Enter the password:
password:
Confirm the password:
password:
The size of a chunk. Lower value good for slow connections but can affect seamless reading.
Default: 5M
Choose a number from below, or type in your own value
1 / 1MB
\ "1m"
2 / 5 MB
\ "5M"
3 / 10 MB
\ "10M"
chunk_size> 2
How much time should object info (file size, file hashes etc) be stored in cache. Use a very high value if you don't plan on changing the source FS from outside the cache.
Accepted units are: "s", "m", "h".
Default: 5m
Choose a number from below, or type in your own value
1 / 1 hour
\ "1h"
2 / 24 hours
\ "24h"
3 / 24 hours
\ "48h"
info_age> 2
The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted.
Default: 10G
Choose a number from below, or type in your own value
1 / 500 MB
\ "500M"
2 / 1 GB
\ "1G"
3 / 10 GB
\ "10G"
chunk_total_size> 3
Remote config
--------------------
[test-cache]
remote = local:/test
plex_url = http://127.0.0.1:32400
plex_username = dummyusername
plex_password = *** ENCRYPTED ***
chunk_size = 5M
info_age = 48h
chunk_total_size = 10G</code></pre>
<p>You can then use it like this,</p>
<p>List directories in top level of your drive</p>
<pre><code>rclone lsd test-cache:</code></pre>
<p>List all the files in your drive</p>
<pre><code>rclone ls test-cache:</code></pre>
<p>To start a cached mount</p>
<pre><code>rclone mount --allow-other test-cache: /var/tmp/test-cache</code></pre>
<p>In an effort to make writing through cache more reliable, the backend now supports this feature which can be activated by specifying a <code>cache-tmp-upload-path</code>.</p>
<p>A files goes through these states when using this feature:</p>
<olstyle="list-style-type: decimal">
<li>An upload is started (usually by copying a file on the cache remote)</li>
<li>When the copy to the temporary location is complete the file is part of the cached remote and looks and behaves like any other file (reading included)</li>
<li>After <code>cache-tmp-wait-time</code> passes and the file is next in line, <code>rclone move</code> is used to move the file to the cloud provider</li>
<li>Reading the file still works during the upload but most modifications on it will be prohibited</li>
<li>Once the move is complete the file is unlocked for modifications as it becomes as any other regular file</li>
<li>If the file is being read through <code>cache</code> when it's actually deleted from the temporary path then <code>cache</code> will simply swap the source to the cloud provider without interrupting the reading (small blip can happen though)</li>
<p>Files are uploaded in sequence and only one file is uploaded at a time. Uploads will be stored in a queue and be processed based on the order they were added. The queue and the temporary storage is persistent across restarts but can be cleared on startup with the <code>--cache-db-purge</code> flag.</p>
<p>Writes are supported through <code>cache</code>. One caveat is that a mounted cache remote does not add any retry or fallback mechanism to the upload operation. This will depend on the implementation of the wrapped remote. Consider using <code>Offline uploading</code> for reliable writes.</p>
<p>One special case is covered with <code>cache-writes</code> which will cache the file data at the same time as the upload when it is enabled making it available from the cache store immediately once the upload is finished.</p>
<p>To counter the high latency between a local PC where rclone is running and cloud providers, the cache remote can split multiple requests to the cloud provider for smaller file chunks and combines them together locally where they can be available almost immediately before the reader usually needs them.</p>
<p>This is similar to buffering when media files are played online. Rclone will stay around the current marker but always try its best to stay ahead and prepare the data before.</p>
<h4id="plex-integration">Plex Integration</h4>
<p>There is a direct integration with Plex which allows cache to detect during reading if the file is in playback or not. This helps cache to adapt how it queries the cloud provider depending on what is needed for.</p>
<p>Scans will have a minimum amount of workers (1) while in a confirmed playback cache will deploy the configured number of workers.</p>
<p>This integration opens the doorway to additional performance improvements which will be explored in the near future.</p>
<p><strong>Note:</strong> If Plex options are not configured, <code>cache</code> will function with its configured options without adapting any of its settings.</p>
<p>How to enable? Run <code>rclone config</code> and add all the Plex options (endpoint, username and password) in your remote and it will be automatically enabled.</p>
<p>Affected settings: - <code>cache-workers</code>: <em>Configured value</em> during confirmed playback or <em>1</em> all the other times</p>
<p>When the Plex server is configured to only accept secure connections, it is possible to use <code>.plex.direct</code> URL's to ensure certificate validation succeeds. These URL's are used by Plex internally to connect to the Plex server securely.</p>
<p>The format for this URL's is the following:</p>
<p>The <code>ip-with-dots-replaced</code> part can be any IPv4 address, where the dots have been replaced with dashes, e.g. <code>127.0.0.1</code> becomes <code>127-0-0-1</code>.</p>
<p>To get the <code>server-hash</code> part, the easiest way is to visit</p>
<p>This page will list all the available Plex servers for your account with at least one <code>.plex.direct</code> link for each. Copy one URL and replace the IP address with the desired address. This can be used as the <code>plex_url</code> value.</p>
<h4id="mount-and---dir-cache-time">Mount and --dir-cache-time</h4>
<p>--dir-cache-time controls the first layer of directory caching which works at the mount layer. Being an independent caching mechanism from the <code>cache</code> backend, it will manage its own entries based on the configured time.</p>
<p>To avoid getting in a scenario where dir cache has obsolete data and cache would have the correct one, try to set <code>--dir-cache-time</code> to a lower time than <code>--cache-info-age</code>. Default values are already configured in this way.</p>
<h4id="windows-support---experimental">Windows support - Experimental</h4>
<p>There are a couple of issues with Windows <code>mount</code> functionality that still require some investigations. It should be considered as experimental thus far as fixes come in for this OS.</p>
<p>Most of the issues seem to be related to the difference between filesystems on Linux flavors and Windows as cache is heavily dependant on them.</p>
<p>Any reports or feedback on how cache behaves on this OS is greatly appreciated.</p>
<h4id="risk-of-throttling">Risk of throttling</h4>
<p>Future iterations of the cache backend will make use of the pooling functionality of the cloud provider to synchronize and at the same time make writing through it more tolerant to failures.</p>
<p>There are a couple of enhancements in track to add these but in the meantime there is a valid concern that the expiring cache listings can lead to cloud provider throttles or bans due to repeated queries on it for very large mounts.</p>
<p>Some recommendations: - don't use a very small interval for entry informations (<code>--cache-info-age</code>) - while writes aren't yet optimised, you can still write through <code>cache</code> which gives you the advantage of adding the file in the cache at the same time if configured to do so.</p>
<p>One common scenario is to keep your data encrypted in the cloud provider using the <code>crypt</code> remote. <code>crypt</code> uses a similar technique to wrap around an existing remote and handles this translation in a seamless way.</p>
<p>There is an issue with wrapping the remotes in this order: <spanstyle="color:red"><strong>cloud remote</strong> -><strong>crypt</strong> -><strong>cache</strong></span></p>
<p>During testing, I experienced a lot of bans with the remotes in this order. I suspect it might be related to how crypt opens files on the cloud provider which makes it think we're downloading the full file instead of small chunks. Organizing the remotes in this order yelds better results: <spanstyle="color:green"><strong>cloud remote</strong> -><strong>cache</strong> -><strong>crypt</strong></span></p>
<p><code>cache</code> can not differentiate between relative and absolute paths for the wrapped remote. Any path given in the <code>remote</code> config setting and on the command line will be passed to the wrapped remote as is, but for storing the chunks on disk the path will be made relative by removing any leading <code>/</code> character.</p>
<p>This behavior is irrelevant for most backend types, but there are backends where a leading <code>/</code> changes the effective directory, e.g. in the <code>sftp</code> backend paths starting with a <code>/</code> are relative to the root of the SSH server and paths without are relative to the user home directory. As a result <code>sftp:bin</code> and <code>sftp:/bin</code> will share the same cache folder, even if they represent a different directory on the SSH server.</p>
<h3id="cache-and-remote-control---rc">Cache and Remote Control (--rc)</h3>
<p>Cache supports the new <code>--rc</code> mode in rclone and can be remote controlled through the following end points: By default, the listener is disabled if you do not add the flag.</p>
<h3id="rc-cacheexpire">rc cache/expire</h3>
<p>Purge a remote from the cache backend. Supports either a directory or a file. It supports both encrypted and unencrypted file names if cache is wrapped by crypt.</p>
<p>Params: - <strong>remote</strong> = path to remote <strong>(required)</strong> - <strong>withData</strong> = true/false to delete cached data (chunks) as well <em>(optional, false by default)</em></p>
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/cache/cache.go then run make backenddocs -->
<h3id="standard-options-5">Standard Options</h3>
<p>Here are the standard options specific to cache (Cache a remote).</p>
<h4id="cache-remote">--cache-remote</h4>
<p>Remote to cache. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended).</p>
<p>Use lower numbers for slower connections. If the chunk size is changed, any downloaded chunks will be invalid and cache-chunk-path will need to be cleared or unexpected EOF errors will occur.</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_CACHE_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 5M</li>
<li>Examples:
<ul>
<li>"1m"
<ul>
<li>1MB</li>
</ul></li>
<li>"5M"
<ul>
<li>5 MB</li>
</ul></li>
<li>"10M"
<ul>
<li>10 MB</li>
</ul></li>
</ul></li>
</ul>
<h4id="cache-info-age">--cache-info-age</h4>
<p>How long to cache file structure information (directory listings, file size, times etc). If all write operations are done through the cache then you can safely make this value very large as the cache store will also be updated in real time.</p>
<p>Path to where partial file data (chunks) are stored locally. The remote name is appended to the final path.</p>
<p>This config follows the "--cache-db-path". If you specify a custom location for "--cache-db-path" and don't specify one for "--cache-chunk-path" then "--cache-chunk-path" will use the same path as "--cache-db-path".</p>
<p>How often should the cache perform cleanups of the chunk storage. The default value should be ok for most people. If you find that the cache goes over "cache-chunk-total-size" too often then try to lower this value to force it to perform cleanups more often.</p>
<p>Since reading from a cache stream is independent from downloading file data, readers can get to a point where there's no more data in the cache. Most of the times this can indicate a connectivity issue if cache isn't able to provide file data anymore.</p>
<p>How many workers should run in parallel to download chunks.</p>
<p>Higher values will mean more parallel processing (better CPU needed) and more concurrent requests on the cloud provider. This impacts several aspects like the cloud provider API limits, more stress on the hardware that rclone runs on but it also means that streams will be more fluid and data will be available much more faster to readers.</p>
<p><strong>Note</strong>: If the optional Plex integration is enabled then this setting will adapt to the type of reading performed and the value specified here will be used as a maximum number of workers to use.</p>
<p>Disable the in-memory cache for storing chunks during streaming.</p>
<p>By default, cache will keep file data during streaming in RAM as well to provide it to readers as fast as possible.</p>
<p>This transient data is evicted as soon as it is read and the number of chunks stored doesn't exceed the number of workers. However, depending on other settings like "cache-chunk-size" and "cache-workers" this footprint can increase if there are parallel streams too (multiple files being read at the same time).</p>
<p>If the hardware permits it, use this feature to provide an overall better performance during streaming but it can also be disabled if RAM is not available on the local machine.</p>
<p>Limits the number of requests per second to the source FS (-1 to disable)</p>
<p>This setting places a hard limit on the number of requests per second that cache will be doing to the cloud provider remote and try to respect that value by setting waits between reads.</p>
<p>If you find that you're getting banned or limited on the cloud provider through cache and know that a smaller number of requests per second will allow you to work with it then you can use this setting for that.</p>
<p>A good balance of all the other settings should make this setting useless but it is available to set for more special cases.</p>
<p><strong>NOTE</strong>: This will limit the number of requests during streams but other API calls to the cloud provider like directory listings will still pass.</p>
<p>If you need to read files immediately after you upload them through cache you can enable this flag to have their data stored in the cache store at the same time during upload.</p>
<p>Only one process can have the DB open at any one time, so rclone waits for this duration for the DB to become available before it gives an error.</p>
<p>If you set it to 0 then it will wait forever.</p>
<p>The <code>crypt</code> remote encrypts and decrypts another remote.</p>
<p>To use it first set up the underlying remote following the config instructions for that remote. You can also use a local pathname instead of a remote which will encrypt and decrypt from that directory which might be useful for encrypting onto a USB stick for example.</p>
<p>First check your chosen remote is working - we'll call it <code>remote:path</code> in these docs. Note that anything inside <code>remote:path</code> will be encrypted and anything outside won't. This means that if you are using a bucket based remote (eg S3, B2, swift) then you should probably put the bucket in the remote <code>s3:bucket</code>. If you just use <code>s3:</code> then rclone will make encrypted bucket names too (if using file name encryption) which may or may not be what you want.</p>
<p>Now configure <code>crypt</code> using <code>rclone config</code>. We will call this one <code>secret</code> to differentiate it from the <code>remote</code>.</p>
<pre><code>No remotes found - make a new one
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n
name> secret
Type of storage to configure.
Choose a number from below, or type in your own value
1 / Amazon Drive
\ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3"
3 / Backblaze B2
\ "b2"
4 / Dropbox
\ "dropbox"
5 / Encrypt/Decrypt a remote
\ "crypt"
6 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage"
7 / Google Drive
\ "drive"
8 / Hubic
\ "hubic"
9 / Local Disk
\ "local"
10 / Microsoft OneDrive
\ "onedrive"
11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift"
12 / SSH/SFTP Connection
\ "sftp"
13 / Yandex Disk
\ "yandex"
Storage> 5
Remote to encrypt/decrypt.
Normally should contain a ':' and a path, eg "myremote:path/to/dir",
"myremote:bucket" or maybe "myremote:" (not recommended).
remote> remote:path
How to encrypt the filenames.
Choose a number from below, or type in your own value
1 / Don't encrypt the file names. Adds a ".bin" extension only.
\ "off"
2 / Encrypt the filenames see the docs for the details.
Password or pass phrase for salt. Optional but recommended.
Should be different to the previous password.
y) Yes type in my own password
g) Generate random password
n) No leave this optional password blank
y/g/n> g
Password strength in bits.
64 is just about memorable
128 is secure
1024 is the maximum
Bits> 128
Your password is: JAsJvRcgR-_veXNfy_sGmQ
Use this password?
y) Yes
n) No
y/n> y
Remote config
--------------------
[secret]
remote = remote:path
filename_encryption = standard
password = *** ENCRYPTED ***
password2 = *** ENCRYPTED ***
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d> y</code></pre>
<p><strong>Important</strong> The password is stored in the config file is lightly obscured so it isn't immediately obvious what it is. It is in no way secure unless you use config file encryption.</p>
<p>A long passphrase is recommended, or you can use a random one. Note that if you reconfigure rclone with the same passwords/passphrases elsewhere it will be compatible - all the secrets used are derived from those two passwords/passphrases.</p>
<p>Note that rclone does not encrypt</p>
<ul>
<li>file length - this can be calcuated within 16 bytes</li>
<li>modification time - used for syncing</li>
</ul>
<h2id="specifying-the-remote">Specifying the remote</h2>
<p>In normal use, make sure the remote has a <code>:</code> in. If you specify the remote without a <code>:</code> then rclone will use a local directory of that name. So if you use a remote of <code>/path/to/secret/files</code> then rclone will encrypt stuff to that directory. If you use a remote of <code>name</code> then rclone will put files in a directory called <code>name</code> in the current directory.</p>
<p>If you specify the remote as <code>remote:path/to/dir</code> then rclone will store encrypted files in <code>path/to/dir</code> on the remote. If you are using file name encryption, then when you save files to <code>secret:subdir/subfile</code> this will store them in the unencrypted path <code>path/to/dir</code> but the <code>subdir/subpath</code> bit will be encrypted.</p>
<p>Note that unless you want encrypted bucket names (which are difficult to manage because you won't know what directory they represent in web interfaces etc), you should probably specify a bucket, eg <code>remote:secretbucket</code> when using bucket based remotes such as S3, Swift, Hubic, B2, GCS.</p>
<h2id="example">Example</h2>
<p>To test I made a little directory of files using "standard" file name encryption.</p>
<pre><code>plaintext/
├── file0.txt
├── file1.txt
└── subdir
├── file2.txt
├── file3.txt
└── subsubdir
└── file4.txt</code></pre>
<p>Copy these to the remote and list them back</p>
<pre><code>$ rclone -q copy plaintext secret:
$ rclone -q ls secret:
7 file1.txt
6 file0.txt
8 subdir/file2.txt
10 subdir/subsubdir/file4.txt
9 subdir/file3.txt</code></pre>
<p>Now see what that looked like when encrypted</p>
<p>Note that this retains the directory structure which means you can do this</p>
<pre><code>$ rclone -q ls secret:subdir
8 file2.txt
9 file3.txt
10 subsubdir/file4.txt</code></pre>
<p>If don't use file name encryption then the remote will look like this - note the <code>.bin</code> extensions added to prevent the cloud provider attempting to interpret the data.</p>
<pre><code>$ rclone -q ls remote:path
54 file0.txt.bin
57 subdir/file3.txt.bin
56 subdir/file2.txt.bin
58 subdir/subsubdir/file4.txt.bin
55 file1.txt.bin</code></pre>
<h3id="file-name-encryption-modes">File name encryption modes</h3>
<p>Here are some of the features of the file name encryption modes</p>
<p>Off</p>
<ul>
<li>doesn't hide file names or directory structure</li>
<li>allows for longer file names (~246 characters)</li>
<li>identical files names will have identical uploaded names</li>
<li>can use shortcuts to shorten the directory recursion</li>
</ul>
<p>Obfuscation</p>
<p>This is a simple "rotate" of the filename, with each file having a rot distance based on the filename. We store the distance at the beginning of the filename. So a file called "hello" may become "53.jgnnq"</p>
<p>This is not a strong encryption of filenames, but it may stop automated scanning tools from picking up on filename patterns. As such it's an intermediate between "off" and "standard". The advantage is that it allows for longer path segment names.</p>
<p>There is a possibility with some unicode based filenames that the obfuscation is weak and may map lower case characters to upper case equivalents. You can not rely on this for strong protection.</p>
<ul>
<li>file names very lightly obfuscated</li>
<li>file names can be longer than standard encryption</li>
<li>identical files names will have identical uploaded names</li>
</ul>
<p>Cloud storage systems have various limits on file name length and total path length which you are more likely to hit using "Standard" file name encryption. If you keep your file names to below 156 characters in length then you should be OK on all providers.</p>
<p>There may be an even more secure file name encryption mode in the future which will address the long file name problem.</p>
<h3id="directory-name-encryption">Directory name encryption</h3>
<p>Crypt offers the option of encrypting dir names or leaving them intact. There are two options:</p>
<p>True</p>
<p>Encrypts the whole file path including directory names Example: <code>1/12/123.txt</code> is encrypted to <code>p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0</code></p>
<h3id="modified-time-and-hashes-1">Modified time and hashes</h3>
<p>Crypt stores modification times using the underlying remote so support depends on that.</p>
<p>Hashes are not stored for crypt. However the data integrity is protected by an extremely strong crypto authenticator.</p>
<p>Note that you should use the <code>rclone cryptcheck</code> command to check the integrity of a crypted remote instead of <code>rclone check</code> which can't check the checksums properly.</p>
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/crypt/crypt.go then run make backenddocs -->
<h3id="standard-options-6">Standard Options</h3>
<p>Here are the standard options specific to crypt (Encrypt/Decrypt a remote).</p>
<h4id="crypt-remote">--crypt-remote</h4>
<p>Remote to encrypt/decrypt. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended).</p>
<p>If this flag is set then for each file that the remote is asked to list, it will log (at level INFO) a line stating the decrypted file name and the encrypted file name.</p>
<p>This is so you can work out which encrypted names are which decrypted names just in case you need to do something with the encrypted file names, or for debugging purposes.</p>
<h2id="backing-up-a-crypted-remote">Backing up a crypted remote</h2>
<p>If you wish to backup a crypted remote, it it recommended that you use <code>rclone sync</code> on the encrypted files, and make sure the passwords are the same in the new encrypted remote.</p>
<p>This will have the following advantages</p>
<ul>
<li><code>rclone sync</code> will check the checksums while copying</li>
<li>you can use <code>rclone check</code> between the encrypted remotes</li>
<p>For example, let's say you have your original remote at <code>remote:</code> with the encrypted version at <code>eremote:</code> with path <code>remote:crypt</code>. You would then set up the new remote <code>remote2:</code> and then the encrypted version <code>eremote2:</code> with path <code>remote2:crypt</code> using the same passwords as <code>eremote:</code>.</p>
<p>The initial nonce is generated from the operating systems crypto strong random number generator. The nonce is incremented for each chunk read making sure each nonce is unique for each block written. The chance of a nonce being re-used is minuscule. If you wrote an exabyte of data (10¹⁸ bytes) you would have a probability of approximately 2×10⁻³² of re-using a nonce.</p>
<p>Each chunk will contain 64kB of data, except for the last one which may have less data. The data chunk is in standard NACL secretbox format. Secretbox uses XSalsa20 and Poly1305 to encrypt and authenticate messages.</p>
<p>Each chunk contains:</p>
<ul>
<li>16 Bytes of Poly1305 authenticator</li>
<li>1 - 65536 bytes XSalsa20 encrypted data</li>
</ul>
<p>64k chunk size was chosen as the best performing chunk size (the authenticator takes too much time below this and the performance drops off due to cache effects above this). Note that these chunks are buffered in memory so they can't be too big.</p>
<p>This uses a 32 byte (256 bit key) key derived from the user password.</p>
<p>1049120 bytes total (a 0.05% overhead). This is the overhead for big files.</p>
<h3id="name-encryption">Name encryption</h3>
<p>File names are encrypted segment by segment - the path is broken up into <code>/</code> separated strings and these are encrypted individually.</p>
<p>File segments are padded using using PKCS#7 to a multiple of 16 bytes before encryption.</p>
<p>They are then encrypted with EME using AES with 256 bit key. EME (ECB-Mix-ECB) is a wide-block encryption mode presented in the 2003 paper "A Parallelizable Enciphering Mode" by Halevi and Rogaway.</p>
<p>This makes for deterministic encryption which is what we want - the same filename must encrypt to the same thing otherwise we can't find it on the cloud storage system.</p>
<li>filenames with the same name will encrypt the same</li>
<li>filenames which start the same won't have a common prefix</li>
</ul>
<p>This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of which are derived from the user password.</p>
<p>After encryption they are written out using a modified version of standard <code>base32</code> encoding as described in RFC4648. The standard encoding is modified in two ways:</p>
<ul>
<li>it becomes lower case (no-one likes upper case filenames!)</li>
<li>we strip the padding character <code>=</code></li>
</ul>
<p><code>base32</code> is used rather than the more efficient <code>base64</code> so rclone can be used on case insensitive remotes (eg Windows, Amazon Drive).</p>
<p>Rclone uses <code>scrypt</code> with parameters <code>N=16384, r=8, p=1</code> with an optional user supplied salt (password2) to derive the 32+32+16 = 80 bytes of key material required. If the user doesn't supply a salt then rclone uses an internal one.</p>
<p><code>scrypt</code> makes it impractical to mount a dictionary attack on rclone encrypted data. For full protection against this you should always use a salt.</p>
<p>Paths are specified as <code>remote:path</code></p>
<p>Dropbox paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p>
<p>The initial setup for dropbox involves getting a token from Dropbox which you need to do in your browser. <code>rclone config</code> walks you through it.</p>
<p>Here is an example of how to make a remote called <code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<h3id="dropbox-for-business">Dropbox for business</h3>
<p>Rclone supports Dropbox for business and Team Folders.</p>
<p>When using Dropbox for business <code>remote:</code> and <code>remote:path/to/file</code> will refer to your personal folder.</p>
<p>If you wish to see Team Folders you must use a leading <code>/</code> in the path, so <code>rclone lsd remote:/</code> will refer to the root and show you all Team Folders and your User Folder.</p>
<p>You can then use team folders like this <code>remote:/TeamFolder</code> and <code>remote:/TeamFolder/path/to/file</code>.</p>
<p>A leading <code>/</code> for a Dropbox personal account will do nothing, but it will take an extra HTTP transaction so it should be avoided.</p>
<p>Dropbox supports modified times, but the only way to set a modification time is to re-upload the file.</p>
<p>This means that if you uploaded your data with an older version of rclone which didn't support the v2 API and modified times, rclone will decide to upload all your old data to fix the modification times. If you don't want this to happen use <code>--size-only</code> or <code>--checksum</code> flag to stop it.</p>
<p>Dropbox supports <ahref="https://www.dropbox.com/developers/reference/content-hash">its own hash type</a> which is checked for all transfers.</p>
<p>Note that chunks are buffered in memory (one at a time) so rclone can deal with retries. Setting this larger will increase the speed slightly (at most 10% for 128MB in tests) at the cost of using more memory. It can be set smaller if you are tight on memory.</p>
<p>There are some file names such as <code>thumbs.db</code> which Dropbox can't store. There is a full list of them in the <ahref="https://www.dropbox.com/en/help/145">"Ignored Files" section of this document</a>. Rclone will issue an error message <code>File name disallowed - not uploading</code> if it attempts to upload one of those file names, but the sync won't fail.</p>
<p>If you have more than 10,000 files in a directory then <code>rclone purge dropbox:dir</code> will return the error <code>Failed to purge: There are too many files involved in this operation</code>. As a work-around do an <code>rclone delete dropbox:dir</code> followed by an <code>rclone rmdir dropbox:dir</code>.</p>
<p>FTP is the File Transfer Protocol. FTP support is provided using the <ahref="https://godoc.org/github.com/jlaffaye/ftp">github.com/jlaffaye/ftp</a> package.</p>
<p>Here is an example of making an FTP configuration. First run</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process. An FTP remote only needs a host together with and a username and a password. With anonymous FTP server, you will need to use <code>anonymous</code> as username and your email address as the password.</p>
<pre><code>No remotes found - make a new one
n) New remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
n/r/c/s/q> n
name> remote
Type of storage to configure.
Choose a number from below, or type in your own value
1 / Amazon Drive
\ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3"
3 / Backblaze B2
\ "b2"
4 / Dropbox
\ "dropbox"
5 / Encrypt/Decrypt a remote
\ "crypt"
6 / FTP Connection
\ "ftp"
7 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage"
8 / Google Drive
\ "drive"
9 / Hubic
\ "hubic"
10 / Local Disk
\ "local"
11 / Microsoft OneDrive
\ "onedrive"
12 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift"
13 / SSH/SFTP Connection
\ "sftp"
14 / Yandex Disk
\ "yandex"
Storage> ftp
FTP host to connect to
Choose a number from below, or type in your own value
1 / Connect to ftp.example.com
\ "ftp.example.com"
host> ftp.example.com
FTP username, leave blank for current username, ncw
user>
FTP port, leave blank to use default (21)
port>
FTP password
y) Yes type in my own password
g) Generate random password
y/g> y
Enter the password:
password:
Confirm the password:
password:
Remote config
--------------------
[remote]
host = ftp.example.com
user =
port =
pass = *** ENCRYPTED ***
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d> y</code></pre>
<p>This remote is called <code>remote</code> and can now be used like this</p>
<p>Note that since FTP isn't HTTP based the following flags don't work with it: <code>--dump-headers</code>, <code>--dump-bodies</code>, <code>--dump-auth</code></p>
<p>Note that <code>--timeout</code> isn't supported (but <code>--contimeout</code> is).</p>
<p>Note that <code>--bind</code> isn't supported.</p>
<p>FTP could support server side move but doesn't yet.</p>
<p>Paths are specified as <code>remote:bucket</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, eg <code>remote:bucket/path/to/dir</code>.</p>
<p>The initial setup for google cloud storage involves getting a token from Google Cloud Storage which you need to do in your browser. <code>rclone config</code> walks you through it.</p>
<p>Here is an example of how to make a remote called <code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<p>Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall, or use manual mode.</p>
<p>This remote is called <code>remote</code> and can now be used like this</p>
<p>You can set up rclone with Google Cloud Storage in an unattended mode, i.e. not tied to a specific end-user Google account. This is useful when you want to synchronise files onto machines that don't have actively logged-in users, for example build machines.</p>
<p>To get credentials for Google Cloud Platform <ahref="https://cloud.google.com/iam/docs/service-accounts">IAM Service Accounts</a>, please head to the <ahref="https://console.cloud.google.com/permissions/serviceaccounts">Service Account</a> section of the Google Developer Console. Service Accounts behave just like normal <code>User</code> permissions in <ahref="https://cloud.google.com/storage/docs/access-control">Google Cloud Storage ACLs</a>, so you can limit their access (e.g. make them read only). After creating an account, a JSON file containing the Service Account's credentials will be downloaded onto your machines. These credentials are what rclone will use for authentication.</p>
<p>To use a Service Account instead of OAuth2 token flow, enter the path to your Service Account credentials at the <code>service_account_file</code> prompt and rclone won't use the browser based authentication flow. If you'd rather stuff the contents of the credentials file into the rclone config file, you can set <code>service_account_credentials</code> with the actual contents of the file instead, or set the equivalent environment variable.</p>
<p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <ahref="/docs/#fast-list">rclone docs</a> for more details.</p>
<p>Google google cloud storage stores md5sums natively and rclone stores modification times as metadata on the object, under the "mtime" key in RFC3339 format accurate to 1ns.</p>
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/googlecloudstorage/googlecloudstorage.go then run make backenddocs -->
<h3id="standard-options-9">Standard Options</h3>
<p>Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).</p>
<h4id="gcs-client-id">--gcs-client-id</h4>
<p>Google Application Client Id Leave blank normally.</p>
<p>Paths are specified as <code>drive:path</code></p>
<p>Drive paths may be as deep as required, eg <code>drive:directory/subdirectory</code>.</p>
<p>The initial setup for drive involves getting a token from Google drive which you need to do in your browser. <code>rclone config</code> walks you through it.</p>
<p>Here is an example of how to make a remote called <code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found - make a new one
n) New remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
n/r/c/s/q> n
name> remote
Type of storage to configure.
Choose a number from below, or type in your own value
<p>Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall, or use manual mode.</p>
<p>You can then use it like this,</p>
<p>List directories in top level of your drive</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your drive</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to a drive directory called backup</p>
<p>Rclone allows you to select which scope you would like for rclone to use. This changes what type of token is granted to rclone. <ahref="https://developers.google.com/drive/v3/web/about-auth">The scopes are defined here.</a>.</p>
<p>The scope are</p>
<h4id="drive">drive</h4>
<p>This is the default scope and allows full access to all files, except for the Application Data Folder (see below).</p>
<p>Choose this one if you aren't sure.</p>
<h4id="drive.readonly">drive.readonly</h4>
<p>This allows read only access to all files. Files may be listed and downloaded but not uploaded, renamed or deleted.</p>
<h4id="drive.file">drive.file</h4>
<p>With this scope rclone can read/view/modify only those files and folders it creates.</p>
<p>So if you uploaded files to drive via the web interface (or any other means) they will not be visible to rclone.</p>
<p>This can be useful if you are using rclone to backup data and you want to be sure confidential data on your drive is not visible to rclone.</p>
<p>Files created with this scope are visible in the web interface.</p>
<h4id="drive.appfolder">drive.appfolder</h4>
<p>This gives rclone its own private area to store files. Rclone will not be able to see any other files on your drive and you won't be able to see rclone's files from the web interface either.</p>
<p>This allows read only access to file names only. It does not allow rclone to download or upload data, or rename or delete files or directories.</p>
<h3id="root-folder-id">Root folder ID</h3>
<p>You can set the <code>root_folder_id</code> for rclone. This is the directory (identified by its <code>Folder ID</code>) that rclone considers to be a the root of your drive.</p>
<p>Normally you will leave this blank and rclone will determine the correct root to use itself.</p>
<p>However you can set this to restrict rclone to a specific folder hierarchy or to access data within the "Computers" tab on the drive web interface (where files from Google's Backup and Sync desktop program go).</p>
<p>In order to do this you will have to find the <code>Folder ID</code> of the directory you wish rclone to display. This will be the last segment of the URL when you open the relevant folder in the drive web interface.</p>
<p>So if the folder you want rclone to use has a URL which looks like <code>https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh</code> in the browser, then you use <code>1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh</code> as the <code>root_folder_id</code> in the config.</p>
<p><strong>NB</strong> folders under the "Computers" tab seem to be read only (drive gives a 500 error) when using rclone.</p>
<p>There doesn't appear to be an API to discover the folder IDs of the "Computers" tab - please contact us if you know otherwise!</p>
<p>Note also that rclone can't access any data under the "Backups" tab on the google drive web interface yet.</p>
<p>You can set up rclone with Google Drive in an unattended mode, i.e. not tied to a specific end-user Google account. This is useful when you want to synchronise files onto machines that don't have actively logged-in users, for example build machines.</p>
<p>To use a Service Account instead of OAuth2 token flow, enter the path to your Service Account credentials at the <code>service_account_file</code> prompt during <code>rclone config</code> and rclone won't use the browser based authentication flow. If you'd rather stuff the contents of the credentials file into the rclone config file, you can set <code>service_account_credentials</code> with the actual contents of the file instead, or set the equivalent environment variable.</p>
<h4id="use-case---google-appsg-suite-account-and-individual-drive">Use case - Google Apps/G-suite account and individual Drive</h4>
<p>Let's say that you are the administrator of a Google Apps (old) or G-suite account. The goal is to store data on an individual's Drive account, who IS a member of the domain. We'll call the domain <strong>example.com</strong>, and the user <strong>foo@example.com</strong>.</p>
<p>There's a few steps we need to go through to accomplish this:</p>
<h5id="create-a-service-account-for-example.com">1. Create a service account for example.com</h5>
<ul>
<li>To create a service account and obtain its credentials, go to the <ahref="https://console.developers.google.com">Google Developer Console</a>.</li>
<li>You must have a project - create one if you don't.</li>
<li>Then go to "IAM & admin" ->"Service Accounts".</li>
<li>Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. "Role" can be empty.</li>
<li>Tick "Furnish a new private key" - select "Key type JSON".</li>
<li>Tick "Enable G Suite Domain-wide Delegation". This option makes "impersonation" possible, as documented here: <ahref="https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority">Delegating domain-wide authority to the service account</a></li>
<li>These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.</li>
</ul>
<h5id="allowing-api-access-to-example.com-google-drive">2. Allowing API access to example.com Google Drive</h5>
<ul>
<li>Go to example.com's admin console</li>
<li>Go into "Security" (or use the search bar)</li>
<li>Select "Show more" and then "Advanced settings"</li>
<li>Select "Manage API client access" in the "Authentication" section</li>
<li>In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" ->"Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.</li>
<li>In the next field, "One or More API Scopes", enter <code>https://www.googleapis.com/auth/drive</code> to grant access to Google Drive specifically.</li>
</ul>
<h5id="configure-rclone-assuming-a-new-install">3. Configure rclone, assuming a new install</h5>
<pre><code>rclone config
n/s/q> n # New
name>gdrive # Gdrive is an example name
Storage> # Select the number shown for Google Drive
client_id> # Can be left blank
client_secret> # Can be left blank
scope> # Select your scope, 1 for example
root_folder_id> # Can be left blank
service_account_file> /home/foo/myJSONfile.json # This is where the JSON file goes!
y/n> # Auto config, y
</code></pre>
<h5id="verify-that-its-working">4. Verify that it's working</h5>
<p>If you want to configure the remote to point to a Google Team Drive then answer <code>y</code> to the question <code>Configure this as a team drive?</code>.</p>
<p>This will fetch the list of Team Drives from google and allow you to configure which one you want to use. You can also type in a team drive ID if you prefer.</p>
<p>For example:</p>
<pre><code>Configure this as a team drive?
y) Yes
n) No
y/n> y
Fetching team drive list...
Choose a number from below, or type in your own value
<p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <ahref="/docs/#fast-list">rclone docs</a> for more details.</p>
<p>It does this by combining multiple <code>list</code> calls into a single API request.</p>
<p>This works by combining many <code>'%s' in parents</code> filters into one expression. To list the contents of directories a, b and c, the the following requests will be send by the regular <code>List</code> function:</p>
<pre><code>trashed=false and 'a' in parents
trashed=false and 'b' in parents
trashed=false and 'c' in parents</code></pre>
<p>These can now be combined into a single request:</p>
<pre><code>trashed=false and ('a' in parents or 'b' in parents or 'c' in parents)</code></pre>
<p>The implementation of <code>ListR</code> will put up to 50 <code>parents</code> filters into one request. It will use the <code>--checkers</code> value to specify the number of requests to run in parallel.</p>
<p>In tests, these batch requests were up to 20x faster than the regular method. Running the following command against different sized folders gives:</p>
<p>Google drive stores modification times accurate to 1 ms.</p>
<h3id="revisions">Revisions</h3>
<p>Google drive stores revisions of files. When you upload a change to an existing file to google drive using rclone it will create a new revision of that file.</p>
<p>Revisions follow the standard google policy which at time of writing was</p>
<ul>
<li>They are deleted after 30 days or 100 revisions (whatever comes first).</li>
<li>They do not count towards a user storage quota.</li>
</ul>
<h3id="deleting-files-2">Deleting files</h3>
<p>By default rclone will send all files to the trash when deleting files. If deleting them permanently is required then use the <code>--drive-use-trash=false</code> flag, or set the equivalent environment variable.</p>
<h3id="emptying-trash">Emptying trash</h3>
<p>If you wish to empty your trash you can use the <code>rclone cleanup remote:</code> command which will permanently delete all your trashed files. This command does not take any path arguments.</p>
<p>To view your current quota you can use the <code>rclone about remote:</code> command which will display your usage limit (quota), the usage in Google Drive, the size of all files in the Trash and the space used by other Google services such as Gmail. This command does not take any path arguments.</p>
<h4id="importexport-of-google-documents">Import/Export of google documents</h4>
<p>Google documents can be exported from and uploaded to Google Drive.</p>
<p>When rclone downloads a Google doc it chooses a format to download depending upon the <code>--drive-export-formats</code> setting. By default the export formats are <code>docx,xlsx,pptx,svg</code> which are a sensible default for an editable document.</p>
<p>When choosing a format, rclone runs down the list provided in order and chooses the first file format the doc can be exported as from the list. If the file can't be exported to a format on the formats list, then rclone will choose a format from the default list.</p>
<p>If you prefer an archive copy then you might use <code>--drive-export-formats pdf</code>, or if you prefer openoffice/libreoffice formats you might use <code>--drive-export-formats ods,odt,odp</code>.</p>
<p>Note that rclone adds the extension to the google doc, so if it is calles <code>My Spreadsheet</code> on google docs, it will be exported as <code>My Spreadsheet.xlsx</code> or <code>My Spreadsheet.pdf</code> etc.</p>
<p>When importing files into Google Drive, rclone will conververt all files with an extension in <code>--drive-import-formats</code> to their associated document type. rclone will not convert any files by default, since the conversion is lossy process.</p>
<p>The conversion must result in a file with the same extension when the <code>--drive-export-formats</code> rules are applied to the uploded document.</p>
<p>Here are some examples for allowed and prohibited conversions.</p>
<table>
<thead>
<trclass="header">
<th>export-formats</th>
<th>import-formats</th>
<th>Upload Ext</th>
<th>Document Ext</th>
<th>Allowed</th>
</tr>
</thead>
<tbody>
<trclass="odd">
<td>odt</td>
<td>odt</td>
<td>odt</td>
<td>odt</td>
<td>Yes</td>
</tr>
<trclass="even">
<td>odt</td>
<td>docx,odt</td>
<td>odt</td>
<td>odt</td>
<td>Yes</td>
</tr>
<trclass="odd">
<td></td>
<td>docx</td>
<td>docx</td>
<td>docx</td>
<td>Yes</td>
</tr>
<trclass="even">
<td></td>
<td>odt</td>
<td>odt</td>
<td>docx</td>
<td>No</td>
</tr>
<trclass="odd">
<td>odt,docx</td>
<td>docx,odt</td>
<td>docx</td>
<td>odt</td>
<td>No</td>
</tr>
<trclass="even">
<td>docx,odt</td>
<td>docx,odt</td>
<td>docx</td>
<td>docx</td>
<td>Yes</td>
</tr>
<trclass="odd">
<td>docx,odt</td>
<td>docx,odt</td>
<td>odt</td>
<td>docx</td>
<td>No</td>
</tr>
</tbody>
</table>
<p>This limitation can be disabled by specifying <code>--drive-allow-import-name-change</code>. When using this flag, rclone can convert multiple files types resulting in the same document type at once, eg with <code>--drive-import-formats docx,odt,txt</code>, all files having these extension would result in a doument represented as a docx file. This brings the additional risk of overwriting a document, if multiple files have the same stem. Many rclone operations will not handle this name change in any way. They assume an equal name when copying files and might copy the file again or delete them when the name changes.</p>
<p>Here are the possible export extensions with their corresponding mime types. Most of these can also be used for importing, but there more that are not listed here. Some of these additional ones might only be available when the operating system provides the correct MIME type entries.</p>
<p>This list can be changed by Google Drive at any time and might not represent the currently available converions.</p>
<p>Google douments can also be exported as link files. These files will open a browser window for the Google Docs website of that dument when opened. The link file extension has to be specified as a <code>--drive-export-formats</code> parameter. They will match all available Google Documents.</p>
<table>
<thead>
<trclass="header">
<th>Extension</th>
<th>Description</th>
<th>OS Support</th>
</tr>
</thead>
<tbody>
<trclass="odd">
<td>desktop</td>
<td>freedesktop.org specified desktop entry</td>
<td>Linux</td>
</tr>
<trclass="even">
<td>link.html</td>
<td>An HTML Document with a redirect</td>
<td>All</td>
</tr>
<trclass="odd">
<td>url</td>
<td>INI style link file</td>
<td>macOS, Windows</td>
</tr>
<trclass="even">
<td>webloc</td>
<td>macOS specific XML format</td>
<td>macOS</td>
</tr>
</tbody>
</table>
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/drive/drive.go then run make backenddocs -->
<h3id="standard-options-10">Standard Options</h3>
<p>Here are the standard options specific to drive (Google Drive).</p>
<h4id="drive-client-id">--drive-client-id</h4>
<p>Google Application Client Id Leave blank normally.</p>
<p>Only consider files owned by the authenticated user.</p>
<ul>
<li>Config: auth_owner_only</li>
<li>Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4id="drive-use-trash">--drive-use-trash</h4>
<p>Send files to the trash instead of deleting permanently. Defaults to true, namely sending files to the trash. Use <code>--drive-use-trash=false</code> to delete files permanently instead.</p>
<ul>
<li>Config: use_trash</li>
<li>Env Var: RCLONE_DRIVE_USE_TRASH</li>
<li>Type: bool</li>
<li>Default: true</li>
</ul>
<h4id="drive-skip-gdocs">--drive-skip-gdocs</h4>
<p>Skip google documents in all listings. If given, gdocs practically become invisible to rclone.</p>
<p>Instructs rclone to operate on your "Shared with me" folder (where Google Drive lets you access the files and folders others have shared with you).</p>
<p>This works both with the "list" (lsd, lsl, etc) and the "copy" commands (copy, sync, etc), and with all other commands too.</p>
<p>When uploading to your drive all files will be overwritten unless they haven't been modified since their creation. And the inverse will occur while downloading. This side effect can be avoided by using the "--checksum" flag.</p>
<p>This feature was implemented to retain photos capture date as recorded by google photos. You will first need to check the "Create a Google Photos folder" option in your google drive settings. You can then copy or move the photos locally and use the date the image was taken (created) set as the modification date.</p>
<p>Use alternate export URLs for google documents export.,</p>
<p>If this option is set this instructs rclone to use an alternate set of export URLs for drive documents. Users have reported that the official export URLs can't export large documents, whereas these unofficial ones can.</p>
<p>See rclone issue <ahref="https://github.com/ncw/rclone/issues/2243">#2243</a> for background, <ahref="https://issuetracker.google.com/issues/36761333">this google drive issue</a> and <ahref="https://www.labnol.org/internet/direct-links-for-google-drive/28356/">this helpful post</a>.</p>
<p>Set to allow files which return cannotDownloadAbusiveFile to be downloaded.</p>
<p>If downloading a file returns the error "This file has been identified as malware or spam and cannot be downloaded" with the error code "cannotDownloadAbusiveFile" then supply this flag to rclone to indicate you acknowledge the risks of downloading the file and rclone will download it anyway.</p>
<p>Drive has quite a lot of rate limiting. This causes rclone to be limited to transferring about 2 files per second only. Individual files may be transferred much faster at 100s of MBytes/s but lots of small files can take a long time.</p>
<p>Server side copies are also subject to a separate rate limit. If you see User rate limit exceeded errors, wait at least 24 hours and retry. You can disable server side copies with <code>--disable copy</code> to download and upload the files if you prefer.</p>
<h4id="limitations-of-google-docs">Limitations of Google Docs</h4>
<p>Google docs will appear as size -1 in <code>rclone ls</code> and as size 0 in anything which uses the VFS layer, eg <code>rclone mount</code>, <code>rclone serve</code>.</p>
<p>This is because rclone can't find out the size of the Google docs without downloading them.</p>
<p>Google docs will transfer correctly with <code>rclone sync</code>, <code>rclone copy</code> etc as rclone knows to ignore the size when doing the transfer.</p>
<p>However an unfortunate consequence of this is that you can't download Google docs using <code>rclone mount</code> - you will get a 0 sized file. If you try again the doc may gain its correct size and be downloadable.</p>
<p>Sometimes, for no reason I've been able to track down, drive will duplicate a file that rclone uploads. Drive unlike all the other remotes can have duplicated files.</p>
<p>Duplicated files cause problems with the syncing and you will see messages in the log about duplicates.</p>
<p>Use <code>rclone dedupe</code> to fix duplicated files.</p>
<p>Note that this isn't just a problem with rclone, even Google Photos on Android duplicates files on drive sometimes.</p>
<h3id="rclone-appears-to-be-re-copying-files-it-shouldnt">Rclone appears to be re-copying files it shouldn't</h3>
<p>The most likely cause of this is the duplicated file issue above - run <code>rclone dedupe</code> and check your logs for duplicate object or directory messages.</p>
<h3id="making-your-own-client_id">Making your own client_id</h3>
<p>When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. rclone already has a high quota and I will continue to make sure it is high enough by contacting Google.</p>
<p>It is strongly recommended to use your own client ID as the default rclone ID is heavily used. If you have multiple services running, it is recommended to use an API key for each service. The default Google quota is 10 transactions per second so it is recommended to stay under that number as if you use more than that, it will cause rclone to rate limit and make things slower.</p>
<p>Here is how to create your own Google Drive client ID for rclone:</p>
<olstyle="list-style-type: decimal">
<li><p>Log into the <ahref="https://console.developers.google.com/">Google API Console</a> with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)</p></li>
<li><p>Select a project or create a new project.</p></li>
<li><p>Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the then "Google Drive API".</p></li>
<li><p>Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials", then "OAuth client ID". It will prompt you to set the OAuth consent screen product name, if you haven't set one already.</p></li>
<li><p>Choose an application type of "other", and click "Create". (the default name is fine)</p></li>
<li><p>It will show you a client ID and client secret. Use these values in rclone config to add a new remote or edit an existing remote.</p></li>
</ol>
<p>(Thanks to <spanclass="citation">@balazer</span> on github for these instructions.)</p>
<h2id="http">HTTP</h2>
<p>The HTTP remote is a read only remote for reading files of a webserver. The webserver should provide file listings which rclone will read and turn into a remote. This has been tested with common webservers such as Apache/Nginx/Caddy and will likely work with file listings from most web servers. (If it doesn't then please file an issue, or send a pull request!)</p>
<p>Paths are specified as <code>remote:</code> or <code>remote:path/to/dir</code>.</p>
<p>Paths are specified as <code>remote:container</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, eg <code>remote:container/path/to/dir</code>.</p>
<p>The initial setup for Hubic involves getting a token from Hubic which you need to do in your browser. <code>rclone config</code> walks you through it.</p>
<p>Note that rclone runs a webserver on your local machine to collect the token as returned from Hubic. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p>
<p>If you want the directory to be visible in the official <em>Hubic browser</em>, you need to copy your files to the <code>default</code> directory</p>
<p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <ahref="/docs/#fast-list">rclone docs</a> for more details.</p>
<h3id="modified-time-6">Modified time</h3>
<p>The modified time is stored as metadata on the object as <code>X-Object-Meta-Mtime</code> as floating point since the epoch accurate to 1 ns.</p>
<p>This is a defacto standard (used in the official python-swiftclient amongst others) for storing the modification time for an object.</p>
<p>Note that Hubic wraps the Swift backend, so most of the properties of are the same.</p>
<p>This uses the normal OpenStack Swift mechanism to refresh the Swift API credentials and ignores the expires field returned by the Hubic API.</p>
<p>The Swift API doesn't return a correct MD5SUM for segmented files (Dynamic or Static Large Objects) so rclone won't check or use the MD5SUM for these.</p>
<p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <ahref="/docs/#fast-list">rclone docs</a> for more details.</p>
<p>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.</p>
<p>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.</p>
<p>Jottacloud supports MD5 type hashes, so you can use the <code>--checksum</code> flag.</p>
<p>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 <code>TMPDIR</code> environment variable points to) before it is uploaded. Small files will be cached in memory - see the <code>--jottacloud-md5-memory-limit</code> flag.</p>
<p>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 <code>--jottacloud-hard-delete</code> flag, or set the equivalent environment variable.</p>
<p>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.</p>
<p>To view your current quota you can use the <code>rclone about remote:</code> command which will display your usage limit (unless it is unlimited) and the current usage.</p>
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/jottacloud/jottacloud.go then run make backenddocs -->
<h3id="standard-options-13">Standard Options</h3>
<p>Here are the standard options specific to jottacloud (JottaCloud).</p>
<p>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.</p>
<p>Note that Jottacloud is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".</p>
<p>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.</p>
<p>Jottacloud only supports filenames up to 255 characters in length.</p>
<h3id="troubleshooting">Troubleshooting</h3>
<p>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.</p>
<h2id="mega">Mega</h2>
<p><ahref="https://mega.nz/">Mega</a> is a cloud storage and file hosting service known for its security feature where all files are encrypted locally before they are uploaded. This prevents anyone (including employees of Mega) from accessing the files without knowledge of the key used for encryption.</p>
<p>This is an rclone backend for Mega which supports the file transfer features of Mega using the same client side encryption.</p>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p>
<p>Here is an example of how to make a remote called <code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>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.
Choose a number from below, or type in your own value
<p><strong>NOTE:</strong> The encryption keys need to have been already generated after a regular login via the browser, otherwise attempting to use the credentials in <code>rclone</code> will fail.</p>
<p>Delete files permanently rather than putting them into the trash.</p>
<p>Normally the mega backend will put all deletions into the trash rather than permanently deleting them. If you specify this then rclone will permanently delete objects instead.</p>
<p>This backend uses the <ahref="https://github.com/t3rm1n4l/go-mega">go-mega go library</a> which is an opensource go library implementing the Mega API. There doesn't appear to be any documentation for the mega protocol beyond the <ahref="https://github.com/meganz/sdk">mega C++ SDK</a> source code so there are likely quite a few errors still remaining in this library.</p>
<p>Mega allows duplicate files which may confuse rclone.</p>
<p>Paths are specified as <code>remote:container</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, eg <code>remote:container/path/to/dir</code>.</p>
<p>Here is an example of making a Microsoft Azure Blob Storage configuration. For a remote called <code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>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.
Choose a number from below, or type in your own value
1 / Amazon Drive
\ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3"
3 / Backblaze B2
\ "b2"
4 / Box
\ "box"
5 / Dropbox
\ "dropbox"
6 / Encrypt/Decrypt a remote
\ "crypt"
7 / FTP Connection
\ "ftp"
8 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage"
9 / Google Drive
\ "drive"
10 / Hubic
\ "hubic"
11 / Local Disk
\ "local"
12 / Microsoft Azure Blob Storage
\ "azureblob"
13 / Microsoft OneDrive
\ "onedrive"
14 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
<p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <ahref="/docs/#fast-list">rclone docs</a> for more details.</p>
<h3id="modified-time-7">Modified time</h3>
<p>The modified time is stored as metadata on the object with the <code>mtime</code> key. It is stored using RFC3339 Format time with nanosecond precision. The metadata is supplied during directory listings so there is no overhead to using it.</p>
<h3id="hashes">Hashes</h3>
<p>MD5 hashes are stored with blobs. However blobs that were uploaded in chunks only have an MD5 if the source remote was capable of MD5 hashes, eg the local disk.</p>
<h3id="authenticating-with-azure-blob-storage">Authenticating with Azure Blob Storage</h3>
<p>Rclone has 3 ways of authenticating with Azure Blob Storage:</p>
<h4id="account-and-key">Account and Key</h4>
<p>This is the most straight forward and least flexible way. Just fill in the <code>account</code> and <code>key</code> lines and leave the rest blank.</p>
<h4id="sas-url">SAS URL</h4>
<p>This can be an account level SAS URL or container level SAS URL</p>
<p>To use it leave <code>account</code>, <code>key</code> blank and fill in <code>sas_url</code>.</p>
<p>Account level SAS URL or container level SAS URL can be obtained from Azure portal or Azure Storage Explorer. To get a container level SAS URL right click on a container in the Azure Blob explorer in the Azure portal.</p>
<p>If You use container level SAS URL, rclone operations are permitted only on particular container, eg</p>
<pre><code>rclone ls azureblob:container or rclone ls azureblob:</code></pre>
<p>Since container name already exists in SAS URL, you can leave it empty as well.</p>
<p>However these will not work</p>
<pre><code>rclone lsd azureblob:
rclone ls azureblob:othercontainer</code></pre>
<p>This would be useful for temporarily allowing third parties access to a single container or putting credentials into an untrusted environment.</p>
<p>Rclone supports multipart uploads with Azure Blob storage. Files bigger than 256MB will be uploaded using chunked upload by default.</p>
<p>The files will be uploaded in parallel in 4MB chunks (by default). Note that these chunks are buffered in memory and there may be up to <code>--transfers</code> of them being uploaded at once.</p>
<p>Files can't be split into more than 50,000 chunks so by default, so the largest file that can be uploaded with 4MB chunk size is 195GB. Above this rclone will double the chunk size until it creates less than 50,000 chunks. By default this will mean a maximum file size of 3.2TB can be uploaded. This can be raised to 5TB using <code>--azureblob-chunk-size 100M</code>.</p>
<p>Note that rclone doesn't commit the block list until the end of the upload which means that there is a limit of 9.5TB of multipart uploads in progress as Azure won't allow more than that amount of uncommitted blocks.</p>
<p>This sets the number of blobs requested in each listing chunk. Default is the maximum, 5000. "List blobs" requests are permitted 2 minutes per megabyte to complete. If an operation is taking longer than 2 minutes per megabyte on average, it will time out ( <ahref="https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations#exceptions-to-default-timeout-interval">source</a> ). This can be used to limit the number of blobs items to return, to avoid the time out.</p>
<p>Archived blobs can be restored by setting access tier to hot or cool. Leave blank if you intend to use default access tier, which is set at account level</p>
<p>If there is no "access tier" specified, rclone doesn't apply any tier. rclone performs "Set Tier" operation on blobs while uploading, if objects are not modified, specifying "access tier" to new one will have no effect. If blobs are in "archive tier" at remote, trying to perform data transfer operations from remote will not be allowed. User should first restore by tiering blob to "Hot" or "Cool".</p>
<p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p>
<p>The initial setup for OneDrive involves getting a token from Microsoft which you need to do in your browser. <code>rclone config</code> walks you through it.</p>
<p>Note that rclone runs a webserver on your local machine to collect the token as returned from Microsoft. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p>
<h3id="getting-your-own-client-id-and-key">Getting your own Client ID and Key</h3>
<p>rclone uses a pair of Client ID and Key shared by all rclone users when performing requests by default. If you are having problems with them (E.g., seeing a lot of throttling), you can get your own Client ID and Key by following the steps below:</p>
<olstyle="list-style-type: decimal">
<li>Open https://apps.dev.microsoft.com/#/appList, then click <code>Add an app</code> (Choose <code>Converged applications</code> if applicable)</li>
<li>Enter a name for your app, and click continue. Copy and keep the <code>Application Id</code> under the app name for later use.</li>
<li>Under section <code>Application Secrets</code>, click <code>Generate New Password</code>. Copy and keep that password for later use.</li>
<li>Under section <code>Platforms</code>, click <code>Add platform</code>, then <code>Web</code>. Enter <code>http://localhost:53682/</code> in <code>Redirect URLs</code>.</li>
<li>Scroll to the bottom and click <code>Save</code>.</li>
</ol>
<p>Now the application is complete. Run <code>rclone config</code> to create or edit a OneDrive remote. Supply the app ID and password as Client ID and Secret, respectively. rclone will walk you through the remaining steps.</p>
<p>OneDrive personal supports SHA1 type hashes. OneDrive for business and Sharepoint Server support <ahref="https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash">QuickXorHash</a>.</p>
<p>For all types of OneDrive you can use the <code>--checksum</code> flag.</p>
<p>Any files you delete with rclone will end up in the trash. Microsoft doesn't provide an API to permanently delete files, nor to empty the trash, so you will have to do that with one of Microsoft's apps or via the OneDrive website.</p>
<p>Set to make OneNote files show up in directory listings.</p>
<p>By default rclone will hide OneNote files in directory listings because operations like "Open" and "Update" won't work on them. But this behaviour may also prevent you from deleting them. If you want to delete OneNote files or otherwise want them to show up in directory listing, set this option.</p>
<p>Note that OneDrive is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".</p>
<p>There are quite a few characters that can't be in OneDrive file names. These can't occur on Windows platforms, but on non-Windows platforms they are common. Rclone will map these names to and from an identical looking unicode equivalent. For example if a file has a <code>?</code> in it will be mapped to <code>？</code> instead.</p>
<p>The largest allowed file sizes are 15GB for OneDrive for Business and 35GB for OneDrive Personal (Updated 4 Jan 2019).</p>
<p>The entire path, including the file name, must contain fewer than 400 characters for OneDrive, OneDrive for Business and SharePoint Online. If you are encrypting file and folder names with rclone, you may want to pay attention to this limitation because the encrypted names are typically longer than the original ones.</p>
<p>OneDrive seems to be OK with at least 50,000 files in a folder, but at 100,000 rclone will get errors listing the directory like <code>couldn’t list files: UnknownError:</code>. See <ahref="https://github.com/ncw/rclone/issues/2707">#2707</a> for more info.</p>
<p>An official document about the limitations for different types of OneDrive can be found <ahref="https://support.office.com/en-us/article/invalid-file-names-and-file-types-in-onedrive-onedrive-for-business-and-sharepoint-64883a5d-228e-48f5-b3d2-eb39e07630fa">here</a>.</p>
<p>Every change in OneDrive causes the service to create a new version. This counts against a users quota. For example changing the modification time of a file creates a second version, so the file is using twice the space.</p>
<p>The <code>copy</code> is the only rclone command affected by this as we copy the file and then afterwards set the modification time to match the source file.</p>
<p><strong>Note</strong>: Starting October 2018, users will no longer be able to disable versioning by default. This is because Microsoft has brought an <ahref="https://techcommunity.microsoft.com/t5/Microsoft-OneDrive-Blog/New-Updates-to-OneDrive-and-SharePoint-Team-Site-Versioning/ba-p/204390">update</a> to the mechanism. To change this new default setting, a PowerShell command is required to be run by a SharePoint admin. If you are an admin, you can run these commands in PowerShell to change that setting:</p>
<olstyle="list-style-type: decimal">
<li><code>Install-Module -Name Microsoft.Online.SharePoint.PowerShell</code> (in case you haven't installed this already)</li>
<li><code>Connect-SPOService -Url https://YOURSITE-admin.sharepoint.com -Credential YOU@YOURSITE.COM</code> (replacing <code>YOURSITE</code>, <code>YOU</code>, <code>YOURSITE.COM</code> with the actual values; this will prompt for your credentials)</li>
<li><code>Disconnect-SPOService</code> (to disconnect from the server)</li>
</ol>
<p><em>Below are the steps for normal users to disable versioning. If you don't see the "No Versioning" option, make sure the above requirements are met.</em></p>
<li>Under Document Version History select the option No versioning. Note: This will disable the creation of new file versions, but will not remove any previous versions. Your documents are safe.</li>
Description: Using application 'rclone' is currently not supported for your organization [YOUR_ORGANIZATION] because it is in an unmanaged state. An administrator needs to claim ownership of the company by DNS validation of [YOUR_ORGANIZATION] before the application rclone can be provisioned.</code></pre>
<p>This means that rclone can't use the OneDrive for Business API with your account. You can't do much about it, maybe write an email to your admins.</p>
<p>However, there are other ways to interact with your OneDrive account. Have a look at the webdav backend: https://rclone.org/webdav/#sharepoint</p>
<h2id="opendrive">OpenDrive</h2>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p>
<p>Here is an example of how to make a remote called <code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>n) New remote
d) Delete remote
q) Quit config
e/n/d/q> n
name> remote
Type of storage to configure.
Choose a number from below, or type in your own value
1 / Amazon Drive
\ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3"
3 / Backblaze B2
\ "b2"
4 / Dropbox
\ "dropbox"
5 / Encrypt/Decrypt a remote
\ "crypt"
6 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage"
7 / Google Drive
\ "drive"
8 / Hubic
\ "hubic"
9 / Local Disk
\ "local"
10 / OpenDrive
\ "opendrive"
11 / Microsoft OneDrive
\ "onedrive"
12 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift"
13 / SSH/SFTP Connection
\ "sftp"
14 / Yandex Disk
\ "yandex"
Storage> 10
Username
username>
Password
y) Yes type in my own password
g) Generate random password
y/g> y
Enter the password:
password:
Confirm the password:
password:
--------------------
[remote]
username =
password = *** ENCRYPTED ***
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d> y</code></pre>
<p>List directories in top level of your OpenDrive</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your OpenDrive</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an OpenDrive directory called backup</p>
<h3id="modified-time-and-md5sums-1">Modified time and MD5SUMs</h3>
<p>OpenDrive allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not.</p>
<p>Note that OpenDrive is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".</p>
<p>There are quite a few characters that can't be in OpenDrive file names. These can't occur on Windows platforms, but on non-Windows platforms they are common. Rclone will map these names to and from an identical looking unicode equivalent. For example if a file has a <code>?</code> in it will be mapped to <code>？</code> instead.</p>
<p>Paths are specified as <code>remote:bucket</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, eg <code>remote:bucket/path/to/dir</code>.</p>
<p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <ahref="/docs/#fast-list">rclone docs</a> for more details.</p>
<p>rclone supports multipart uploads with QingStor which means that it can upload files bigger than 5GB. Note that files uploaded with multipart upload don't have an MD5SUM.</p>
<h3id="buckets-and-zone">Buckets and Zone</h3>
<p>With QingStor you can list buckets (<code>rclone lsd</code>) using any zone, but you can only access the content of a bucket from the zone it was created in. If you attempt to access a bucket from the wrong zone, you will get an error, <code>incorrect zone, the bucket is not in 'XXX' zone</code>.</p>
<p>This is the number of chunks of the same file that are uploaded concurrently.</p>
<p>NB if you set this to > 1 then the checksums of multpart uploads become corrupted (the uploads themselves are not corrupted though).</p>
<p>If you are uploading small numbers of large file over high speed link and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers.</p>
<p>Paths are specified as <code>remote:container</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, eg <code>remote:container/path/to/dir</code>.</p>
<p>Here is an example of making a swift configuration. First run</p>
echo "Please enter your OpenStack Password: "
read -sr OS_PASSWORD_INPUT
export OS_PASSWORD=$OS_PASSWORD_INPUT
export OS_REGION_NAME="SBG1"
if [ -z "$OS_REGION_NAME" ]; then unset OS_REGION_NAME; fi</code></pre>
<p>The config file needs to look something like this where <code>$OS_USERNAME</code> represents the value of the <code>OS_USERNAME</code> variable - <code>123abc567xy</code> in the example above.</p>
<pre><code>[remote]
type = swift
user = $OS_USERNAME
key = $OS_PASSWORD
auth = $OS_AUTH_URL
tenant = $OS_TENANT_NAME</code></pre>
<p>Note that you may (or may not) need to set <code>region</code> too - try without first.</p>
<h3id="configuration-from-the-environment">Configuration from the environment</h3>
<p>If you prefer you can configure rclone to use swift using a standard set of OpenStack environment variables.</p>
<p>When you run through the config, make sure you choose <code>true</code> for <code>env_auth</code> and leave everything else blank.</p>
<p>rclone will then set any empty config parameters from the environment using standard OpenStack environment variables. There is <ahref="https://godoc.org/github.com/ncw/swift#Connection.ApplyEnvironment">a list of the variables</a> in the docs for the swift library.</p>
<h3id="using-an-alternate-authentication-method">Using an alternate authentication method</h3>
<p>If your OpenStack installation uses a non-standard authentication method that might not be yet supported by rclone or the underlying swift library, you can authenticate externally (e.g. calling manually the <code>openstack</code> commands to get a token). Then, you just need to pass the two configuration variables <code>auth_token</code> and <code>storage_url</code>. If they are both provided, the other variables are ignored. rclone will not try to authenticate but instead assume it is already authenticated and use these two variables to access the OpenStack installation.</p>
<p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <ahref="/docs/#fast-list">rclone docs</a> for more details.</p>
<h3id="update-and---use-server-modtime-1">--update and --use-server-modtime</h3>
<p>As noted below, the modified time is stored on metadata on the object. It is used by default for all operations that require checking the time a file was last updated. It allows rclone to treat the remote more like a true filesystem, but it is inefficient because it requires an extra API call to retrieve the metadata.</p>
<p>For many operations, the time the object was last uploaded to the remote is sufficient to determine if it is "dirty". By using <code>--update</code> along with <code>--use-server-modtime</code>, you can avoid the extra API call and simply upload files whose local modtime is newer than the time it was last uploaded.</p>
<p>The storage policy to use when creating a new container</p>
<p>This applies the specified storage policy when creating a new container. The policy cannot be changed afterwards. The allowed configuration values and their meaning depend on your Swift storage provider.</p>
<ul>
<li>Config: storage_policy</li>
<li>Env Var: RCLONE_SWIFT_STORAGE_POLICY</li>
<li>Type: string</li>
<li>Default: ""</li>
<li>Examples:
<ul>
<li>""
<ul>
<li>Default</li>
</ul></li>
<li>"pcs"
<ul>
<li>OVH Public Cloud Storage</li>
</ul></li>
<li>"pca"
<ul>
<li>OVH Public Cloud Archive</li>
</ul></li>
</ul></li>
</ul>
<h3id="advanced-options-14">Advanced Options</h3>
<p>Here are the advanced options specific to swift (Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)).</p>
<h4id="swift-chunk-size">--swift-chunk-size</h4>
<p>Above this size files will be chunked into a _segments container.</p>
<p>The Swift API doesn't return a correct MD5SUM for segmented files (Dynamic or Static Large Objects) so rclone won't check or use the MD5SUM for these.</p>
<h4id="rclone-gives-failed-to-create-file-system-for-remote-bad-request">Rclone gives Failed to create file system for "remote:": Bad Request</h4>
<p>Due to an oddity of the underlying swift library, it gives a "Bad Request" error rather than a more sensible error when the authentication fails for Swift.</p>
<p>So this most likely means your username / password is wrong. You can investigate further with the <code>--dump-bodies</code> flag.</p>
<p>This may also be caused by specifying the region when you shouldn't have (eg OVH).</p>
<h4id="rclone-gives-failed-to-create-file-system-response-didnt-have-storage-storage-url-and-auth-token">Rclone gives Failed to create file system: Response didn't have storage storage url and auth token</h4>
<p>This is most likely caused by forgetting to specify your tenant when setting up a swift remote.</p>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p>
<p>The initial setup for pCloud involves getting a token from pCloud which you need to do in your browser. <code>rclone config</code> walks you through it.</p>
<p>Here is an example of how to make a remote called <code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>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.
Choose a number from below, or type in your own value
1 / Amazon Drive
\ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3"
3 / Backblaze B2
\ "b2"
4 / Box
\ "box"
5 / Dropbox
\ "dropbox"
6 / Encrypt/Decrypt a remote
\ "crypt"
7 / FTP Connection
\ "ftp"
8 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage"
9 / Google Drive
\ "drive"
10 / Hubic
\ "hubic"
11 / Local Disk
\ "local"
12 / Microsoft Azure Blob Storage
\ "azureblob"
13 / Microsoft OneDrive
\ "onedrive"
14 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift"
15 / Pcloud
\ "pcloud"
16 / QingCloud Object Storage
\ "qingstor"
17 / SSH/SFTP Connection
\ "sftp"
18 / Yandex Disk
\ "yandex"
19 / http Connection
\ "http"
Storage> pcloud
Pcloud App Client Id - leave blank normally.
client_id>
Pcloud App Client Secret - leave blank normally.
client_secret>
Remote config
Use auto config?
* Say Y if not sure
* Say N if you are working on a remote or headless machine
y) Yes
n) No
y/n> y
If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
<p>See the <ahref="https://rclone.org/remote_setup/">remote setup docs</a> for how to set it up on a machine with no Internet browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect the token as returned from pCloud. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your pCloud</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your pCloud</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an pCloud directory called backup</p>
<p>pCloud allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not. In order to set a Modification time pCloud requires the object be re-uploaded.</p>
<p>pCloud supports MD5 and SHA1 type hashes, so you can use the <code>--checksum</code> flag.</p>
<p>Deleted files will be moved to the trash. Your subscription level will determine how long items stay in the trash. <code>rclone cleanup</code> can be used to empty the trash.</p>
<p>Paths are specified as <code>remote:path</code>. If the path does not begin with a <code>/</code> it is relative to the home directory of the user. An empty path <code>remote:</code> refers to the user's home directory.</p>
<p>Key files should be PEM-encoded private key files. For instance <code>/home/$USER/.ssh/id_rsa</code>. Only unencrypted OpenSSH or PEM encrypted files are supported.</p>
<p>You can also specify <code>key_use_agent</code> to force the usage of an ssh-agent. In this case <code>key_file</code> can also be specified to force the usage of a specific key in the ssh-agent.</p>
<p>Using an ssh-agent is the only way to load encrypted OpenSSH keys at the moment.</p>
<h3id="ssh-agent-on-macos">ssh-agent on macOS</h3>
<p>Note that there seem to be various problems with using an ssh-agent on macOS due to recent changes in the OS. The most effective work-around seems to be to start an ssh-agent in each session, eg</p>
<p>Some SFTP servers disable setting/modifying the file modification time after upload (for example, certain configurations of ProFTPd with mod_sftp). If you are using one of these servers, you can set the option <code>set_modtime = false</code> in your RClone backend configuration to disable this behaviour.</p>
<p>When set forces the usage of the ssh-agent.</p>
<p>When key-file is also set, the ".pub" file of the specified key-file is read and only the associated key is requested from the ssh-agent. This allows to avoid <code>Too many authentication failures for *username*</code> errors when the ssh-agent contains many keys.</p>
<p>Disable the execution of SSH commands to determine if remote file hashing is available. Leave blank or set to false to enable hashing (recommended), set to true to disable hashing.</p>
<ul>
<li>Config: disable_hashcheck</li>
<li>Env Var: RCLONE_SFTP_DISABLE_HASHCHECK</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h3id="advanced-options-15">Advanced Options</h3>
<p>Here are the advanced options specific to sftp (SSH/SFTP Connection).</p>
<p>SFTP supports checksums if the same login has shell access and <code>md5sum</code> or <code>sha1sum</code> as well as <code>echo</code> are in the remote's PATH. This remote checksumming (file hashing) is recommended and enabled by default. Disabling the checksumming may be required if you are connecting to SFTP servers which are not under your control, and to which the execution of remote commands is prohibited. Set the configuration option <code>disable_hashcheck</code> to <code>true</code> to disable checksumming.</p>
<p>Note that some SFTP servers (eg Synology) the paths are different for SSH and SFTP so the hashes can't be calculated properly. For them using <code>disable_hashcheck</code> is a good idea.</p>
<p>The only ssh agent supported under Windows is Putty's pageant.</p>
<p>The Go SSH library disables the use of the aes128-cbc cipher by default, due to security concerns. This can be re-enabled on a per-connection basis by setting the <code>use_insecure_cipher</code> setting in the configuration file to <code>true</code>. Further details on the insecurity of this cipher can be found [in this paper] (http://www.isg.rhul.ac.uk/~kp/SandPfinal.pdf).</p>
<p>SFTP isn't supported under plan9 until <ahref="https://github.com/pkg/sftp/issues/156">this issue</a> is fixed.</p>
<p>Note that since SFTP isn't HTTP based the following flags don't work with it: <code>--dump-headers</code>, <code>--dump-bodies</code>, <code>--dump-auth</code></p>
<p>Note that <code>--timeout</code> isn't supported (but <code>--contimeout</code> is).</p>
<p>The <code>union</code> remote provides a unification similar to UnionFS using other remotes.</p>
<p>Paths may be as deep as required or a local path, eg <code>remote:directory/subdirectory</code> or <code>/directory/subdirectory</code>.</p>
<p>During the initial setup with <code>rclone config</code> you will specify the target remotes as a space separated list. The target remotes can either be a local paths or other remotes.</p>
<p>The order of the remotes is important as it defines which remotes take precedence over others if there are files with the same name in the same logical path. The last remote is the topmost remote and replaces files with the same name from previous remotes.</p>
<p>Only the last remote is used to write to and delete from, all other remotes are read-only.</p>
<p>Subfolders can be used in target remote. Asume a union remote named <code>backup</code> with the remotes <code>mydrive:private/backup mydrive2:/backup</code>. Invoking <code>rclone mkdir backup:desktop</code> is exactly the same as invoking <code>rclone mkdir mydrive2:/backup/desktop</code>.</p>
<p>There will be no special handling of paths containing <code>..</code> segments. Invoking <code>rclone mkdir backup:../desktop</code> is exactly the same as invoking <code>rclone mkdir mydrive2:/backup/../desktop</code>.</p>
<p>Here is an example of how to make a union called <code>remote</code> for local folders. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>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.
Choose a number from below, or type in your own value
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/union/union.go then run make backenddocs -->
<h3id="standard-options-22">Standard Options</h3>
<p>Here are the standard options specific to union (A stackable unification remote, which can appear to merge the contents of several remotes).</p>
<h4id="union-remotes">--union-remotes</h4>
<p>List of space separated remotes. Can be 'remotea:test/dir remoteb:', '"remotea:test/space dir" remoteb:', etc. The last remote is used to write to.</p>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p>
<p>To configure the WebDAV remote you will need to have a URL for it, and a username and password. If you know what kind of system you are connecting to then rclone can enable extra features.</p>
<p>Here is an example of how to make a remote called <code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>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.
Choose a number from below, or type in your own value
<p>Likewise plain WebDAV does not support hashes, however when used with Owncloud or Nexcloud rclone will support SHA1 and MD5 hashes. Depending on the exact version of Owncloud or Nextcloud hashes may appear on all objects, or only on objects which had a hash uploaded with them.</p>
<p>Click on the settings cog in the bottom right of the page and this will show the WebDAV URL that rclone needs in the config step. It will look something like <code>https://example.com/remote.php/webdav/</code>.</p>
<p>Owncloud supports modified times using the <code>X-OC-Mtime</code> header.</p>
<h3id="nextcloud">Nextcloud</h3>
<p>This is configured in an identical way to Owncloud. Note that Nextcloud does not support streaming of files (<code>rcat</code>) whereas Owncloud does. This <ahref="https://github.com/nextcloud/nextcloud-snap/issues/365">may be fixed</a> in the future.</p>
<p>put.io can be accessed in a read only way using webdav.</p>
<p>Configure the <code>url</code> as <code>https://webdav.put.io</code> and use your normal account username and password for <code>user</code> and <code>pass</code>. Set the <code>vendor</code> to <code>other</code>.</p>
<p>Your config file should end up looking like this:</p>
<pre><code>[putio]
type = webdav
url = https://webdav.put.io
vendor = other
user = YourUserName
pass = encryptedpassword</code></pre>
<p>If you are using <code>put.io</code> with <code>rclone mount</code> then use the <code>--read-only</code> flag to signal to the OS that it can't write to the mount.</p>
<p>For more help see <ahref="http://help.put.io/apps-and-integrations/ftp-and-webdav">the put.io webdav docs</a>.</p>
<p>Rclone can be used with Sharepoint provided by OneDrive for Business or Office365 Education Accounts. This feature is only needed for a few of these Accounts, mostly Office365 Education ones. These accounts are sometimes not verified by the domain owner <ahref="https://github.com/ncw/rclone/issues/1975">github#1975</a></p>
<p>This means that these accounts can't be added using the official API (other Accounts should work with the "onedrive" option). However, it is possible to access them using webdav.</p>
<p>To use a sharepoint remote with rclone, add it like this: First, you need to get your remote's URL:</p>
<ul>
<li>Go <ahref="https://onedrive.live.com/about/en-us/signin/">here</a> to open your OneDrive or to sign in</li>
<li>Now take a look at your address bar, the URL should look like this: <code>https://[YOUR-DOMAIN]-my.sharepoint.com/personal/[YOUR-EMAIL]/_layouts/15/onedrive.aspx</code></li>
</ul>
<p>You'll only need this URL upto the email address. After that, you'll most likely want to add "/Documents". That subdirectory contains the actual data stored on your OneDrive.</p>
<p>Add the remote to rclone like this: Configure the <code>url</code> as <code>https://[YOUR-DOMAIN]-my.sharepoint.com/personal/[YOUR-EMAIL]/Documents</code> and use your normal account email and password for <code>user</code> and <code>pass</code>. If you have 2FA enabled, you have to generate an app password. Set the <code>vendor</code> to <code>sharepoint</code>.</p>
<p><ahref="https://www.dcache.org/">dCache</a> is a storage system with WebDAV doors that support, beside basic and x509, authentication with <ahref="https://www.dcache.org/manuals/workshop-2017-05-29-Umea/000-Final/anupam_macaroons_v02.pdf">Macaroons</a> (bearer tokens).</p>
<p>Configure as normal using the <code>other</code> type. Don't enter a username or password, instead enter your Macaroon as the <code>bearer_token</code>.</p>
<p>The config will end up looking something like this.</p>
<p>There is a <ahref="https://github.com/sara-nl/GridScripts/blob/master/get-macaroon">script</a> that obtains a Macaroon from a dCache WebDAV endpoint, and creates an rclone config file.</p>
<p>See the <ahref="https://rclone.org/remote_setup/">remote setup docs</a> for how to set it up on a machine with no Internet browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect the token as returned from Yandex Disk. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>Modified times are supported and are stored accurate to 1 ns in custom metadata called <code>rclone_modified</code> in RFC3339 with nanoseconds format.</p>
<h3id="md5-checksums">MD5 checksums</h3>
<p>MD5 checksums are natively supported by Yandex Disk.</p>
<h3id="emptying-trash-1">Emptying Trash</h3>
<p>If you wish to empty your trash you can use the <code>rclone cleanup remote:</code> command which will permanently delete all your trashed files. This command does not take any path arguments.</p>
<p>To view your current quota you can use the <code>rclone about remote:</code> command which will display your usage limit (quota) and the current usage.</p>
<p>When uploading very large files (bigger than about 5GB) you will need to increase the <code>--timeout</code> parameter. This is because Yandex pauses (perhaps to calculate the MD5SUM for the entire file) before returning confirmation that the file has been uploaded. The default handling of timeouts in rclone is to assume a 5 minute pause is an error and close the connection - you'll see <code>net/http: timeout awaiting response headers</code> errors in the logs if this is happening. Setting the timeout to twice the max size of file in GB should be enough, so if you want to upload a 30GB file set a timeout of <code>2 * 30 = 60m</code>, that is <code>--timeout 60m</code>.</p>
<p>Here are the advanced options specific to yandex (Yandex Disk).</p>
<h4id="yandex-unlink">--yandex-unlink</h4>
<p>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.</p>
<p>Rclone reads and writes the modified time using an accuracy determined by the OS. Typically this is 1ns on Linux, 10 ns on Windows and 1 Second on OS X.</p>
<p>Filenames are expected to be encoded in UTF-8 on disk. This is the normal case for Windows and OS X.</p>
<p>There is a bit more uncertainty in the Linux world, but new distributions will have UTF-8 encoded files names. If you are using an old Linux filesystem with non UTF-8 file names (eg latin1) then you can use the <code>convmv</code> tool to convert the filesystem to UTF-8. This tool is available in most distributions' package managers.</p>
<p>If an invalid (non-UTF8) filename is read, the invalid characters will be replaced with the unicode replacement character, '<27>'. <code>rclone</code> will emit a debug message in this case (use <code>-v</code> to see), eg</p>
<pre><code>Local file system at .: Replacing invalid UTF-8 characters in "gro\xdf"</code></pre>
<h3id="long-paths-on-windows">Long paths on Windows</h3>
<p>Rclone handles long paths automatically, by converting all paths to long <ahref="https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx#maxpath">UNC paths</a> which allows paths up to 32,767 characters.</p>
<p>This is why you will see that your paths, for instance <code>c:\files</code> is converted to the UNC path <code>\\?\c:\files</code> in the output, and <code>\\server\share</code> is converted to <code>\\?\UNC\server\share</code>.</p>
<p>However, in rare cases this may cause problems with buggy file system drivers like <ahref="https://github.com/ncw/rclone/issues/261">EncFS</a>. To disable UNC conversion globally, add this to your <code>.rclone.conf</code> file:</p>
<pre><code>[local]
nounc = true</code></pre>
<p>If you want to selectively disable UNC, you can add it to a separate entry like this:</p>
<p>This will use UNC paths on <code>c:\src</code> but not on <code>z:\dst</code>. Of course this will cause problems if the absolute path length of a file exceeds 258 characters on z, so only use this option if you have to.</p>
<p>If you supply <code>--copy-links</code> or <code>-L</code> then rclone will follow the symlink and copy the pointed to file or directory. Note that this flag is incompatible with <code>-links</code> / <code>-l</code>.</p>
<p>Normally rclone will ignore symlinks or junction points (which behave like symlinks under Windows).</p>
<p>If you supply this flag then rclone will copy symbolic links from the local storage, and store them as text files, with a '.rclonelink' suffix in the remote storage.</p>
<p>The text file will contain the target of the symbolic link (see example).</p>
<p>This flag applies to all commands.</p>
<p>For example, supposing you have a directory structure like this</p>
<h3id="restricting-filesystems-with---one-file-system">Restricting filesystems with --one-file-system</h3>
<p>Normally rclone will recurse through filesystems as mounted.</p>
<p>However if you set <code>--one-file-system</code> or <code>-x</code> this tells rclone to stay in the filesystem specified by the root and not to recurse into different file systems.</p>
<p>Using <code>rclone --one-file-system copy root remote:</code> will only copy <code>file1</code> and <code>file2</code>. Eg</p>
<pre><code>$ rclone -q --one-file-system ls root
0 file1
0 file2</code></pre>
<pre><code>$ rclone -q ls root
0 disk1/file3
0 disk2/file4
0 file1
0 file2</code></pre>
<p><strong>NB</strong> Rclone (like most unix tools such as <code>du</code>, <code>rsync</code> and <code>tar</code>) treats a bind mount to the same device as being on the same filesystem.</p>
<p>Don't warn about skipped symlinks. This flag disables warning messages on skipped symlinks or junction points, as you explicitly acknowledge that they should be skipped.</p>
<p>Don't apply unicode normalization to paths and filenames (Deprecated)</p>
<p>This flag is deprecated now. Rclone no longer normalizes unicode file names, but it compares them with unicode normalization in the sync routine instead.</p>
<p>Don't check to see if the files change during upload</p>
<p>Normally rclone checks the size and modification time of files as they are being uploaded and aborts with a message which starts "can't copy - source file is being updated" if the file changes during upload.</p>
<p>However on some file systems this modification time check may fail (eg <ahref="https://github.com/ncw/rclone/issues/2206">Glusterfs #2206</a>) so this check can be disabled with this flag.</p>
<li>Logging revamped to be more inline with rsync - now much quieter * -v only shows transfers * -vv is for full debug * --syslog to log to syslog on capable platforms</li>
<li>use official AWS SDK from github.com/aws/aws-sdk-go</li>
<li><strong>NB</strong> will most likely require you to delete and recreate remote</li>
<li>enable multipart upload which enables files > 5GB</li>
<li>tested with Ceph / RadosGW / S3 emulation</li>
<li>many thanks to Sam Liston and Brian Haymore at the <ahref="https://www.chpc.utah.edu/">Utah Center for High Performance Computing</a> for a Ceph test account</li>
<h2id="bugs-and-limitations">Bugs and Limitations</h2>
<h3id="empty-directories-are-left-behind-not-created">Empty directories are left behind / not created</h3>
<p>With remotes that have a concept of directory, eg Local and Drive, empty directories may be left behind, or not created when one was expected.</p>
<p>This is because rclone doesn't have a concept of a directory - it only works on objects. Most of the object storage systems can't actually store a directory so there is nowhere for rclone to store anything about directories.</p>
<p>You can work round this to some extent with the<code>purge</code> command which will delete everything under the path, <strong>inluding</strong> empty directories.</p>
<p>This may be fixed at some point in <ahref="https://github.com/ncw/rclone/issues/100">Issue #100</a></p>
<p>For the same reason as the above, rclone doesn't have a concept of a directory - it only works on objects, therefore it can't preserve the timestamps of directories.</p>
<p>Sure! Rclone stores all of its config in a single file. If you want to find this file, run <code>rclone config file</code> which will tell you where it is.</p>
Server B> rclone copy /tmp/whatever remote:Backup</code></pre>
<p>The file names you upload from Server A and Server B should be different in this case, otherwise some file systems (eg Drive) may make duplicates.</p>
<h3id="why-doesnt-rclone-support-partial-transfers-binary-diffs-like-rsync">Why doesn't rclone support partial transfers / binary diffs like rsync?</h3>
<p>Rclone stores each file you transfer as a native object on the remote cloud storage system. This means that you can see the files you upload as expected using alternative access methods (eg using the Google Drive web interface). There is a 1:1 mapping between files on your hard disk and objects created in the cloud storage system.</p>
<p>Cloud storage systems (at least none I've come across yet) don't support partially uploading an object. You can't take an existing object, and change some bytes in the middle of it.</p>
<p>It would be possible to make a sync system which stored binary diffs instead of whole objects like rclone does, but that would break the 1:1 mapping of files on your hard disk to objects in the remote cloud storage system.</p>
<p>All the cloud storage systems support partial downloads of content, so it would be possible to make partial downloads work. However to make this work efficiently this would require storing a significant amount of metadata, which breaks the desired 1:1 mapping of files to objects.</p>
<h3id="can-rclone-do-bi-directional-sync">Can rclone do bi-directional sync?</h3>
<p>No, not at present. rclone only does uni-directional sync from A -> B. It may do in the future though since it has all the primitives - it just requires writing the algorithm to do it.</p>
<h3id="can-i-use-rclone-with-an-http-proxy">Can I use rclone with an HTTP proxy?</h3>
<p>Yes. rclone will follow the standard environment variables for proxies, similar to cURL and other programs.</p>
<p>In general the variables are called <code>http_proxy</code> (for services reached over <code>http</code>) and <code>https_proxy</code> (for services reached over <code>https</code>). Most public services will be using <code>https</code>, but you may wish to set both.</p>
<p>The content of the variable is <code>protocol://server:port</code>. The protocol value is the one used to talk to the proxy server, itself, and is commonly either <code>http</code> or <code>socks5</code>.</p>
<p>Slightly annoyingly, there is no <em>standard</em> for the name; some applications may use <code>http_proxy</code> but another one <code>HTTP_PROXY</code>. The <code>Go</code> libraries used by <code>rclone</code> will try both variations, but you may wish to set all possibilities. So, on Linux, you may end up with code similar to</p>
<p>The <code>NO_PROXY</code> allows you to disable the proxy for specific hosts. Hosts must be comma separated, and can contain domains or parts. For instance "foo.com" also matches "bar.foo.com".</p>
<h3id="rclone-gives-x509-failed-to-load-system-roots-and-no-roots-provided-error">Rclone gives x509: failed to load system roots and no roots provided error</h3>
<p>This means that <code>rclone</code> can't file the SSL root certificates. Likely you are running <code>rclone</code> on a NAS with a cut-down Linux OS, or possibly on Solaris.</p>
<p>The two environment variables <code>SSL_CERT_FILE</code> and <code>SSL_CERT_DIR</code>, mentioned in the <ahref="https://godoc.org/crypto/x509">x509 pacakge</a>, provide an additional way to provide the SSL root certificates.</p>
<h3id="rclone-gives-failed-to-load-config-file-function-not-implemented-error">Rclone gives Failed to load config file: function not implemented error</h3>
<p>Likely this means that you are running rclone on Linux version not supported by the go runtime, ie earlier than version 2.6.23.</p>
<p>See the <ahref="https://golang.org/doc/install">system requirements section in the go install docs</a> for full details.</p>
<h3id="all-my-uploaded-docxxlsxpptx-files-appear-as-archivezip">All my uploaded docx/xlsx/pptx files appear as archive/zip</h3>
<p>This is caused by uploading these files from a Windows computer which hasn't got the Microsoft Office suite installed. The easiest way to fix is to install the Word viewer and the Microsoft Office Compatibility Pack for Word, Excel, and PowerPoint 2007 and later versions' file formats</p>
<h3id="tcp-lookup-some.domain.com-no-such-host">tcp lookup some.domain.com no such host</h3>
<p>This happens when rclone cannot resolve a domain. Please check that your DNS setup is generally working, e.g.</p>
<pre><code># both should print a long list of possible IP addresses
dig www.googleapis.com # resolve using your default DNS
dig www.googleapis.com @8.8.8.8 # resolve with Google's DNS server</code></pre>
<p>If you are using <code>systemd-resolved</code> (default on Arch Linux), ensure it is at version 233 or higher. Previous releases contain a bug which causes not all domains to be resolved properly.</p>
<p>Additionally with the <code>GODEBUG=netdns=</code> environment variable the Go resolver decision can be influenced. This also allows to resolve certain issues with DNS resolution. See the <ahref="https://golang.org/pkg/net/#hdr-Name_Resolution">name resolution section in the go docs</a>.</p>
