Overview
Rclone is a program that can be used to transfer files to and from more than forty different storage backends (e.g., Amazon S3, Box, Dropbox, FTP, Google Cloud Storage, Google Drive, Microsoft Azure Blob Storage, Microsoft OneDrive, Microsoft Sharepoint, SFTP, etc.).
The Mitto Rclone plugin provides an rclone job and wizard to create configurations to control rclone jobs. Mitto’s rclone job uses the rclone program to transfer files to and from the Mitto instance on which it runs or between two remote systems.
Currently the Mitto Rclone plugin wizard supports creating FTP and sFTP rclone jobs. Custom rclone jobs can be created to use any other rclone functionality. For even more advanced rclone use cases, create command line jobs.
Mitto Rclone API Documentation
See detailed Mitto Rclone API documentation.
Create a Mitto Rclone Job
You can set up the initial connection, or "remote" using the wizard, or alternatively you can use the Credentials page in your Mitto UI to set up the remote before-hand.
Select Rclone as the Job Type
To create the remote using the wizard, click on "Add Job" on the bottom left of the screen in your Mitto UI. Then select "Rclone":
Choose a Backend
On the second screen of the wizard type in the name of the job, and select the rclone backend type:
Supply Credentials
On the third screen you will enter the remote name and credentials for the connection.
If you created the credentials separately select "Use Existing Named Credentials, otherwise choose "Provide Credentials Now..." and then type in your remote name, hostname, username and password:
The Host Name field will only accept hostnames. This is a valid hostname:
sftp.hostname.net
Do not include the protocol when entering a hostname. This is an invalid hostname, because it includes the sftp:// portion of the URL:
sftp://sftp.hostname.net
When supplying a hostname, remove any protocol delaration: http://, sftp://, ftp://, etc.
Set Rclone Flags
On the fourth screen (not pictured) you can include any number of rclone flags. In addition to the available flags for the command you're using (examples: "copy" or "copyto") there are global flags available for use with any command.
Set Source and Destination
On the final screen of the wizard is where you define the source and destination files. In the following example we're copying from the Mitto file directory to a destination on the sftp server. A remote source or destination will always be an rclone remote name followed by a :. sftpserver: in this case.
Further Reading
