Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rclone guide updates #72

Merged
merged 2 commits into from
Apr 23, 2024
Merged

rclone guide updates #72

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
78c511e
`rclone` guide updates
skunk-ink Apr 22, 2024
8bad59e
Correct S3 chunk size
skunk-ink Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 15 additions & 57 deletions sia-integrations/s3-integrations/rclone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,26 +44,12 @@ For the purpose of this guide, we will start by uploading a file to the Sia Netw

## Step 1: Enable `renterd` S3 API

Before setting up `rclone`, we will need to enable `renterd`'s S3 interface if you have not done so already. This is done by editing your `renterd.yml` file. If you are unsure where your `renterd.yml` is installed, please refer to the correct [installation guide](https://docs.sia.tech/v/current/renting/setting-up-renterd) for your system.

Once you have located your `renterd.yml` file, open it with your preferred text editor and add the following:

```yaml
s3:
enabled: true
address: localhost:9985
keypairsV4:
your_renterd_access_key: your_renterd_secret_key
```

Make sure to replace `your_renterd_access_key` and `your_renterd_secret_key` with unique passphrases. They can be anything you want but must be at least 40 characters in length, and your secret key should always be kept private. Keep these values on hand. You will need them for Step 3.
Before setting up `rclone`, we will need to enable `renterd`'s S3 interface if you have not done so already. Please refer to the [`renterd` installation guide](https://docs.sia.tech/renting/setting-up-renterd/windows) on configuring your S3 settings if you have not done so already.

{% hint style="warning" %}
If you are running `renterd` in a docker container, you will need to override the address via docker: `command: -s3.address :9985`
If you are running `renterd` in a docker container, you will need to override the address via docker: `command: -s3.address :8080`
{% endhint %}



***

## Step 2: Install `rclone`
Expand Down Expand Up @@ -179,7 +165,7 @@ Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Enter a value. Press Enter to leave empty.
endpoint> http://localhost:9985
endpoint> http://localhost:8080
```

When asked for a `Location constraint` press `Enter` to leave it empty.
Expand Down Expand Up @@ -227,7 +213,7 @@ Options:
- provider: other
- access_key_id: your_renterd_access_key
- secret_access_key: your_renterd_secret_key
- endpoint: localhost:9985
- endpoint: localhost:8080
- acl: private
Keep this "renterd" remote?
y) Yes this is OK (default)
Expand All @@ -253,7 +239,7 @@ Before you can use `rclone mount` on Windows, you will need to download and inst
Once you have installed `WinFsp`, you can then mount your `renterd` remote and assign it the drive letter `X:` using the following command.

```shell-session
rclone mount renterd:/default X: --vfs-cache-mode full
rclone mount renterd:/default X: --s3-chunk-size 128MiB --fast-list --vfs-cache-mode full
skunk-ink marked this conversation as resolved.
Show resolved Hide resolved
```

{% hint style="info" %}
Expand Down Expand Up @@ -282,26 +268,12 @@ For the purpose of this guide, we will start by uploading a file to the Sia Netw

## Step 1: Enable `renterd` S3 API

Before setting up `rclone`, we will need to enable `renterd`'s S3 interface if you have not done so already. This is done by editing your `renterd.yml` file. If you are unsure where your `renterd.yml` is installed, please refer to the correct [installation guide](https://docs.sia.tech/v/current/renting/setting-up-renterd) for your system.

Once you have located your `renterd.yml` file, open it with your preferred text editor and add the following:

```yaml
s3:
enabled: true
address: localhost:9985
keypairsV4:
your_renterd_access_key: your_renterd_secret_key
```

Make sure to replace `your_renterd_access_key` and `your_renterd_secret_key` with unique passphrases. They can be anything you want but must be at least 40 characters in length, and your secret key should always be kept private. Keep these values on hand. You will need them for Step 3.
Before setting up `rclone`, we will need to enable `renterd`'s S3 interface if you have not done so already. Please refer to the [`renterd` installation guide](https://docs.sia.tech/renting/setting-up-renterd/macos) on configuring your S3 settings if you have not done so already.

{% hint style="warning" %}
If you are running `renterd` in a docker container, you will need to override the address via docker: `command: -s3.address:9985`
If you are running `renterd` in a docker container, you will need to override the address via docker: `command: -s3.address :8080`
{% endhint %}

 

***

## Step 2: Install rclone
Expand Down Expand Up @@ -419,7 +391,7 @@ Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Enter a value. Press Enter to leave empty.
endpoint> http://localhost:9985
endpoint> http://localhost:8080
```

