Using rclone on Linux to Automate Backups to Google Drive
As of now, Google has yet to release an official backup/sync client for Linux, and as a frequent WSL2 user, I was after a solution that would allow automated backups to Google drive from the WSL2 Linux file system/distro.
I’m a big fan of both Windows & Linux, and the evolution of WSL2 (with an actual Linux kernel) is making it easier to work in an almost “real” Linux environment without the need for third-party virtualization software. Using rclone with WSL2 gives me the option of restoring project files from a recent backup should I accidentally trash my WSL2 Linux distro.
The following write-up describes an approach for using an open source package, rclone, to automate backups from Linux to Google drive.
$ cd $HOME
$ curl https://rclone.org/install.sh | sudo bash
rclone v1.53.1 has successfully installed.
This installs the binary to location
Before being able to configure access for
rclone to our target Google Drive account, we need to enable the Google Drive API and create appropriate credentials.
Enable Google Drive API:
Login with your Google account at: https://console.cloud.google.com to begin the process for enabling the API.
- Navigate to “APIs & Services” → “Library”
- Search for and enable “Google Drive API”
- Choose “Create Credentials” and continue to the next section for configuring Oauth Consent Screen
Create Google Drive API credentials for rclone:
From the left hand pane of the cloud console, choose “Oauth consent screen” and perform the configuration using the following values.
- User Type: External -> Create
- Application name: rclone
- Support email: enter your google account email
- Add scopes: “Google Drive API” -> “…/auth/drive”
From the left hand pane, choose “Create credentials”
- Click on the menu “+Create credentials” and select “Oauth client ID”
- Application type: Desktop app
- Name: rclone
- Click “Create”
- A client id & client secret will be generated. Make a note of these as they are required during the rclone configuration process
Begin the rclone configuration by running:
$ rclone config
Throughout the configuration process, choose/enter the following options:
- n to add a new remote
- name: gdrive
- from the list storage providers choose the number/option corresponding to Google Drive \ “drive”
- Google application client id: as noted from Google config
- client secret: as noted from Google config
- scope: 1 / Full access all files, excluding Application Data Folder. \ “drive”
- root_folder_id: leave blank
- service_account_file: leave blank
- edit advanced config: N
- remote config use auto config: Y
- Open the generated URL link with your browser and complete the authentication process
- After successfully authenticating and granting permissions to rclone, go back to the rclone shell terminal session to continue configuration
- team drive: N
- Y to confirm configuration is correct
- Choose q to complete the configuration
To confirm that connectivity to Google Drive works correctly, we can list our remote root directory via:
$ rclone ls gdrive:/
Choosing an appropriate rclone command: copy or sync?
Depending on your backup requirements, you can choose from several different command options. Amongst these are copy, sync.
Copies the source to the destination. Doesn’t delete files from the destination. Doesn’t transfer unchanged files.
rclone copy <flags> source:sourcepath dest:destpath
The following command:
$ rclone copy --transfers 20 --retries 5 "/home/dev/g" "gdrive:/mybackup"
can be used to backup the contents of local subdirectory /home/dev/g to Google drive location gdrive:/mybackup, where gdrive is the reference to our Google drive alias as supplied during the
rclone config process, and /mybackup is the target location within our Google drive root directory.
The flags chosen in the above command translate to the following:
--transfers : number of file transfers to perform in parallel (20)
--retries : number of times to retry failed operations (5)
To see a full list of available flags, visit: https://rclone.org/flags/
Destination is updated to match source, including deleting files if necessary. Doesn’t transfer unchanged files
rclone sync <flags> SOURCE remote:DESTINATION
For the automation example that follows, we’ll use the
rclone copy option. Tread with caution if you decide to use the sync option. A misunderstanding of how the sync command works can potentially lead to loss of data.
Automating the rclone command with flock and cron
rclone copy command in the previous section can be implemented as a cron job, scheduled to run at desired intervals. Before we go into the scheduling, we need to deal with the situation where a backup may still be executing while the next scheduled instance is due to commence. A simple approach to managing this scenario would be via the concept of Advisory file locking with flock.
According to the man page for flock, we can use a one-liner flock command to implement our rclone backup.
$ flock -n /tmp/google_drv_sync.lock /usr/bin/rclone copy --transfers 20 --retries 5 "/home/dev/g" "gdrive:/mybackup"
The above flock command will create the file
google_drv_sync.lock (if it does not already exist) and acquire an exclusive (write) lock on the file for the duration of the rclone backup. The
-n option tells flock that in the case where the lock cannot be acquired (i.e. previous backup is still running), exit immediately with return code 1 (i.e. do not wait for lock to be released).
Enabling cron daemon
Ensure cron is enabled and running on the host.
sudo service cron start
You will also need to ensure the daemon is enabled during reboot/startup process.
If you are using a WSL2 Linux distro, exiting your WSL2 distro shell does not leave the daemon running in the background, and its state is not saved. The WSL2 Linux distro is considered to be offline if a background shell is not running.
To automatically re-enable the daemon once you log back into the WSL2/distro shell, you can add the following to your
sudo service cron status > /dev/null || sudo service cron start
Implementing crontab entry
Assuming our backup will run at 10 minute intervals, we can add the following crontab entry via
*/10 * * * * flock -n /tmp/google_drv_sync.lock /usr/bin/rclone copy --transfers 20 --retries 5 "/home/dev/g" "gdrive:/mybackup"
Monitoring locks using lslocks
To monitor the status of locks acquired at any point in time, the
lslocks command can be used. Once cron has triggered the rclone copy command, output of
lslocks should show that a lock has been placed on
/tmp/google_drv_sync.lock. Output from
cat /proc/locksshould show the lock type as Advisory.
rclone is open source with source code published at https://github.com/rclone/rclone. Compiling from source is described at https://github.com/rclone/rclone/blob/master/MANUAL.md#install-from-source.
In addition to Google Drive, rclone supports a wide range of additional storage providers, including Amazon and Microsoft OneDrive.