Install: Rclone

Rclone (by Nick Craig-Wood) is "rsync for the cloud". Basically, it is used to transfer data to or from a variety of supported cloud storage providers (eg Google Drive).

Rclone is used by Cloudplow and Backup to upload media and backup Cloudbox, respectively.

The guide below assumes you are using Google Drive.

If you already have an Rclone remote pointed to Google Drive with the remote name google, you may skip this page. If it is named differently, you can edit your Rclone config file and rename the remote to google (see below).

New Rclone Setup

1. Run the following command:

   rclone config
   

2. Type n for "New remote" and press enter.

   

3. For "name", type in google and press enter.

   

4. For "Type of storage", type in drive, or the corresponding number, and press enter.

   

5. Create a Google Drive API Client ID and Client Secret for Rclone.

6. For "Google Application Client ID", use the Client ID you got from Step #5.

   

7. For "Google Application Client Secret", use the Client Secret you got from Step #5.

   

8. For the "Scope that rclone should use when requesting access from drive", type in drive, or the corresponding number (i.e. 1), to select "Full access all files, excluding Application Data Folder", and press enter.

   

9. For "ID of the root folder", leave blank and press enter.

   

10. For "Service Account Credentials JSON file path", leave blank and press enter.

    

11. For "Edit advanced config", type n and press enter.

    

12. For "Use auto config?", type n for "...remote or headless machine" and press enter.

    

13. In the next section, copy the link shown, and open it in your host PC's browser. If asked, login with your Google account and click "Allow".

    

    

    

    Note: You must use the same Google account as the Google Drive one you intend to use (see Prerequisites).

14. After clicking, you will be given a "verification code". Copy this and paste it on the command prompt.

    

    

15. For "Configure this as a team drive?", type n and press enter.

    

16. To confirm that the remote details look OK, type y and press enter.

    

17. To exit, type q and press enter.

    

Existing Rclone Setup

If Rclone is already setup with Google Drive, you will need to rename the Google Drive remote to google (if it isn't already):

1. Find and edit your Rclone configuration file.

   nano $(rclone config file | tail -n 1)
   

2. Rename the Google Drive drive remote (name between the brackets) to google.

3. It will now look like this:

   [google]
   type = drive
   client_id = 1234567890123-mjffsmxvendscftuvnyngkhegapovgnv.apps.googleusercontent.com
   client_secret = klflzftkrwuwuedesxzewsfz
   token = {"access_token":"ya30.gelftvrymioiilvdtfegfvhfgallrhocewjckdnnvmxdjpjzbdhkmgulvqhgbafkdtpottzthhnyzysxwlpf-38ikRIxZvimyoxyKdse$
   

4. Save the file and exit: Ctrl + X Y Enter.

5. Copy the config file to ~/.config/rclone/rclone.conf (if it isn't there already):

   cp -n $(rclone config file | tail -n 1) ~/.config/rclone/rclone.conf
   

6. Give it the proper ownership and permissions. Replace user and group to match yours' (see here):

   sudo chown user:group ~/.config/rclone/rclone.conf
   sudo chmod 755 ~/.config/rclone/rclone.conf