Skip to content

Commit d632c54

Browse files
authored
Update rclone.md
Corrections for typos, grammar, style. Some minor clarifications.
1 parent 455be62 commit d632c54

File tree

1 file changed

+41
-36
lines changed
  • mkdocs-project-dir/docs/Walkthroughs

1 file changed

+41
-36
lines changed

mkdocs-project-dir/docs/Walkthroughs/rclone.md

Lines changed: 41 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,57 @@
11
# Rclone
22

3-
[Rclone](https://rclone.org/) is a command-line program to manage files on cloud storage. This is a walkthrough for
3+
[**Rclone**](https://rclone.org/) is a command-line program to manage files on cloud storage. This is a walkthrough for
44
configuring **Rclone** to be used with Microsoft OneDrive but it also can be used with several other cloud systems like
55
Dropbox, Google Drive, etc.
66

77
We have installed 2 versions of rclone in our clusters. ```rclone/1.61.0``` was used as reference for this walkthrough
8-
but the process is similar with other versions.
8+
but the process is similar with other versions. Generally, you should use the highest-numbered version.
99

1010
After loading the module with the command:
1111

1212
```
13-
module load rclone/1.61.0 ,
13+
module load rclone/1.61.0
1414
```
1515

16-
the next step is to configure **RClone**. As the cloud systems usually have quite complicated authentication methods,
16+
the next step is to configure **Rclone**. As the cloud systems usually have quite complicated authentication methods,
1717
these are kept in a config file. For example, the configuration file for **OneDrive** and **Dropbox** involve getting
1818
a **token** from **Microsoft** and **Dropbox** respectively, to link your account in the cloud system with **Rclone**.
1919
There are several ways to get this token and here is presented the easiest. If this method does not work for you, please
20-
contact our support: [[email protected]]
20+
contact our support: [[email protected]](mailto:[email protected])
2121

22-
The method that allows an automatic way to get and add the token to the configuration file requires to uses
23-
[X-Forwarding](https://www.rc.ucl.ac.uk/docs/Supplementary/X-Forwarding/ )
24-
in your ssh connection. This will allow to the cluster to push an interactive window to your local computer over a network.
22+
The method that allows an automatic way to get and add the token to the configuration file requires using
23+
[X-Forwarding](../Supplementary/X-Forwarding.md)
24+
in your SSH connection. This will allow the cluster to push an interactive browser window to your local computer over a network.
2525
In this window you will enter your credentials and connect to the account you want to link with **Rclone** (e.g. Microsoft
2626
One Drive or Dropbox). If you have activated MFA in your account, it will ask you for the respective code. Note that the
2727
connection to internet could not the best and it might take a while to load the page.
2828

2929
### X-Forwarding in Linux
3030

31-
If you are using linux, the X-Forwarding is very easy. Just add ```-X``` option to your ssh command like this:
31+
If you are using Linux, the X-Forwarding is very easy. Just add `-X` option to your SSH command like this:
3232

3333
```
3434
3535
```
3636
### X-Forwarding in Mac
3737

38-
If you are using Mac, there is an app called ***XQuartz** you must donwload first and then use the ```-Y``` option with the
39-
ssh command to allow X-forwarding.
38+
If you are using Mac, there is an app called ***XQuartz** you must donwload first and then use the `-Y` option with the
39+
`ssh` command to allow X-forwarding.
4040

4141
### X-Forwarding in Windows
4242

43-
If you are using Windows, you need to install an ```X``` server separately. The use **Xming** with ***Putty** is suggested
43+
If you are using Windows, you need to install an X server separately. The use of **Xming** with ***Putty** is suggested
4444
to configure **Rclone**, although you can use your preferred method. You can download **Xming-fonts** free from
4545
[here](https://sourceforge.net/projects/xming/files/). Once you download it and install it, you must open **Xming** in your
46-
computer before connecting to ssh. The application is always working on the background so you will see anything opening after
46+
computer before connecting to ssh. The application is always working on the background so you may not see anything opening after
4747
click on it.
4848

49-
Then, to connect to ssh we suggest to use **Putty** unless you know how to allow the X-forwarding with another method. To
50-
configure **Putty** to use x-Forwarding, you must look at the left side panel and go to ```SSH``` category. Then select ```X11```
51-
and in there tick on ```Enable X11 forwarding``` (the box must be blue). Then enter the details to connect to the cluster in
49+
Then, to connect via SSH we suggest using **Putty** unless you know how to allow X-forwarding with another method. To
50+
configure **Putty** to use X-Forwarding, you must look at the left side panel and go to ++SSH++ category. Then select ++X11++
51+
and ensure the checkbox for ++Enable X11 forwarding++ is checked/filled. Then enter the details to connect to the cluster in
5252
the main window and that's all! If you are loading a previous saved session, then load the session first and then enable the
5353
X-Forwarding.
5454

55-
5655
After you have allowed X-Forwarding, you are ready to configure **Rclone**.
5756

5857
## Rclone and OneDrive
@@ -74,14 +73,14 @@ s) Set configuration password
7473
q) Quit config
7574
n/s/q>
7675
```
77-
Select **n** and press **Enter** Key
76+
Select `n` and press the ++Enter++ key.
7877

7978
2.
8079
```
8180
Enter name for new remote.
8281
name>
8382
```
84-
Enter the **name of your own choose for your remote** connection and press **Enter** key.
83+
Enter a simple text label for your remote connection and press the ++Enter++ key. We've used `UCLDrive` here, and it is easier to correctly use on the command-line if it does not contain spaces.
8584

8685
3. Something similar to this will be displayed. Please check what number corresponds to **Microsoft OneDrive**
8786
option and enter that one.
@@ -153,7 +152,7 @@ Choose a number from below, or type in your own value.
153152
61 / seafile \ (seafile)
154153
Storage>
155154
```
156-
In this case,**Microsoft OneDrive** corresponds to the option **36**, so enter **36** and press **Enter** key.
155+
In this case,**Microsoft OneDrive** corresponds to option 36, so enter `36` and press the ++Enter++ key.
157156

158157
4.
159158
```
@@ -162,7 +161,7 @@ Leave blank normally.
162161
Enter a value. Press Enter to leave empty.
163162
client_id>
164163
```
165-
Press **Enter** key to leave empty.
164+
Press ++Enter++ to leave empty.
166165

167166
5.
168167
```
@@ -171,7 +170,7 @@ Leave blank normally.
171170
Enter a value. Press Enter to leave empty.
172171
client_secret>
173172
```
174-
Press **Enter** key to leave empty.
173+
Press ++Enter++ to leave empty.
175174

176175
6.
177176
```
@@ -185,15 +184,15 @@ Press Enter for the default (global).
185184
4 / Azure and Office 365 operated by Vnet Group in China \ (cn)
186185
region>
187186
```
188-
Select **1** and press **Enter** Key
187+
Select `1` and press the ++Enter++ Key.
189188

190189
```
191190
Option tenant.ID of the service principal's tenant. Also called its directory ID.
192191
Set this if using- Client Credential flowEnter a value.
193192
Press Enter to leave empty.
194193
tenant>
195194
```
196-
Press **Enter** to leave empty
195+
Press ++Enter++ to leave empty.
197196

198197
8.
199198
```
@@ -202,7 +201,7 @@ y) Yes
202201
n) No (default)
203202
y/n>
204203
```
205-
Select **n** and press **Enter** key.
204+
Select `n` and press the ++Enter++ key.
206205

207206
9.
208207
```
@@ -214,10 +213,10 @@ y) Yes (default)
214213
n) No
215214
y/n>
216215
```
217-
Select **y** and press **Enter** key.
216+
Select `y` and press the ++Enter+ key.
218217

219218
**If you have installed Xming and habilitated correctly X-Forwarding in Putty or your preferred method,
220-
then a window will open in your perosnal machine. There, you must log in, in this case into Microsoft using
219+
then a browser window will open on your personal machine. There, you must log in, in this case into Microsoft 365 using
221220
your UCL account (internal).**
222221

223222
10.
@@ -234,18 +233,18 @@ Press Enter for the default (onedrive).
234233
7 | E.g. /teams/hr \ (path
235234
config_type>
236235
```
237-
Select **1** and press **Enter** key.
236+
Select `1` and press the ++Enter++ key.
238237

239238
11.
240239
```
241240
Option config_driveid. Select drive you want to use
242241
Choose a number from below, or type in your own string value.
243-
Press Enter for the default (b!ra4Fi4CqS0GYT_qied1OV9A2pTgX9JxHhfZTS2MwNK-0r_cRHFddS7D8Yt0CozO-).
244-
1 / OneDrive (business) \ (b!ra4Fi4CqS0GYT_qied1OV9A2pTgX9JxHhfZTS2MwNK-0r_cRHFddS7D8Yt0CozO-)
245-
2 / PersonalCacheLibrary (business) \ (b!ra4Fi4CqS0GYT_qied1OV9A2pTgX9JxHhfZTS2MwNK9-7X_uAf71Qavjc1vd7Xis)
242+
Press Enter for the default (b!ra4Fi4CqS0GYT_qied18V9A2pTgX9JxHhfZTS2MwNK-0r_cRHFddS7D8Yt0CozO-).
243+
1 / OneDrive (business) \ (b!ra4Fi4CqS0GYT_qied18V9A2pTgX9JxHhfZTS2MwNK-0r_cRHFddS7D8Yt0CozO-)
244+
2 / PersonalCacheLibrary (business) \ (b!ra4Fi4CqS0GYT_qied1OP9A2pTgX9JxHhfZTS2MwNK9-7X_uAf71Qavjc1vd7Xis)
246245
config_driveid>
247246
```
248-
Select **1** and press **Enter** key.
247+
Select `1` and press the ++Enter++ key.
249248

250249
12.
251250
```
@@ -255,7 +254,7 @@ y) Yes (default)
255254
n) No
256255
y/n>
257256
```
258-
If the ULR is ok, then select **y** and press **Enter** key.
257+
If the URL is ok, then select `y` and press the ++Enter++ key.
259258

260259
13.
261260
```
@@ -271,7 +270,13 @@ Options:
271270
- region: global
272271
- token:{"access_token":"eyJ0eXAiOiJKV1QiLCJub25jZSI6IkxmaXR6d2hKWkVaOGstRlZqZEh
273272
iOHFCUHZGMnFZSE8tQmpORV80d1lQWTQiLCJhbGciOiJSUzI1NiIsIng1dCI6IkNOdjBPSTNSd3FsSEZ
274-
FVm5hb01Bc2hDSDJYRSIsImtpZCI6IkNOdjBPSTNSd3FsSEZFVm5hb01Bc2hDSDJYRSJ9.eyJhdWQiOs iIwMDAwMDAwMy0wMDAwLTAwMDAtYzAwMC0wMDAwMDAwMDAwMDAiLCJpc3MiOiJodHRwczovL3N0cy53a W5kb3dzLm5ldC8xZmFmODhmZS1hOTk4LTRjNWItOTNjOS0yMTBhMTFkOWE1YzIvIiwiaWF0IjoxNzQ1N DIxNzE4LCJuYmYiOjE3NDU0MjE3MTgsImV4cCI6MTc0NTQyNTc4OCwiYWNjdCI6MCwiYWNyIjoiMSIsI mFjcnMiOlsicDEiLCJ1cm46dXNlcjpyZWdpc3RlcnNlY3VyaXR5aW5mbyJdLCJhaW8iOiJBWFFBaS84W kFBQUF1NjJxSG1Cc1YzRk5MaElFWmxwZ3lobjB6WGJzY0hlSGZWajJHdnFEcXhockI1WTl1bXF4Z3hGS UVsZ1k2Q1psRlBqSDd1V0NKbkR0cmNaME9FQjdQcmZtcE1oQjF4L3BENEJGY1RCOVUveEZ4TXlhWFVLZ Wt0VHplcURtUkxYNi9qM1l0em5JazQvaHpzUEpXdjRoY2c9PSIsImFtciI6WyJwd2QiLCJ3aWEiLCJtZ mEiXSwiYXBwX2Rpc3BsYXluYW1lIjoicmNsb25lIiwiYXBwaWQiOiJiMTU2NjVkOS1lZGE2LTQwOTItO DUzOS0wZWVjMzc2YWZkNTkiLCJhcHBpZGFjciI6IjEiLCJmYW1pbHlfbmFtZSI6IkxhYnJhIEF2aWxhI iwiZ2l2ZW5fbmFtZSI6Ik5pY29sZSIsImlkdHlwIjoidXNlciIsImlwYWRkciI6IjE5My42MC4yMzguM TEwIiwibmFtZSI6IkxhYnJhIEF2aWxhLCBOaWNvbGUiLCJvaWQiOiJmOWU4OTBlMS1iZDBhLTQzZjctY jRmNi03NWUyZTY4ODg3OWMiLCJvbnByZW1fc2lkIjoiUy0xLTUtMjEtMjkwMjI2NTYyMS0xMDYzMDI4N jIxLTIzODE1NjE0ODAtOTcwNjUxIiwicGxhdGYiOiI4IiwicHVpZCI6IjEwMDMyMDAxQzNBQjg4MjkiL CJyaCI6IjEuQVFVQV9vaXZINWlwVzB5VHlTRUtFZG1sd2dNQUFBQUFBQUFBd0FBQUFBQUFBQUFGQUY0R kFBLiIsInNjcCI6IkZpbGVzLlJlYWQgRmlsZXMuUmVhZC5BbGwgRmlsZXMuUmVhZFdyaXRlIEZpbGVzL lJlYWRXcml0ZS5BbGwgU2l0ZXMuUmVhZC5BbGwgcHJvZmlsZSBvcGVuaWQgZW1haWwiLCJzaWQiOiIwM DQwOTM1OS03OTQ2LTg5MjItNWU5MC1hMTljZGIyNmRiODgiLCJzdWIiOiJGakhnU21hNjBTSTFZWGk4M k1qMnEtR2RhQi1mS2ZYNTJpSEE3SGJsMUljIiwidGVuYW50X3JlZ2lvbl9zY29wZSI6IkVVIiwidGlkI joiMWZhZjg4ZmUtYTk5OC00YzViLTkzYzktMjEwYTExZDlhNWMyIiwidW5pcXVlX25hbWUiOiJza2d0b mwxQHVjbC5hYy51ayIsInVwbiI6InNrZ3RubDFAdWNsLmFjLnVrIiwidXRpIjoiWE9OQ3hPYW5sazJXV 0tRVnVONHJBQSIsInZlciI6IjEuMCIsIndpZHMiOlsiYjc5ZmJmNGQtM2VmOS00Njg5LTgxNDMtNzZiM Tk0ZTg1NTA5Il0sInhtc19mdGQiOiJOal9Zd1hsRG9pY0tyWnpUaS1wQWZPYjloR1RReEVFbW5ybXRHU kt6ekI0IiwieG1zX2lkcmVsIjoiMSAzMCIsInhtc19zdCI6eyJzdWIiOiJJOTdqOF9WWXljNnNhVkxWQ 1UtN3hIcEI3TVdzYWJ4cW9oNnZnbWttMl9nIn0sInhtc190Y2R0IjoxMzYwODcxMzQ1fQ.F-Ma2iOnL"}
273+
FVm5hb01Bc2hDSDJYRSIsImtpZCI6IkNOdjBPSTNSd3FsSEZFVm5hb01Bc2hDSDJYRSJ9.eyJhdWQiOs
274+
iIwMDAwMDAwMy0wMDAwLTAwMDAtYzAwMC0wMDAwMDAwMDAwMDAiLCJpc3MiOiJodHRwczovL3N0cy53a
275+
mwxQHVjbC5hYy51ayIsInVwbiI6InNrZ3RubDFAdWNsLmFjLnVrIiwidXRpIjoiWE9OQ3hPYW5sazJXV
276+
0tRVnVONHJBQSIsInZlciI6IjEuMCIsIndpZHMiOlsiYjc5ZmJmNGQtM2VmOS00Njg5LTgxNDMtNzZiM
277+
Tk0ZTg1NTA5Il0sInhtc19mdGQiOiJOal9Zd1hsRG9pY0tyWnpUaS1wQWZPYjloR1RReEVFbW5ybXRHU
278+
kt6ekI0IiwieG1zX2lkcmVsIjoiMSAzMCIsInhtc19zdCI6eyJzdWIiOiJJOTdqOF9WWXljNnNhVkxWQ
279+
1UtN3hIcEI3TVdzYWJ4cW9oNnZnbWttMl9nIn0sInhtc190Y2R0IjoxMzYwODcxMzQ1fQ.F-Ma2iOnL"}
275280
- drive_id: b!ra4Fi4CqS0GYT_qied1OV9A2pTgX9JxHhfZTS2MwNK-0r_cRHFddS7D8Yt0CozO-
276281
- drive_type: business
277282
Keep this "UCLDrive" remote?
@@ -280,8 +285,8 @@ e) Edit this remote
280285
d) Delete this remote
281286
y/e/d>
282287
```
283-
If everything is ok., then select **y** and press **Enter** key.
288+
If everything is ok., then select `y` and press the ++Enter++ key.
284289

285290
Now you are ready to use **Rclone**!
286291

287-
If you are new using Rclone, please look [here](https://rclone.org/docs/#basic-syntax) the basic syntax.
292+
If you are new using **Rclone**, please consult the [official basic syntax documentation](https://rclone.org/docs/#basic-syntax).

0 commit comments

Comments
 (0)