GDrive

From UFRC
Revision as of 18:01, 4 August 2021 by Johnbullard (talk | contribs) (Johnbullard moved page Draft:GDrive to GDrive)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Description

GDrive website  

gdrive is a command line utility for interacting with Google Drive. You can use this utility to transfer files between the HiPerGator environment and your UF-provided Google Drive storage.

Environment Modules

Run module spider GDrive to find out what environment modules are available for this application.

System Variables

  • HPC_GDRIVE_DIR - installation directory
  • HPC_GDRIVE_BIN - executable directory

Additional Information

Initial authentication and authorization

Before using GDrive from the HiPerGator environment, you must give it permission to access your Googe Drive. Do that by following the steps below.

  • Load the module and then initiate authentication using "gdrive about":
$ module load gdrive/2.1.0
$ gdrive about
  • If authentication is needed (e.g. it is your first time using the module or your prior authentication has expired), you will then get the following prompt:
Authentication needed
Go to the following url in your browser:
https://accounts.google.com/o/oauth2/auth?access_type=offline&client_id=...
Enter verification code:
The URL in the example above is truncated to make these instructions easier to read. The actual URL you will see on your screen is much longer. Make sure you select and copy all of it.


  • Copy and paste the supplied URL into a browser on your desktop.
  • In that browser, log into your UF Google account using your UF credentials.
  • You will then be prompted that "project-367116221053 wants to access your Google Account...See, edit, create, and delete all of your Google Drive files". Read the note below and, if you are comfortable with this, click [Allow].
"project-367116221053" is the name that the developer of the "gdrive" software () provided to Google when registering the application for review and acceptance. A copy of this reviewed/accepted software is installed in the HiPerGator environment and must keep this name to be recognized. When you click the [Allow] button, you are effectively saying "allow the copy of gdrive3 that is running on HiPerGator to access my Google Drive (as long as it has a valid token)".


  • After allowing permissions, you will be taken to a page with an authorization code on it. Copy that code and paste it back in your HiPerGator session where it is waiting at the "Enter verification code:" prompt.
  • You should now be able you access your Google drive using gdrive commands (i.e. try "gdrive list" to show the files currently in your Google Drive).
This process will have created a sub-directory in your home directory called ".gdrive". The contents of the ".gdrive" directory contain information allowing direct access to your Google Drive and should be considered secret. Do not share or change the permissions of the directory or its contents.


GDrive commands

You can get a full list of available commands by typing "gdrive help" but example of the most common ones are:

List files currently in your Google Drive:

gdrive list

Upload a file to your Google Drive:

gdrive upload /orange/yourgroup/yourusername/mydata/somefile.dat

Upload an entire directory to your Google Drive:

gdrive upload --recursive /orange/yourgroup/yourusername/mydata/

Download a file from your Google Drive to a specific directory:

gdrive download --path /orange/yourgroup/yourusername/mydata/ 1PrZieajI6P6ikl1zk1Zn4zRhXZMOhoDg

or

gdrive download query --path /orange/yourgroup/yourusername/mydata/ somefile.dat


Revoking Access

The contents of the ".gdrive" directory contain information allowing direct access to your Google Drive and should be considered secret. Do not share or change the permissions of the directory or its contents.

When you perform the initial authentication and authorization steps above, the program creates access tokens in your home directory as:

/home/yourusername/.gdrive/

You can immediately revoke access at any time by removing that directory:

rm -rf /home/yourusername/.gdrive/