Newer
Older
---
languages:
- en
- cs
---
# Rclone
This guide serves for rclone tool configuration. Rclone is the swiss knife for connection to multiple types of storage. However, the following guides are limited only to Object Storage namely S3 service. The following guides are suited for Windows users as well as Linux users. Using rclone tool for S3 enables the creation of the buckets, syncing folders, uploading and downloading files, and much more.
## Downloading and installation of rclone tool
Firstly you need to download and unzip the desired [rclone](https://rclone.org/downloads/) version according to the system you operate.
!!! warning
**We strongly recommend** to use up-to-date versions of rclone tool available at [rclone websites](https://rclone.org/downloads/). Using rclone version from system repositories can cause some errors due to the outdated rclone version. In case of a manual installation into the user profile, see below, you can use for an update following command:
----
### Linux - manual installation into the user profile
We need to unzip the [rclone archive](https://rclone.org/downloads/) after download.
Then we need to copy rclone binary file into the pre-prepared bin folder in the user profile/home.
In the last step, we need to put the path to the rclone binary file into PATH environment variable.
For **persistent presence** of the rclone binary file path in the PATH variable you can add the following line into **.bashrc file**:
Alternatively you can place the rclone binary file into the system path:
In the end, we can make a quick check of PATH variable, whether the desired path is present.
In case you have installed the rclone using the steps above, you can then use the following command to update rclone:<br/>
**```rclone selfupdate```**<br/>
```2022/08/25 11:54:07 NOTICE: Successfully updated rclone from version v1.59.0 to version v1.59.1```
----
### Windows - manual installation in to user profile
Firstly you need to prepare `bin` directory in your user profile, where we will place rclone.exe file. Please prepare the directory in your user profile. You can just put the following command into the file browser:
In the displayed directory you can click right mouse button -> **New** –> **Directory/Folder**. The directory should be named **bin**. Then move the **rclone.exe** file into it. The file **rclone.exe** is present in the unzipped rclone archive, which you downloaded from the [rclone websites](https://rclone.org/downloads/).
In the next step click to **Start (1)** and search for **Edit the system environment variables (2)**.
{ style="display: block; margin: 0 auto" }
Then click at **Environment variables (1)** in the displayed window.
{ style="display: block; margin: 0 auto" }
In the section User variables for **UserXY (1)** you will select the line with variable **Path (2)** and then you will click on the **Edit (3)** button.
{ style="display: block; margin: 0 auto" }
<!-- { width="800" height="600" style="display: block; margin: 0 auto" } -->
You can add the new path by clicking on the **New (1)** button and then you have to insert the path to the pre-prepared **“bin” folder (2)**, see below. The setup is then confirmed by clicking on the **OK (3)** button.
{ style="display: block; margin: 0 auto" }
In the end, you will click **OK** and **Apply**.
In case you have installed the rclone using the steps above, you can then use the following command to update rclone:<br/>
**```rclone selfupdate```**<br/>
```2022/08/25 11:54:07 NOTICE: Successfully updated rclone from version v1.59.0 to version v1.59.1```
## Basic configuration of rclone
Below you can find the guide for the elementary configuration of rclone tool. Below are two guides. First describes configuration using the command line and second guide describes configuration using the graphical user interface.
----
### Rclone configuration using the command line
!!! warning
To be able to configure the rclone tool using this guide **first, you have to download, unzip and install rclone**, the guide can be found in the [first section](#downloading-and-installation-of-rclone-tool).
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
Rclone has a configuration wizard, which will guide you step-by-step through the configuration of your S3 data storage.
???+ note "Command line in Windows and Linux"
**Windows users** need to run **Command Prompt** and then run the command below.
**Linux users** can open the **terminal window** and then run the command below.
rclone config
{ style="display: block; margin: 0 auto" }
From the list of options, we will choose **New remote** via inserting **n** letter. Then we need to type the name of our connection/storage, e.g. `cesnet_s3`. Then we will choose the **Option Storage**, here **Amazon S3 Compliant Storage Providers…**
{ style="display: block; margin: 0 auto" }
In the next step, we need to choose **Option provider**, here **Ceph Object Storage**.
{ style="display: block; margin: 0 auto" }
Then it is necessary to choose how to enter S3 credentials. **Here we choose Enter AWS credentials in the next step**.
{ style="display: block; margin: 0 auto" }
In the next steps we enter our credentials **access_key_id** and **secret_access_key** which we obtained from the administrator or which we generated.
{ style="display: block; margin: 0 auto" }
Then we need to select **Option region**. We will leave **this option empty** and then continue with **Enter**.
{ style="display: block; margin: 0 auto" }
Then we need to insert **Option endpoint** according to the data center, where we have generated the credentials, here for example **s3.cl2.du.cesnet.cz**.
{ style="display: block; margin: 0 auto" }
Next is **Option location_constraint**. We will **leave this option empty** and then continue with **Enter**.
{ style="display: block; margin: 0 auto" }
Next point si **Option acl**, here we can either choose **Owner gets FULL_CONTROLL**, or we can leave this option empty and continue with **Enter**.
{ style="display: block; margin: 0 auto" }
In the next step, we need to choose **Option server_side_encryption**, here we pick the option **None**.
{ style="display: block; margin: 0 auto" }
Then we can choose **Option see_kms_key_id**, here we pick the option **None**.
{ style="display: block; margin: 0 auto" }
In the next step we can choose option **Edit advanced config**, here we choose **No**, option **n**.
{ style="display: block; margin: 0 auto" }
In the last step, we check the configuration and we will confirm it by typing **y** letter.
{ style="display: block; margin: 0 auto" }
----
### Rclone configuration using graphical user interface
!!! warning
To be able to configure the rclone tool using this guide **first, you have to download, unzip and install rclone**, the guide can be found in the [first section](#downloading-and-installation-of-rclone-tool).
Firstly you need to run the GUI. **Windows users** need to open **Command Prompt** and run the command below. **Linux users** need just open the **terminal window** and run the command below.
rclone rcd --rc-web-gui
The next steps are identical for Windows and Linux.
After starting up the graphical interface we click in the left menu on the **Configs (1)** button and then on the **Create a New Config (2)** button.
{ style="display: block; margin: 0 auto" }
In the displayed window, we insert the **connection name** in our example `cesnet_s3cl2` and then we choose the option **Amazon S3 Compliant Storage Providers**.
{ style="display: block; margin: 0 auto" }
In the next step, we need to insert **credentials (1)** which we obtained from the administrator or which we generated. You have to insert **Ceph** into the line denoted **Choose your S3 provider**. Then we need to insert the **S3 endpoint address (2)**. Then we can click **Next**.
{ style="display: block; margin: 0 auto" }
!!! warning
Please be careful during the modification in the **Configs** section. Rclone GUI sometimes **does not save the changes** in the configuration. We strongly recommend to cross-check the **[configuration file](#configuration-file)** after saving.
#### Uploading the data from your local machine
After the configuration, we can start to transfer the data.
In the left menu click on the **Explorer (1)** button. Then select **the name of configuration (2)**, for example `cesnet_s3cl2`. Then you click on the **Open (3)** button. Then there should be a window with the buckets and files from the configured data storage.
{ style="display: block; margin: 0 auto" }
!!! warning
Graphical user interface of rclone **DOES NOT SUPPORT** creation of empty buckets and directories. If you copy your data from the local machine you have to copy the directory with data. Alternatively, you can prepare empty buckets using [command line](#rclone-basic-controls).
If you wish to upload your data then in the displayed window click on **upload icon (1)**. Then you can select the data from your disk or drag and drop them into the window.
{ style="display: block; margin: 0 auto" }
----
### Configuration file
!!! warning
Configuration file can be found in the location described below. In the configuration file are saved the credentials and all selected options.
???+ note "Windows config file"
C:\Users\DedaLebeda\AppData\Roaming\rclone\rclone.conf<br/>
<br/>[cesnet_s3]<br/>
type = s3<br/>
provider = Ceph<br/>
access_key_id = my-access-key<br/>
secret_access_key = my-secret-key<br/>
endpoint = s3.cl2.du.cesnet.cz<br/>
???+ note "Linux config file"
~/.config/rclone/rclone.conf<br/>
<br/>[cesnet_s3]<br/>
type = s3<br/>
provider = Ceph<br/>
access_key_id = my-access-key<br/>
secret_access_key = my-secret-key<br/>
endpoint = s3.cl2.du.cesnet.cz<br/>
acl = private<br/>