Skip to content
I-am-PUID-0 edited this page Jun 27, 2024 · 1 revision

Note

🚧 This page is a Work In Progress. Please check back later for updates.

Getting started with rclone

Rclone is configured automatically by DMB and ready to run out of the box. However, there are a few things you can set up manually to suit your needs.

Accessing the rclone user interface

While Rclone does have a user interface, it is not configured for use within DMB.

Setting up rclone additional features

Under Contruction - Please check back later for updates.

DMB Features for rclone

Bind-mounts rclone to the host:

Two options exist for utilizing rclone mounts with docker: volumes and bind-mounts. \

While both have advantages and disadvantages, bind-mounts are utilized with DMB to allow for additional functionality, such as defining the mount location or utilizing SMB or other network shares.

To learn more about volumes and bind-mounts, see the docker docs

rclone config automatically generated:

The typical initial configuration for rclone requires a multi-step process to create the rclone.config file.

The rclone.config takes the form below once the configuration is completed.

[mount name]
type = webdav
url = http://localhost:9999/dav
vendor = other
pacer_min_sleep = 0

With DMB, the rclone.config is automatically generated during the container's startup, allowing for quickly altering the rclone mount name and Debrid API Key.

rclone flags passed via docker environment variable:

"Every option in rclone can have its default set by environment variable.

To find the name of the environment variable, first, take the long option name, strip the leading --, change - to _, make upper case and prepend RCLONE_."

Passing rclone flags via the docker environment variables alleviates the need to modify the CLI command for rclone.

To learn more about rclone environment variables, see the rclone docs

Rclone NFS server

The rclone process can serve the Zurg WebDAV as a Network File System.

See the rclone docs for more information.

To enable, set NFS_ENABLED=true Optionally, you can define the port utilized with NFS_PORT=; otherwise, the port will be randomly generated between port numbers 8000-8999