Rclone as a helper for external backups
Rsync for the Cloud
Backups for critical data have to withstand major disasters. Rclone, a descendant of Rsync, enables easy backups to the cloud and supports many services.
We all live in the hope of never getting into a situation where our belongings are destroyed by theft, fire, water, or natural disaster, but there are no guarantees. If you are serious about preserving your important digital data, you should secure it outside your home, preferably in several places at the same time. The Rsync-based Rclone [1] tool helps with off-site backup scenarios.
Rclone is a command-line program that performs one-way synchronization between locally defined datasets and a cloud. If you run it a second time, it searches the local filesystem for changes and then incrementally uploads only the changes to the cloud of your choice. Rclone implements most of Rsync's options and syntax. In addition, it offers additional commands to optimally support the individual services. Rclone offers a graphical front end for people who prefer not to work at the command line.
Rsync's two-way synchronization is not part of Rclone's feature set. This means that it deletes any locally-deleted files from the cloud, but not vice versa. In addition, the program does not save older versions when changes are made to files. It overwrites changed files, unless the selected service has its own versioning system, such as Google Drive or Dropbox. One way to avoid this is to use the backup-dir
function, which moves changed or deleted files to a separate directory [2].
The tool, written in Go, which can be found in the archives of most distributions, supports numerous cloud service providers and protocols, including the open source clouds Nextcloud, ownCloud, and OpenStack Swift, as well as the commercial offerings Amazon S3, Box, Dropbox, Google Drive, pCloud, and Microsoft OneDrive [3].
Rclone also supports the HTTP, FTP, SFTP, and WebDAV protocols, so web and file servers, as well as NAS devices, can be integrated as back ends using standard protocols. The program is available in variants for x86, ARM, and MIPS architectures. Not only for Linux, Rclone also is available for macOS, Windows, BSD, Plan 9, and Solaris, as well as NAS servers from QNAP and Synology.
Rclone v1.48 is the current version. Your distribution may use an earlier version (e.g., Debian "Stable" uses version 1.35). However, you can install the latest version of Rclone directly with:
curl https://rclone.org/install.sh | sudo bash
You may have to install cURL first by typing:
sudo apt install curl
Creating Remotes
You control Rclone with the command of the same name (rclone
) and an attached command line including various options (see Table 1). To get started, call the configuration with rclone config
. The setup wizard offers a number of options: Use S
to set a password and Q
to quit the program.
Table 1
Important Rclone Commands
Command | Function |
---|---|
rclone config |
Opens the configuration |
rclone copy |
Copies data from the local system to cloud storage |
rclone sync |
Synchronizes source and target |
rclone mount |
Mount the drive locally into the filesystem |
rclone move |
Moves data from source to destination |
rclone delete |
Removes the contents of a path |
rclone purge |
Removes the path and its contents |
rclone ls |
Lists all objects in the path with a size specification |
rclone md5sum |
Creates md5sum checksums for all objects in the path |
rclone size |
Number and total size of all objects in <Remote>:<Path> |
rclone cryptcheck |
Checks the integrity of an encrypted remote |
These and other commands show their options after entering -h. |
Then use N
to set up the first remote connection ("remote" here refers to the connection to a specific folder on a specific cloud service) – select this option first. Since Rsync lets you configure multiple remotes, make sure you use a meaningful name in the first step. Then select the desired service or protocol using a number (Figure 1).
Google Drive Tested
In my hands-on test, I set up Rclone with Google Drive as a proprietary provider on a laptop. Of course, I do not want to store private data on Google's servers without encryption. Therefore, after an initial open test, I encrypted the data to be backed up before uploading with Rclone.
In the test, the remote repository is named gdrv
. You then need to select the corresponding number for the desired service (Google Drive here) from the list by entering 12
. For each provider and each protocol, the documentation offers a detailed manual [3], including Google Drive. The following two queries after client_id
and client_secret
can be skipped by pressing Enter.
Then decide whether Rclone should have full access to all files of the online repository or only access its own uploaded data. In addition, access can be restricted so that Rclone can only read. I selected full access for the test with the 1
option. Then skip the question about the root_folder_id
, as well as the question about the service_account_file
– Rclone can determine the root itself.
Can It Do That?
Finally, it doesn't hurt to look at the advanced configuration for Google Drive to learn about the additional options detailed in the documentation [4].
You are then taken to the point where Rclone can access your Google Drive account. To do this, say Y
to the auto config
prompt, and open your Google login in a browser window. After logging in, confirm that Rclone is allowed to access your drive (Figure 2). In the terminal, a Got Code message will appear; you can now close the browser again.
Having said this, the automatic method did not work for me. It was possible to register with Google, but the Rclone connection did not happen. A second attempt where I manually entered the URL, http://127.0.0.1:53682/auth, was then successful and let me complete this remote's configuration. To run Rclone in headless mode (i.e., without the option of opening a browser), create an API key in JSON format via a Google Service Account [5] and enter it in the advanced configuration.
This completes the setup wizard. You now have the choice of configuring additional remotes or protecting the configuration with a password. To do this, restart the configuration and select S
for "set configuration password". Instead of a password, you can also make the configuration file readable for only your user with:
chmod 600 ~/.config/rclone/rclone.conf
Buy this article as PDF
(incl. VAT)
Buy Linux Magazine
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.
News
-
Gnome 48 Alpha Ready for Testing
The latest Gnome desktop alpha is now available with plenty of new features and improvements.
-
Wine 10 Includes Plenty to Excite Users
With its latest release, Wine has the usual crop of bug fixes and improvements, along with some exciting new features.
-
Linux Kernel 6.13 Offers Improvements for AMD/Apple Users
The latest Linux kernel is now available, and it includes plenty of improvements, especially for those who use AMD or Apple-based systems.
-
Gnome 48 Debuts New Audio Player
To date, the audio player found within the Gnome desktop has been meh at best, but with the upcoming release that all changes.
-
Plasma 6.3 Ready for Public Beta Testing
Plasma 6.3 will ship with KDE Gear 24.12.1 and KDE Frameworks 6.10, along with some new and exciting features.
-
Budgie 10.10 Scheduled for Q1 2025 with a Surprising Desktop Update
If Budgie is your desktop environment of choice, 2025 is going to be a great year for you.
-
Firefox 134 Offers Improvements for Linux Version
Fans of Linux and Firefox rejoice, as there's a new version available that includes some handy updates.
-
Serpent OS Arrives with a New Alpha Release
After months of silence, Ikey Doherty has released a new alpha for his Serpent OS.
-
HashiCorp Cofounder Unveils Ghostty, a Linux Terminal App
Ghostty is a new Linux terminal app that's fast, feature-rich, and offers a platform-native GUI while remaining cross-platform.
-
Fedora Asahi Remix 41 Available for Apple Silicon
If you have an Apple Silicon Mac and you're hoping to install Fedora, you're in luck because the latest release supports the M1 and M2 chips.