Step by step Rclone Setup for CloudStor file upload

To setup Rclone to connect to the TERN CloudStor instance, the following settings are required:

Your CloudStor App credentials

App passwords give you greater control over the devices and apps that access your CloudStor account and allows for per-device/per-application passwords and lockouts. For this reason it is best to use an App passwords when setting up Rclone.

To create an App password:

Log into your account at https://cloudstor.aarnet.edu.au and then click on "Settings" in the top right corner of the interface (Step 1). Once in Settings you will see a menu on the left, click "Security" (Step 2) and you will see a section called App passwords.

App passwords simply require an "App name" this can be anything that helps you later identify the password in the future, for example "My iPhone". Fill in an "App name" and click "Create new app password". You will then be presented with a username and password/token (Step 3). Your username will most probably be your email address and the password/token with be a randomly generated token. Please store this token in your password manager or keep it in a safe place for you to use. When you click "Done" you will never be able to see this password/token again.

Once the App password is created you will see it in the list of App passwords. You can also see when that password was last used as well as delete the App password.

Multiple App passwords can be setup for different purposes, if you forget to save the token, or do not remember what it was, the token can be deleted and a new token can be setup.

RCLONE

Installation

Follow instructions for installation. https://rclone.org/downloads/
After downloading, extract the zip file. The extracted directory will have the rclone executable file.
in this instruction the extracted path was C:\temp\rclone-v1.53.1-windows-amd64 on Windows.

Setup

Rclone requires some setting up in order to communicate with CloudStor.

  1. Open a Command window (Windows) or Terminal (Mac and linux)

  2. Change the directory to the extracted path, in this case C:\temp\rclone-v1.53.1-windows-amd64

  3. Run rclone config from this directory as described below

Rlone will as a set of questions, the items in bold text are the settings to connect to Cloudstor.
This is an example for v1.53.1 and the option may change in future updates.

Steps:

  1. C:\temp\rclone-v1.53.1-windows-amd64>rclone config

    1 2 3 4 No remotes found - make a new one n) New remote s) Set configuration password q) Quit config
  2. n/s/q> n

  3. name> my-cloudstor-name
    NOTE: my-cloudstor-name is a name for the connection. We suggest cloudstor or TERNcloudstor

    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / 1Fichier \ "fichier" 2 / Alias for an existing remote \ "alias" 3 / Amazon Drive \ "amazon cloud drive" 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc) \ "s3" 5 / Backblaze B2 \ "b2" 6 / Box \ "box" 7 / Cache a remote \ "cache" 8 / Citrix Sharefile \ "sharefile" 9 / Dropbox \ "dropbox" 10 / Encrypt/Decrypt a remote \ "crypt" 11 / FTP Connection \ "ftp" 12 / Google Cloud Storage (this is not Google Drive) \ "google cloud storage" 13 / Google Drive \ "drive" 14 / Google Photos \ "google photos" 15 / Hubic \ "hubic" 16 / In memory object storage system. \ "memory" 17 / Jottacloud \ "jottacloud" 18 / Koofr \ "koofr" 19 / Local Disk \ "local" 20 / Mail.ru Cloud \ "mailru" 21 / Mega \ "mega" 22 / Microsoft Azure Blob Storage \ "azureblob" 23 / Microsoft OneDrive \ "onedrive" 24 / OpenDrive \ "opendrive" 25 / OpenStack Swift (Rackspace Cloud Files, Memset Memstore, OVH) \ "swift" 26 / Pcloud \ "pcloud" 27 / Put.io \ "putio" 28 / QingCloud Object Storage \ "qingstor" 29 / SSH/SFTP Connection \ "sftp" 30 / Sugarsync \ "sugarsync" 31 / Tardigrade Decentralized Cloud Storage \ "tardigrade" 32 / Transparently chunk/split large files \ "chunker" 33 / Union merges the contents of several upstream fs \ "union" 34 / Webdav \ "webdav" 35 / Yandex Disk \ "yandex" 36 / http Connection \ "http" 37 / premiumize.me \ "premiumizeme" 38 / seafile \ "seafile"
  4. Storage> 34

    1 2 3 4 5 6 7 ** See help for webdav backend at: https://rclone.org/webdav/ ** URL of http host to connect to Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Connect to example.com \ "https://example.com"
  5. url> https://cloudstor.aarnet.edu.au/plus/remote.php/webdav/

    1 2 3 4 5 6 7 8 9 10 11 Name of the Webdav site/service/software you are using Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Nextcloud \ "nextcloud" 2 / Owncloud \ "owncloud" 3 / Sharepoint \ "sharepoint" 4 / Other site/service or software \ "other"
  6. vendor> 2

    1 2 User name Enter a string value. Press Enter for the default ("").
  7. user> your-email-will-show
    This is the email setup with the App password

    1 2 3 4 Password. y) Yes type in my own password g) Generate random password n) No leave this optional password blank (default)
  8. y/g/n>y

    1 Enter the password:
  9. password: app-password-or-token

    1 Confirm the password:
  10. password: app-password-or-token

    1 2 Bearer token instead of user/pass (eg a Macaroon) Enter a string value. Press Enter for the default ("").
  11. bearer_token> <<LEAVE BLANK, press enter key>>

    1 2 3 Edit advanced config? (y/n) y) Yes n) No (default)
  12. y/n> n

    1 2 3 4 5 6 7 8 9 10 11 12 Remote config -------------------- [my-cloudstor-name] type = webdav url = https://cloudstor.aarnet.edu.au/plus/remote.php/webdav/ vendor = owncloud user = your-email-will-show pass = *** ENCRYPTED *** -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote
  13. y/e/d> y

    1 2 3 4 5 6 7 8 9 10 11 12 13 14 Current remotes: Name Type ==== ==== my-cloudstor-name webdav e) Edit existing remote n) New remote d) Delete remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config e/n/d/r/c/s/q>
  14. e/n/d/r/c/s/q> q

Rclone has now been setup and can be used as described in https://ternaus.atlassian.net/wiki/spaces/TERNSup/pages/1344340027/Rclone+file+upload+to+Cloudstor