FTP is the File Transfer Protocol. Rclone FTP support is provided using the github.com/jlaffaye/ftp package.
Limitations of Rclone's FTP backend
Paths are specified as
remote:path. If the path does not begin with
/ it is relative to the home directory of the user. An empty path
remote: refers to the user's home directory.
To create an FTP configuration named
Rclone config guides you through an interactive setup process. A minimal rclone FTP remote definition only requires host, username and password. For an anonymous FTP server, see below.
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. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / FTP \ "ftp" [snip] Storage> ftp ** See help for ftp backend at: https://rclone.org/ftp/ ** FTP host to connect to Enter a string value. Press Enter for the default (""). 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 Enter a string value. Press Enter for the default ("$USER"). user> FTP port number Enter a signed integer. Press Enter for the 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: Use FTP over TLS (Implicit) Enter a boolean value (true or false). Press Enter for the default ("false"). tls> Use FTP over TLS (Explicit) Enter a boolean value (true or false). Press Enter for the default ("false"). explicit_tls> Remote config -------------------- [remote] type = ftp host = ftp.example.com pass = *** ENCRYPTED *** -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
To see all directories in the home directory of
rclone lsd remote:
Make a new directory
rclone mkdir remote:path/to/directory
List the contents of a directory
rclone ls remote:path/to/directory
/home/local/directory to the remote directory, deleting any
excess files in the directory.
rclone sync --interactive /home/local/directory remote:directory
When connecting to a FTP server that allows anonymous login, you can use the special "anonymous" username. Traditionally, this user account accepts any string as a password, although it is common to use either the password "anonymous" or "guest". Some servers require the use of a valid e-mail address as password.
Using on-the-fly or connection string remotes makes it easy to access such servers, without requiring any configuration in advance. The following are examples of that:
rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=$(rclone obscure dummy) rclone lsf :ftp,host=speedtest.tele2.net,user=anonymous,pass=$(rclone obscure dummy):
The above examples work in Linux shells and in PowerShell, but not Windows Command Prompt. They execute the rclone obscure command to create a password string in the format required by the pass option. The following examples are exactly the same, except use an already obscured string representation of the same password "dummy", and therefore works even in Windows Command Prompt:
rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=IXs2wc8OJOz7SYLBk47Ji1rHTmxM rclone lsf :ftp,host=speedtest.tele2.net,user=anonymous,pass=IXs2wc8OJOz7SYLBk47Ji1rHTmxM:
Rlone FTP supports implicit FTP over TLS servers (FTPS). This has to
be enabled in the FTP backend config for the remote, or with
--ftp-tls. The default FTPS port is
can be set with
In addition to the default restricted characters set the following characters are also replaced:
File names cannot end with the following characters. Replacement is limited to the last character in a file name:
Not all FTP servers can have all characters in file names, for example:
|FTP Server||Forbidden characters|
This backend's interactive configuration wizard provides a selection of sensible encoding settings for major FTP servers: ProFTPd, PureFTPd, VsFTPd. Just hit a selection number when prompted.
Here are the Standard options specific to ftp (FTP).
FTP host to connect to.
FTP port number.
NB Input to this must be obscured - see rclone obscure.
Use Implicit FTPS (FTP over TLS).
When using implicit FTP over TLS the client connects using TLS right from the start which breaks compatibility with non-TLS-aware servers. This is usually served over port 990 rather than port 21. Cannot be used in combination with explicit FTPS.
Use Explicit FTPS (FTP over TLS).
When using explicit FTP over TLS the client explicitly requests security from the server in order to upgrade a plain text connection to an encrypted one. Cannot be used in combination with implicit FTPS.
Here are the Advanced options specific to ftp (FTP).
Maximum number of FTP simultaneous connections, 0 for unlimited.
Note that setting this is very likely to cause deadlocks so it should be used with care.
If you are doing a sync or copy then make sure concurrency is one more
than the sum of
If you use
--check-first then it just needs to be one more than the
concurrency 3 you'd use
--checkers 2 --transfers 2 --check-first or
--checkers 1 --transfers 1.
Do not verify the TLS certificate of the server.
Disable using EPSV even if server advertises support.
Disable using MLSD even if server advertises support.
Disable using UTF-8 even if server advertises support.
Use MDTM to set modification time (VsFtpd quirk)
Use LIST -a to force listing of hidden files and folders. This will disable the use of MLSD.
Max time before closing idle connections.
If no connections have been returned to the connection pool in the time given, rclone will empty the connection pool.
Set to 0 to keep connections indefinitely.
Maximum time to wait for a response to close.
Size of TLS session cache for all control and data connections.
TLS cache allows to resume TLS sessions and reuse PSK between connections. Increase if default size is not enough resulting in TLS resumption errors. Enabled by default. Use 0 to disable.
Disable TLS 1.3 (workaround for FTP servers with buggy TLS)
Maximum time to wait for data connection closing status.
Allow asking for FTP password when needed.
If this is set and no password is supplied then rclone will ask for a password
The encoding for the backend.
See the encoding section in the overview for more info.
FTP servers acting as rclone remotes must support
The mode cannot be configured as
passive is the only supported one.
Rclone's FTP implementation is not compatible with
as the library it uses doesn't support it.
This will likely never be supported due to security concerns.
Rclone's FTP backend does not support any checksums but can compare file sizes.
rclone about is not supported by the FTP backend. Backends without
this capability cannot determine free space for an rclone mount or
mfs (most free space) as a member of an rclone union
See List of backends that do not support rclone about and rclone about
The implementation of :
--dump auth for debugging isn't the same as
for rclone HTTP based backends - it has less fine grained control.
--timeout isn't supported (but
--bind isn't supported.
Rclone's FTP backend could support server-side move but does not at present.
ftp_proxy environment variable is not currently supported.
File modification time (timestamps) is supported to 1 second resolution
for major FTP servers: ProFTPd, PureFTPd, VsFTPd, and FileZilla FTP server.
VsFTPd server has non-standard implementation of time related protocol
commands and needs a special configuration setting:
writing_mdtm = true.
Support for precise file time with other FTP servers varies depending on what
protocol extensions they advertise. If all the
extensions are present, rclone will use them together to provide precise time.
Otherwise the times you see on the FTP server through rclone are those of the
last file upload.
You can use the following command to check whether rclone can use precise time
with your FTP server:
rclone backend features your_ftp_remote: (the trailing
colon is important). Look for the number in the line tagged by
designating the remote time precision expressed as nanoseconds. A value of
1000000000 means that file time precision of 1 second is available.
A value of
3153600000000000000 (or another large number) means "unsupported".