Rclone mount add-on

The Rclone mount add-on mounts files stored in a cloud storage account into your Nuvolos application using the Rclone utility.

Rclone is a command-line utility for managing and syncing files and directories between various cloud storage providers, as well as local filesystems. It supports a wide range of cloud storage services such as Google Drive, Dropbox, Amazon S3, Microsoft OneDrive, and many others.

Prerequisites

Before adding a Rclone mount add-on to your application, a Rclone remote must be configured.

You can configure a Rclone remote either via the command line in a terminal inside a Nuvolos application, or using the Rclone GUI Nuvolos application.

Rclone stores configuration files in the Personal area of your Nuvolos instance, so the configured remote will be only visible to your user. If other users wish to use the same Nuvolos application with a Rclone mount add-on configured, they will also need to configure a Rclone remote.

Use existing configuration file

If you have already configured Rclone on another machine, you can migrate your existing configuration file to Nuvolos:

  1. Upload the configuration file to Nuvolos

  2. Copy it to ~/.config/rclone/rclone.conf in your instance

The Nuvolos addon uses Rclone v1.62.2, make sure to only use remotes compatible with this version.

Command line configuration on Nuvolos

To configure a remote via the command line on Nuvolos, we recommend using a terminal in a JupyterLab application. You can install the Rclone utility with the following command:

mamba install -y -c conda-forge rclone

Once Rclone is installed in your application, you can configure a remote with the rclone configure command. Please refer to the Rclone documentation on how to configure the remote service of your choice.

Configuration using the Rclone GUI Nuvolos application

Please add a Rclone GUI Nuvolos application to your working instance, which is available under the Data Operations category:

Start the application, and click on the Login button to navigate to the Rclone dashboard. No username or password is required:

Click on Configs and Create a New Config to create a new config. Give a name to your remote configuration and select the cloud storage provider of your choice, then proceed with the configuration options displayed.

Please note that the Rclone GUI does not support all configuration options available in the rclone command line utility.

Using the configuration

Once your Rclone remote has been configured, you can add the Rclone mount add-on to your application in the application configuration:

Start / restart your application and if the remote was successfully configured, you will be able to access the files stored in your cloud storage account under the /rclone path in your Nuvolos application.

If there are multiple remotes defined in the Rclone configuration file, only the first remote will be mounted under the /rclone path.

Configuration walkthroughs

We have examples for some of the most common remote types:

Last updated