Rclone

Overview

Rclone is a command line program to manage files on cloud storage. It is a feature rich alternative to cloud vendors' web storage interfaces. This is what is used to mount your Debrid cloud storage to your server. It is a very powerful tool and can be used to sync files, copy files, mount drives, and much more.

What you'll learn

• How to install Rclone on your server
• How to configure Rclone
• How to mount your Debrid cloud storage to your server

Prerequisites

Setup

We need to setup rclone cache folder and mount folder:

mkdir -p /mnt/cache /mnt/zurg

Installation

Baremetal rclone

Install rclone

sudo -v ; curl https://rclone.org/install.sh | sudo bash

rclone config file

It will output something like this:

$ rclone config file
Configuration file is stored at:
/home/ubuntu/.config/rclone/rclone.conf

Configure rclone

Open the file in your favorite text editor:

nano ~/.config/rclone/rclone.conf

Paste the zurg webdav and http remote configurations in the file:

[zurg]
type = webdav
url = http://localhost:9999/dav/
vendor = other
pacer_min_sleep = 0
 
[zurghttp]
type = http
url = http://localhost:9999/http/
no_head = false
no_slash = false

Setup dependencies

Make sure you have fuse3 installed:

sudo apt install fuse3

Edit the fuse configuration file:

sudo nano /etc/fuse.conf

Uncomment the following line:

# user_allow_other

Running rclone

Now we need to make a service file which will mount the remote:

sudo nano /etc/systemd/system/realdebrid.service

Paste the following in the file:

[Unit]
Description=Rclone Mount Service
After=network.target
 
[Service]
Type=simple
ExecStart=/usr/bin/rclone mount zurg: /mnt/zurg --allow-other --async-read --allow-non-empty --dir-cache-time=5s --buffer-size=64M --poll-interval=15s --use-mmap --vfs-read-ahead=128M --vfs-read-chunk-size=64M --vfs-read-chunk-size-limit=2048M --vfs-cache-max-age=48h --vfs-cache-mode=full --vfs-cache-poll-interval=30s --vfs-cache-max-size=70G --cache-dir=/mnt/cache --uid=1000 --gid=1000
ExecStop=/bin/fusermount -u /mnt/zurg
Restart=on-failure
RestartSec=10
User=YOUR_USERNAME
Group=YOUR_USERNAME
 
[Install]
WantedBy=default.target

Edit the ExecStart to your preference & User and Group fields with your username.

If required, you can change the ExecStart options as per your requirements. For example:

• --vfs-cache-max-size=70G - Maximum size of the cache
• --cache-dir=/mnt/cache - Cache directory
• --vfs-cache-max-age=48h - Max age of objects in the cache
• --uid=1000 --gid=1000 - User and group id. Default should be good for most users

Reload the systemd daemon:

sudo systemctl daemon-reload

Start the service:

sudo systemctl start realdebrid

Verify the service is running:

sudo systemctl status realdebrid

And voila! Your Debrid cloud storage is now mounted to your server. You can verify it by running ls /mnt/zurg. You should see some files and folders related to your Debrid service.

Docker rclone

For zurg users

For zurg users, you can follow the github instruction on zurg repository. The compose files comes with rclone and zurg pre-configured.

For other debrid services

For other debrid services, you can use the following docker-compose file:

services:
    service-name:
        image: rclone/rclone:latest
        container_name: service-name
        restart: unless-stopped
        environment:
            TZ: Asia/Kolkata
        volumes:
            - /mnt/destination:/data:rshared
            - /mnt/cache:/mnt/cache
            - ./rclone.conf:/config/rclone/rclone.conf
        cap_add:
            - SYS_ADMIN
        security_opt:
            - apparmor:unconfined
        devices:
            - /dev/fuse:/dev/fuse:rwm
        command: "mount name: /data --allow-other --async-read --allow-non-empty --dir-cache-time=5s --buffer-size=64M --poll-interval=15s --use-mmap --vfs-read-ahead=128M --vfs-read-chunk-size=64M --vfs-read-chunk-size-limit=2048M --vfs-cache-max-age=48h --vfs-cache-mode=full --vfs-cache-poll-interval=30s --vfs-cache-max-size=10G --cache-dir=/mnt/cache --umask=002 --uid=1000 --gid=1000"

Make sure to replace name: with your remote name specified in the rclone.conf file, service-name with your desired container name and /mnt/destination with the path where you want to mount the remote.

If required you can change the command options as per your requirements. For example:

• --vfs-cache-max-size=10G - Maximum size of the cache
• --cache-dir=/mnt/cache - Cache directory
• --vfs-cache-max-age=48h - Max age of objects in the cache
• --uid=1000 --gid=1000 - User and group id. Default should be good for most users

How do i setup rclone.conf?

One way is to run rclone config on host and then create a new remote. Follow the instructions and set it up. Then copy the remote config to the rclone.conf file in the same directory as docker-compose.yml.

Another way is to see the rclone documentation for the remote you want to setup. They have examples for most of the remotes.

Examples of remotes:

1. Webdav remote

[webdav]
type = webdav
url = webdav_url
vendor = other
user = webdav_user
pass = webdav_password

2. All-Debrid webdav remote guide

3. FTPS remote (ultra.cc)

[ultra]
type = ftp
host = host_name
user = username
pass = password___rclone_encrypts_it_by_default
explicit_tls = true
no_check_certificate = true