|
1 | 1 | ---
|
2 |
| -title: Rclone additional commands |
| 2 | +title: Rclone Commands |
3 | 3 | docId: WayQo-4CZXkITaHiGeQF_
|
4 | 4 | redirects:
|
5 | 5 | - /dcs/how-tos/sync-files-with-rclone/rclone-with-hosted-gateway
|
6 | 6 | metadata:
|
7 |
| - title: Rclone with S3 Compatibility Guide |
8 |
| - description: Step-by-step guide to configure Rclone pointed to Storj's S3 compatible API, providing better upload performance and lower network load. |
| 7 | + title: Rclone Command Guide |
| 8 | + description: Step-by-step guide to use Rclone with common commands. |
9 | 9 | ---
|
10 | 10 |
|
11 | 11 | {% callout type="info" %}
|
12 | 12 | Follow the [Getting Started guide](docId:AsyYcUJFbO1JI8-Tu8tW3) to setup Rclone.
|
13 | 13 | {% /callout %}
|
14 | 14 |
|
15 |
| -The follow are additional commands or options you can consider when using Rclone |
| 15 | +The follow are additional commands and options you can consider when using Rclone. |
16 | 16 |
|
17 |
| -## Configuration password |
| 17 | +## Configuration Password |
18 | 18 |
|
19 |
| -For additional security, you should consider using the `s) Set configuration password` option. It will encrypt the `rclone.conf` configuration file. This way secrets like the [](docId:OXSINcFRuVMBacPvswwNU), the encryption passphrase, and the access grant can't be easily stolen. |
| 19 | +For additional security, you should consider using the `s) Set configuration password` option. It will encrypt the `rclone.conf` configuration file. This way, secrets like the [](docId:OXSINcFRuVMBacPvswwNU), the encryption passphrase, and the access grant can't be easily stolen. |
20 | 20 |
|
21 | 21 | ## Create a Bucket
|
22 | 22 |
|
23 | 23 | Use the `mkdir` command to create new bucket, e.g., `mybucket`.
|
24 | 24 |
|
25 |
| -```yaml |
| 25 | +```bash |
26 | 26 | rclone mkdir waterbear:mybucket
|
27 | 27 | ```
|
28 | 28 |
|
@@ -162,8 +162,43 @@ Or between two Storj buckets.
|
162 | 162 | rclone sync --progress waterbear-us:mybucket/videos/ waterbear-europe:mybucket/videos/
|
163 | 163 | ```
|
164 | 164 |
|
165 |
| -Or even between another cloud storage and Storj. |
| 165 | +Or even between another cloud storage (e.g., an AWS S3 connection names `s3`) and Storj. |
166 | 166 |
|
167 | 167 | ```bash
|
168 | 168 | rclone sync --progress s3:mybucket/videos/ waterbear:mybucket/videos/
|
169 | 169 | ```
|
| 170 | + |
| 171 | + |
| 172 | +## Mounting a Bucket |
| 173 | + |
| 174 | +Use the `mount` command to mount a bucket to a folder (Mac, Windows and Linux) or as a disk drive (Windows). When mounted, you can use the bucket as a local folder (drive). |
| 175 | +{% tabs %} |
| 176 | +{% tab label="Windows" %} |
| 177 | +```powershell |
| 178 | +mkdir ~/mybucket |
| 179 | +rclone mount waterbear:mybucket ~/mybucket --vfs-cache-mode full |
| 180 | +``` |
| 181 | +{% /tab %} |
| 182 | + |
| 183 | +{% tab label="Linux" %} |
| 184 | + |
| 185 | +```bash |
| 186 | +sudo mkdir /mnt/mybucket |
| 187 | +sudo chown $USER: /mnt/mybucket |
| 188 | +rclone mount waterbear:mybucket /mnt/mybucket --vfs-cache-mode full |
| 189 | +``` |
| 190 | +{% /tab %} |
| 191 | + |
| 192 | +{% tab label="macOS" %} |
| 193 | +```shell |
| 194 | +sudo mkdir /mnt/mybucket |
| 195 | +sudo chown $USER: /mnt/mybucket |
| 196 | +rclone mount waterbear:mybucket /mnt/mybucket --vfs-cache-mode full |
| 197 | +``` |
| 198 | +{% /tab %} |
| 199 | +{% /tabs %} |
| 200 | +{% callout type="info" %} |
| 201 | +The `--vfs-cache-mode full` flag means that all reads and writes are cached to disk. Without it, reads and writes are done directly to the Storj bucket. |
| 202 | +{% /callout %} |
| 203 | + |
| 204 | +To unmount the bucket, use the `Ctrl-C` keystroke to stop rclone. |
0 commit comments