https://github.com/tobiasmcvey/rclonesetup
How to setup and mount rclone remote drives on boot using Linux and Mac
https://github.com/tobiasmcvey/rclonesetup
boot launchd osxfuse rclone shell
Last synced: 10 months ago
JSON representation
How to setup and mount rclone remote drives on boot using Linux and Mac
- Host: GitHub
- URL: https://github.com/tobiasmcvey/rclonesetup
- Owner: tobiasmcvey
- License: mit
- Created: 2021-02-21T12:13:40.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-02-23T21:23:12.000Z (over 5 years ago)
- Last Synced: 2025-04-09T04:11:16.792Z (about 1 year ago)
- Topics: boot, launchd, osxfuse, rclone, shell
- Language: Shell
- Homepage:
- Size: 15.6 KB
- Stars: 39
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **Rclone setup**
Rclone is a tool for mounting remote drives. It allows us to move files and make backups with schedules and specific rules on which folders to sync.
Read more at [rclone.org](https://rclone.org/)
- [**Rclone setup**](#rclone-setup)
- [**Mac OSX Prerequisite: Install OSXFuse**](#mac-osx-prerequisite-install-osxfuse)
- [**Install Rclone**](#install-rclone)
- [**Optional: Get private credentials**](#optional-get-private-credentials)
- [**Configure remote**](#configure-remote)
- [**Mount remote manually**](#mount-remote-manually)
- [**Mount remote on boot**](#mount-remote-on-boot)
- [**On Linux**](#on-linux)
- [**On Mac OSX**](#on-mac-osx)
- [**How to unmount remotes**](#how-to-unmount-remotes)
- [**On Linux**](#on-linux-1)
- [**On Mac OSX**](#on-mac-osx-1)
## **Mac OSX Prerequisite: Install OSXFuse**
Only required for setup on Mac.
Get OSXFuse at [osxfuse.github.io](https://osxfuse.github.io/)
## **Install Rclone**
Check latest install instructions at [rclone.org](https://rclone.org/downloads/)
```bash
curl https://rclone.org/install.sh | sudo bash
```
## **Optional: Get private credentials**
You can use your own credentials if you don't want to be rate limited. These credentials need to be stored locally for rclone to read. Otherwise you will use the shared credentials at the official rclone project.
For Google drive, follow [this guide](https://rclone.org/drive/#service-account-support)
For Microsoft onedrive, follow [this guide](https://rclone.org/onedrive/#getting-your-own-client-id-and-key)
## **Configure remote**
We use the same command to create a new remote, edit existing remotes and remove them.
```bash
rclone config
```
Verify you have access to your drive.
**Verifying access to Google Drive**
```bash
rclone -v --drive-impersonate foo@example.com lsf gdrive:backup
```
## **Mount remote manually**
Mounting a drive is quite straightforward. Please read up on the flags.
```bash
rclone mount remote:path /path/to/mountpoint [flags]
# example: mount local folder gdrive to remote private_drive
# rclone mount private_gdrive: gdrive
```
## **Mount remote on boot**
### **On Linux**
I used cron to mount the remote drives on boot but you can also use systemd.
```bash
# restart rclone mount for google drive on reboot
@reboot /home/username/projects/rclonesetup/mountrclone.sh
```
### **On Mac OSX**
I couldn't make cron load this on boot on a Mac, but launchd works. Here's how to set it up to launch silently on user login.
Check out [launchd.info](https://launchd.info/) for an introduction.
I chose to make a shell script also so I can easily add and remove drives.
Create a `plist` file for the launchd job, then add it with `launchctl`.
I chose to make this a Launch Agent for the *specific logged in user* instead of a system task because the files and remote drive probably belong to a specific person and not all users on the same machine.
Here's an example shell script to silently mount a drive as a daemon:
```bash
#!/bin/zsh
# run rclone as a daemon to silently mount drives without launching terminal on login
rclone mount --daemon remotename:path localpath
```
Make the script executable with `chmod +x script.sh`
Here's a template for launching a shell script with launchd on login:
```xml
EnvironmentVariables
PATH
addpath
Label
com.mountrclone
Program
pathtoshellscript.sh
RunAtLoad
StandardOutPath
pathto/rclonesetup/out.log
StandardErrorPath
pathto/error.log
```
These files should follow a naming convention to be the same name as the task. Look at existing tasks for some examples. Here are some of mine:
```
com.cisco.proximity.plist
```
Add this file to your user's library path, which should look like this `/Users/username/Library/LaunchAgents`
If you want to make this a system task then you need to use the System folder instead.
Then add the job:
```bash
# permanently load job for logged in user launch agents
launchctl load -w ~/Library/LaunchAgents/com.mountrclone.plist
# permanently unload job
launchctl unload -w ~/Library/LaunchAgents/com.mountrclone.plist
```
If there's a problem with the job then there should be an error command when attempting to load it.
Try to reboot, login and check if the drive was mounted.
## **How to unmount remotes**
### **On Linux**
```bash
sudo umount
# for example, to unmount /dev/sdc1
# sudo umount /dev/sdc1
```
### **On Mac OSX**
Use OSXFuse to unmount drives.
```bash
umount drivename
# example: unmount drive called gdrive
# umount gdrive
```