Skip to content

rclone

rclone endpoints

For rclone, the LUMI-O configuration provides two kinds of remote endpoints:

  • lumi-<project_number>-private: A private endpoint. The buckets and objects uploaded to this endpoint will not be publicly accessible.
  • lumi-<project_number>-public: A public endpoint. The buckets and objects uploaded to this endpoint will be publicly accessible using the URL:
    https://<project_number>.lumidata.eu/<bucket_name>`
    
    Be careful to not upload data that cannot be public to this endpoint.

The basic syntax of the rclone command is:

rclone <subcommand> <options> source:path dest:path 

The table below lists the most frequently used rclone subcommands:

rclone subcommand Description
copy Copy files from the source to the destination
sync Make the source and destination identical, modifying only the destination
move Move files from the source to the destination
delete Remove the contents of a path
mkdir Create the path if it does not already exist
rmdir Remove the path
check Check if the files in the source and destination match
ls List all objects in the path, including size and path
lsd List all directories/containers/buckets in the path
lsl List all objects in the path, including size, modification time and path
lsf List the objects using the virtual directory structure based on the object names

A more extensive list can be found on the Rclone manual pages or by typing the command rclone in LUMI.

rclone config files

The rclone config files are created in ~/.config/rclone/rclone.conf . By setting a file called rclone.conf in this path with the correct configuration setting and valid access keys, it is possible to use rclone to access LUMI-O from anywhere across internet. Connection to LUMI is not needed.

Example: Create rclone config file to connect to LUMI-O

You can get a valid rclone configuration from auth.lumidata.eu.

1) Create a key for your project

2) Click the key

3) Select rclone from the Configuration templates and click Generate

4) Copy the created text block to a file that you name 'rclone.conf', and place it in the correct path ~/.config/rclone/rclone.conf

5) Now, if you have rclone installed, you can access LUMI-O with rclone. Type e.g.

rclone lsd lumi-465000XXX-private:
to see the content of project 465000XXX in LUMI-O.

If you don't have rclone installed, follow the directions on rclone website to install rclone e.g. on your local machine.

The connection with this rclone config-file works as long as your access key is valid. You can extend the validity of the key in auth.lumidata.eu You can also create a new key and a new config file for it, if the key expires.