Rclone - Bytesized Hosting Wiki

Rclone - Managing cloud storage

This wiki is to serve as a reference for using rclone. Rclone setup and running requires certain level of knowledge.

Bytesized Hosting does not provide support or will help debugging issues caused by rclone. See this news item for more details on why that is the case.

Manual installation

It's possible to upload and download files from other cloud based services, such as Google Drive, Amazon Cloud Drive etc. with the rClone command line tool.

rClone is installed by default on all Appboxes, with a version update every 7 days.

This is a short and sweet cheat-sheet to get started, for all information please refer to the official rClone documentation.

Getting started

To get started first create a config file.

# rclone config
No remotes found - make a new one
n) New remote
s) Set configuration password
q) Quit config
n/s/q>

By selecting "n" here you can add a new cloud service to the rClone configuration.

n/s/q> n
name> drive
Type of storage to configure.
Choose a number from below, or type in your own value
 1 / Amazon Drive
   \ "amazon cloud drive"
 2 / Amazon S3 (also Dreamhost, Ceph, Minio)
   \ "s3"
 3 / Backblaze B2
   \ "b2"
 4 / Dropbox
   \ "dropbox"
 5 / Encrypt/Decrypt a remote
   \ "crypt"
 6 / Google Cloud Storage (this is not Google Drive)
   \ "google cloud storage"
 7 / Google Drive
   \ "drive"
 8 / Hubic
   \ "hubic"
 9 / Local Disk
   \ "local"
10 / Microsoft OneDrive
   \ "onedrive"
11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
   \ "swift"
12 / Yandex Disk
   \ "yandex"
Storage> 7
Google Application Client Id - leave blank normally.
client_id>
Google Application Client Secret - leave blank normally.
client_secret>
Remote config
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine or Y didn't work
y) Yes
n) No
y/n> n
If your browser doesn't open automatically go to the following link: https://accounts.google.com/o/oauth2/auth?client_id=xxx.apps.googleusercontent.com&redirect_uri=urn%3Aietf%3Awg%3Aoauth%3A2.0%3Aoob&response_type=code&scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fdrive&state=xxx
Log in and authorize rclone for access
Enter verification code>

I selected "7" to add a google drive account to my rClone configuration and I opened the given link in my local browser. It will redirect you to a Google login form where you can login with your Google details. Once done you should get a verification code that you paste back to rClone.

--------------------
[drive]
client_id =
client_secret =
token = {"access_token":"xxx","token_type":"Bearer","refresh_token":"xxxx","expiry":"2016-11-07T15:37:22.309819497+01:00"}
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d>y

Once that's done you should have a working connection to Google Drive. You can test this by requesting a list of all your files. rclone ls drive:/ if that's working it should now list all your files.

Mounting (experimental)

Rclone mounting is an experimental feature, so use it with care.

To mount the remote path to your box:

rclone mount --allow-other REMOTE_PATH LOCAL_PATH &

For more information please check out the excellent rClone documentation.

NOTE: DO NOT MOUNT RCLONE ON YOUR HOME DIRECTORY.