When asked for a `Location constraint` press `Enter` to leave it empty.
Expand Down Expand Up @@ -467,7 +439,7 @@ Options:
- provider: other
- access_key_id: your_renterd_access_key
- secret_access_key: your_renterd_secret_key
- endpoint: localhost:9985
- endpoint: localhost:8080
- acl: private
Keep this "renterd" remote?
y) Yes this is OK (default)
Expand Down Expand Up @@ -497,7 +469,7 @@ Once you have installed MacFUSE, you will then need to create an empty directory
Next, we will mount our `renterd` remote using the folder we just created. Adding the `--daemon` flag allows `rclone` to maintain the mount point while running in the background.

```shell-session
rclone mount renterd:/default ~/renterd_files/ --vfs-cache-mode full --daemon
rclone mount renterd:/default ~/renterd_files/ --s3-chunk-size 128MiB --fast-list --vfs-cache-mode full --daemon
skunk-ink marked this conversation as resolved.
Show resolved Hide resolved
```

![](../../.gitbook/assets/rclone-s3-integration/rclone-new-config-macos-04.png)
Expand All @@ -524,26 +496,12 @@ For the purpose of this guide, we will start by uploading a file to the Sia Netw

## Step 1: Enable `renterd` S3 API

Before setting up `rclone`, we will need to enable `renterd`'s S3 interface if you have not done so already. This is done by editing your `renterd.yml` file. If you are unsure where your `renterd.yml` is installed, please refer to the correct [installation guide](https://docs.sia.tech/v/current/renting/setting-up-renterd) for your system.

Once you have located your `renterd.yml` file, open it with your preferred text editor and add the following:

```yaml
s3:
enabled: true
address: localhost:9985
keypairsV4:
your_renterd_access_key: your_renterd_secret_key
```

Make sure to replace `your_renterd_access_key` and `your_renterd_secret_key` with unique passphrases. They can be anything you want but must be at least 40 characters in length, and your secret key should always be kept private. Keep these values on hand. You will need them for Step 3.
Before setting up `rclone`, we will need to enable `renterd`'s S3 interface if you have not done so already. Please refer to the [`renterd` installation guide](https://docs.sia.tech/renting/setting-up-renterd/linux) on configuring your S3 settings if you have not done so already.

{% hint style="warning" %}
If you are running `renterd` in a docker container, you will need to override the address via docker: `command: -s3.address:9985`
If you are running `renterd` in a docker container, you will need to override the address via docker: `command: -s3.address :8080`
{% endhint %}



***

## Step 2: Install rclone
Expand Down Expand Up @@ -658,7 +616,7 @@ Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Enter a value. Press Enter to leave empty.
endpoint> http://localhost:9985
endpoint> http://localhost:8080
```

When asked for a `Location constraint` press `Enter` to leave it empty.
Expand Down Expand Up @@ -706,7 +664,7 @@ Options:
- provider: other
- access_key_id: your_renterd_access_key
- secret_access_key: your_renterd_secret_key
- endpoint: localhost:9985
- endpoint: localhost:8080
- acl: private
Keep this "renterd" remote?
y) Yes this is OK (default)
Expand All @@ -732,7 +690,7 @@ Start by creating an empty directory on your filesystem that we will use as the
Next, we will mount our `renterd` remote using the folder we just created. Adding the `--daemon` flag allows `rclone` to maintain the mount point while running in the background.

```shell-session
rclone mount renterd:/default ~/renterd_files/ --vfs-cache-mode full --daemon
rclone mount renterd:/default ~/renterd_files/ --s3-chunk-size 128MiB --fast-list --vfs-cache-mode full --daemon
skunk-ink marked this conversation as resolved.
Show resolved Hide resolved
```

![](../../.gitbook/assets/rclone-s3-integration/rclone-new-config-linux-03.png)
Expand Down