Managing Object Storage using Rclone

            Rclone is a free, open source command line utility to sync files and directories to and from cloud storage. It supports several cloud storage providers, and client side encryption. Rclone can be used with most operating systems, including Windows, Linux and macOS.

            In this guide we will show you how to configure Rclone for use with your account  on the Arctic Cloud. This is not a guide for the general usage of Rclone. For that we refer you to its website and the list of commands here.

            Installation

            Rclone can be downloaded and installed manually from https://rclone.org/downloads/.

            On Linux/macOS/BSD systems you can also install it by running the command
            1. $ curl https://rclone.org/install.sh | sudo bash

            Configuration

            To configure run the following command (same for all platforms)
            1. $ rclone config
            2. No remotes found - make a new one
            3. n) New remote
            4. r) Rename remote
            5. c) Copy remote
            6. s) Set configuration password
            7. q) Quit config
            Press n and enter to add a new remote destination
            1. n/r/c/s/q> n
            2. name>
            Enter a name for this remote destination. You will have to write this name as the destination when copying and syncing files, so it's best to choose a relatively short name. Let's choose "cloud".
            1. name> cloud
            2. Type of storage to configure.
            3. Choose a number from below, or type in your own value
            4. [...]
            Choose 11 for OpenStack Swift
            1. Storage> 11
            2. User name to log in.
            3. user>
            Choose root as the user
            1. user> root
            2. API key or password.
            3. key>
            Enter the password for your Arctic Cloud root user
            1. key> **********************
            2. Authentication URL for server.
            3. Choose a number from below, or type in your own value
            4. [...]
            5. auth>
            Do not choose a number for auth. Instead type in the following: https://os-api.arcticcloud.com:5000/v3
            1. auth> https://os-api.arcticcloud.com:5000/v3
            2. User domain - optional (v3 auth)
            3. domain>
            For domain, enter the e-mail address which you used to register on the Arctic Cloud
            1. domain> user@domain.com
            2. Tenant name - optional for v1 auth, required otherwise
            3. tenant>
            For tenant, enter the exact same e-mail address
            1. tenant> user@domain.com
            2. Tenant domain - optional (v3 auth)
            3. tenant_domain>
            Leave the tenant_domain empty
            1. tenant_domain>
            2. Region name - optional
            3. region>
            For region, enter "RegionOne"
            1. region> RegionOne
            2. Storage URL - optional
            3. storage_url>
            Leave the storage_url empty
            1. storage_url>
            2. AuthVersion - optional - set to (1,2,3) if your auth URL has no version
            3. auth_version>
            The auth_version should be set to 3
            1. auth_version> 3
            2. Remote config
            3. --------------------
            4. [cloud]
            5. user = root
            6. key = ********************
            7. auth = https://os-api.arcticcloud.com:5000/v3
            8. domain = user@domain.com
            9. tenant = user@domain.com
            10. tenant_domain =
            11. region = RegionOne
            12. storage_url =
            13. auth_version = 3
            14. --------------------
            15. y) Yes this is OK
            16. e) Edit this remote
            17. d) Delete this remote
            18. y/e/d>
            Enter y to confirm the configuration
            1. y/e/d> y
            2. Current remotes:
            3. Name                 Type
            4. ====                 ====
            5. cloud                swift
            6. [...]
            7. e/n/d/r/c/s/q>
            Enter q to exit configuration
            At the moment the password for your Arctic Cloud user is stored in plain text in the rclone configuration file. We recommend that you password protect your configuration file.

            Run rclone config, then type s to set a configuration password
            1. $ rclone config
            2. Current remotes:
            3. Name                 Type
            4. ====                 ====
            5. cloud                swift
            6. [...]
            7. e/n/d/r/c/s/q> s
            8. Your configuration is not encrypted.
            9. If you add a password, you will protect your login information to cloud services.
            10. a) Add Password
            11. q) Quit to main menu
            12. a/q>
            Enter "a" to add a password, then enter a password and confirm it
            1. a/q> a
            2. Enter NEW configuration password:
            3. password:
            4. Confirm NEW configuration password:
            5. password:
            6. Password set
            7. Your configuration is encrypted.
            8. c) Change Password
            9. u) Unencrypt configuration
            10. q) Quit to main menu
            11. c/u/q>
            Enter q to quit to main menu, then q again to exit configuration. From now on you will be required to provide the password every time you run rclone.

            First create a normal container/bucket using the following command
            1. $ rclone mkdir cloud:encrypted
            Here we've created a container called "encrypted". You can of course call it what you want. The next thing we will do is create an encrypted remote destination pointing to the new container.

            1. $ rclone config
            2. Enter configuration password:
            3. password:
            4. Current remotes:
            5. Name                 Type
            6. ====                 ====
            7. cloud                swift
            8. [...]
            9. e/n/d/r/c/s/q> n
            10. name>
            We ran the "rclone config" command, entered the configuration password and used n to create a new remote. Enter a name for this remote, for example "crypt".
            1. name> crypt
            2. Type of storage to configure.
            3. Choose a number from below, or type in your own value
            4. [...]
            5. 5 / Encrypt/Decrypt a remote
            6. [...]
            7. Storage>
            Enter the number 5 to encrypt a remote
            1. Storage> 5
            2. Remote to encrypt/decrypt.
            3. Normally should contain a ':' and a path, eg "myremote:path/to/dir",
            4. "myremote:bucket" or maybe "myremote:" (not recommended).
            5. remote>
            For remote enter the path to the container we created in the first step. We used the name "encrypted", so we enter "cloud:encrypted".
            1. remote> cloud:encrypted
            2. How to encrypt the filenames.
            3. Choose a number from below, or type in your own value
            4. 1 / Don't encrypt the file names.  Adds a ".bin" extension only.
            5.    \ "off"
            6. 2 / Encrypt the filenames see the docs for the details.
            7.    \ "standard"
            8. filename_encryption>
            If you want to encrypt the file names, press 2, otherwise choose 1.
            1. filename_encryption> 2
            2. Password or pass phrase for encryption.
            3. y) Yes type in my own password
            4. g) Generate random password
            5. y/g>
            Here you are offered the option to generate a random password, or to type in your own password. We choose the latter.
            1. y/g> y
            2. Enter the password:
            3. password:
            Enter a password, then confirm it.
            1. Enter the password:
            2. password:
            3. Confirm the password:
            4. password:
            5. Password or pass phrase for salt. Optional but recommended.
            6. Should be different to the previous password.
            7. y) Yes type in my own password
            8. g) Generate random password
            9. n) No leave this optional password blank
            10. y/g/n>
            If you want you can add an additional password to use as a cryptographic salt. This makes it even harder to crack your password since rainbow table attacks will be infeasible.
            1. y/g/n> y
            2. Enter the password:
            3. password:
            4. Confirm the password:
            5. password:
            6. Remote config
            7. --------------------
            8. [crypt]
            9. remote = cloud:encrypted
            10. filename_encryption = standard
            11. password = *** ENCRYPTED ***
            12. password2 = *** ENCRYPTED ***
            13. --------------------
            14. y) Yes this is OK
            15. e) Edit this remote
            16. d) Delete this remote
            17. y/e/d>
            Enter y to confirm, then q to quit configuration.

            Now you are ready to use Rclone. See the list of available commands here.
            Updated: 04 Mar 2019 04:07 PM
            Helpful?  
            Help us to make this article better
            0 0