Rclone on Caviness

This document describes how to manually configure (set up) Rclone using University of Delaware email account for Google Drive on Caviness.

First use VALET to load rclone into your environment

[traine@login00 ~]$ vpkg_require rclone
Adding package `rclone/1.54.1` to your environment
[traine@login00 ~]$

Create a new Rclone remote configuration by typing 'rclone config'. In this example, we are going to calling this new configuration cavinessGoogleDrive. You don't have to use this name, you can call your configuration whatever you would like.

[traine@login00 ~]$ rclone config
2021/03/22 13:19:43 NOTICE: Config file "/home/1200/.config/rclone/rclone.conf" not found - using defaults
 
No remotes found - make a new one
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n
name> cavinessGoogleDrive

Next find the "Google Drive" option from the given list of cloud services. Once it is located enter its value. For this example it is drive. These options can change so please make sure that you read and choose the right option.

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
 1 / Fichier
   \ "fichier"
 2 / Alias for an existing remote
   \ "alias"
 3 / Amazon Drive
   \ "amazon cloud drive"
 
   ... Skipping lines...
 
14 / Google Cloud Storage (this is not Google Drive)
   \ "google cloud storage"
15 / Google Drive
   \ "drive"
16 / Google Photos
   \ "google photos"
17 / Hadoop distributed file system
   \ "hdfs"
 
... Skipping more lines ...
 
41 / premiumize.me
   \ "premiumizeme"
42 / seafile
   \ "seafile"
Storage> drive

The next couple of steps will be ask about adding a client_id and a client_secret. Unless you know you will need to use these, the default blank option is all that needs to be entered.

** See help for drive backend at: https://rclone.org/drive/ **
 
Google Application Client Id
Setting your own is recommended.
See https://rclone.org/drive/#making-your-own-client-id for how to create your own.
If you leave this blank, it will use an internal key which is low performance.
Enter a string value. Press Enter for the default ("").
client_id>
OAuth Client Secret
Leave blank normally.
Enter a string value. Press Enter for the default ("").
client_secret>

The next step will give you options to which you will grant Rclone permission to access your files and directories in your Google Drive. We are going to use the default value of full access but you can read the different options and choose the best option for you.

Scope that rclone should use when requesting access from drive.
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
 1 / Full access all files, excluding Application Data Folder.
   \ "drive"
 2 / Read-only access to file metadata and file contents.
   \ "drive.readonly"
   / Access to files created by rclone only.
 3 | These are visible in the drive website.
   | File authorization is revoked when the user deauthorizes the app.
   \ "drive.file"
   / Allows read and write access to the Application Data folder.
 4 | This is not visible in the drive website.
   \ "drive.appfolder"
   / Allows read-only access to file metadata but
 5 | does not allow any access to read or download file content.
   \ "drive.metadata.readonly"
scope> 1

For the next two questions the default blanks choices should be all that is needed.

ID of the root folder
Leave blank normally.
 
Fill in to access "Computers" folders (see docs), or for rclone to use
a non root folder as its starting point.
 
Enter a string value. Press Enter for the default ("").
root_folder_id>
Service Account Credentials JSON file path
Leave blank normally.
Needed only if you want use SA instead of interactive login.
 
Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.
 
Enter a string value. Press Enter for the default ("").
service_account_file>

For the next question about advance config is generally no required so n for the no option typically the correct option.

Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n> n

So far we have been answering the configuration questions mostly with the default options. However the next question is where we will differ from the typical set up process. Since firewall permissions will not allow the auto config to work correctly we will say n. This option will allow us safely work around the firewall permission issue by allowing us to request a verification code from our local machine. Then we can manually copy and paste the verification code to DARWIN.

Remote config
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine
y) Yes (default)
n) No
y/n> n

After you enter n you will given a URL that will allow you you sign into your university google email account and request a verification code for Rclone to use. Copy that URL and open it a web browser on your local computer. Sign in and afterwards you will be given your verification code, copy and paste it into the your Caviness shell session.

Please go to the following link: https://accounts.google.com/o/oauth2/auth?access_type=offline&client_id=**The rest of this link is unique for each user.**
Log in and authorize rclone for access
Enter verification code> *** ENTER YOU UNIQUE VERIFICATION CODE HERE ***

The last step will ask you if you want to configure this as a "Shared Drive(Team Drive)". For this example we will say no.

Configure this as a Shared Drive (Team Drive)?
y) Yes
n) No (default)
y/n> n

Now you can review and your configuration and make edits if needed. If everything is okay select y.

--------------------
[cavinessGoogleDrive]
type = drive
scope = drive
token = {"access_token":**The rest of this is private and unique information for each user.**"}
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

Once everything is configured correctly, Rclone will show you a list of your remote configurations, and give you options to modify, create a new one, or simply exit the Rclone configuration. At this point, assuming all steps were followed as described, we will simple Quit Config with the q option, and press 'Enter'.

Name                   Type
====                   ====
cavinessGoogleDrive    drive
 
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

To make sure the new remote configuration is working correctly, we will use the Rclone lsd command to list out the root level directories of the remote configuration, cavinessGoogleDrive, for our University of Delaware Google Drive on Caviness.

[traine@login00 ~]$ rclone lsd cavinessGoogleDrive:
          -1 2020-11-16 15:43:38        -1 Introduction to Unix Shell on Caviness GDoc
          -1 2020-05-05 16:46:11        -1 wifi-map

For additional information on Rclone and more options please visit Rclone