diff --git a/.gitbook/assets/renterd-install-screenshots/windows/01-renterd-multiline-warn.png b/.gitbook/assets/renterd-install-screenshots/windows/01-renterd-multiline-warn.png index cd26ce7..7639e6d 100644 Binary files a/.gitbook/assets/renterd-install-screenshots/windows/01-renterd-multiline-warn.png and b/.gitbook/assets/renterd-install-screenshots/windows/01-renterd-multiline-warn.png differ diff --git a/.gitbook/assets/renterd-install-screenshots/windows/02-renterd-download-and-install.png b/.gitbook/assets/renterd-install-screenshots/windows/02-renterd-download-and-install.png index 16e6975..389247b 100644 Binary files a/.gitbook/assets/renterd-install-screenshots/windows/02-renterd-download-and-install.png and b/.gitbook/assets/renterd-install-screenshots/windows/02-renterd-download-and-install.png differ diff --git a/.gitbook/assets/renterd-install-screenshots/windows/03-renterd-config.png b/.gitbook/assets/renterd-install-screenshots/windows/03-renterd-config.png new file mode 100644 index 0000000..8cd9fdf Binary files /dev/null and b/.gitbook/assets/renterd-install-screenshots/windows/03-renterd-config.png differ diff --git a/.gitbook/assets/renterd-install-screenshots/windows/03-renterd-seed.png b/.gitbook/assets/renterd-install-screenshots/windows/03-renterd-seed.png deleted file mode 100644 index 5fa0a72..0000000 Binary files a/.gitbook/assets/renterd-install-screenshots/windows/03-renterd-seed.png and /dev/null differ diff --git a/.gitbook/assets/renterd-install-screenshots/windows/04-renterd-running.png b/.gitbook/assets/renterd-install-screenshots/windows/04-renterd-running.png new file mode 100644 index 0000000..c68b8d8 Binary files /dev/null and b/.gitbook/assets/renterd-install-screenshots/windows/04-renterd-running.png differ diff --git a/.gitbook/assets/renterd-install-screenshots/windows/04-renterd-success.png b/.gitbook/assets/renterd-install-screenshots/windows/04-renterd-success.png deleted file mode 100644 index 28f0975..0000000 Binary files a/.gitbook/assets/renterd-install-screenshots/windows/04-renterd-success.png and /dev/null differ diff --git a/renting/renting-storage/managing-your-files.md b/renting/renting-storage/managing-your-files.md index 54b8e8a..a44f4d6 100644 --- a/renting/renting-storage/managing-your-files.md +++ b/renting/renting-storage/managing-your-files.md @@ -62,3 +62,8 @@ Health assessments can only be conducted if `renterd` when it's actively running Downloading files occurs directly within the app as well. A small download icon accompanies each file in your list. Downloading necessitates Siacoins because you are billed for the bandwidth consumed.

Downloading files in renterd

+ +## Metadata Backup + +On the Sia network, `renterd` serves a critical role in managing uploads, downloads, and file contracts. Acting as a renter's gateway to the network, `renterd` maintains a database of vital information containing the locations of file shards, contract details, and status updates for any storage and retrieval operations. Known as metadata, this information is crucial for the recovery of data stored on the network. Without it, any information a renter has uploaded is as good as lost. For this reason, having a recent backup of `renterd`'s database is essential in the event of system failure or data corruption. + diff --git a/renting/setting-up-renterd/windows.md b/renting/setting-up-renterd/windows.md index 9a0c045..0e1a4c0 100644 --- a/renting/setting-up-renterd/windows.md +++ b/renting/setting-up-renterd/windows.md @@ -57,8 +57,7 @@ Press `windows key + R` to open the run dialog. Type in `powershell` and press ` Once the Terminal loads, run the following command to download and install the latest version of `renterd`. -{% tabs %} -{% tab title="Mainnet" %} +{% tab %} ```powershell wget https://sia.tech/downloads/latest/renterd_windows_amd64.zip -OutFile "$HOME\Downloads\renterd_windows_amd64.zip"; ` Expand-Archive "$HOME\Downloads\renterd_windows_amd64.zip" -DestinationPath "$HOME\sia\renterd"; ` @@ -67,137 +66,65 @@ Remove-Item -LiteralPath "$HOME\sia\renterd\bin" -Recurse ``` {% endtab %} -{% tab title="Zen Testnet" %} -```powershell -wget https://sia.tech/downloads/latest/renterd_zen_windows_amd64.zip -OutFile "$HOME\Downloads\renterd_zen_windows_amd64.zip"; ` -Expand-Archive "$HOME\Downloads\renterd_zen_windows_amd64.zip" -DestinationPath "$HOME\sia\renterd_zen"; ` -Move-Item -Path "$HOME\sia\renterd_zen\bin\renterd.exe" -Destination "$HOME\sia\renterd_zen\renterd.exe" -Force; ` -Remove-Item -LiteralPath "$HOME\sia\renterd_zen\bin" -Recurse -``` -{% endtab %} -{% endtabs %} - {% hint style="warning" %} When you paste multi-line commands into PowerShell, you will be prompted with a warning. Make sure you have copied the entire command and click `Paste anyway` to proceed. {% endhint %} -![Click `Paste anyway` to proceed with installation.](../../.gitbook/assets/renterd-install-screenshots/windows/01-renterd-multiline-warn.png) +![](../../.gitbook/assets/renterd-install-screenshots/windows/01-renterd-multiline-warn.png) -![Installation of renterd completed successfully.](../../.gitbook/assets/renterd-install-screenshots/windows/02-renterd-download-and-install.png) +![](../../.gitbook/assets/renterd-install-screenshots/windows/02-renterd-download-and-install.png) --- -## Creating a wallet +## Configuring `renterd` -`renterd` uses BIP-39 12-word recovery phrases. To generate a new wallet recovery phrase, run the following command: +Once installed, `renterd` will need to be configure with a wallet seed and a password to unlock the web interface. This can be done using the interactive configuration wizard as seen below. -{% tabs %} -{% tab title="Mainnet" %} +{% tab %} ```powershell cd $HOME\sia\renterd\; ` -.\renterd.exe seed -``` -{% endtab %} - -{% tab title="Zen Testnet" %} -```powershell -cd $HOME\sia\renterd_zen\; ` -.\renterd.exe seed +.\renterd.exe config ``` {% endtab %} -{% endtabs %} -{% hint style="warning" %} -A new 12-word recovery phrase will be generated. Make sure to store it in a safe place, as you will need this phrase to recover your wallet. +{% hint style="info" %} +You will not see anything when you type in your seed phrase or unlock password. Press enter after typing each one. {% endhint %} -![](../../.gitbook/assets/renterd-install-screenshots/windows/03-renterd-seed.png) - ---- - -## Configure your `renterd.yml` file - -Under `$HOME\sia\renterd\bin` create a new text document named `renterd.yml`. - -{% tabs %} -{% tab title="Mainnet" %} -```powershell -New-Item -Path "$HOME\sia\renterd" -Name "renterd.yml" -ItemType "file"; ` -Start-Process "C:\WINDOWS\system32\notepad.exe" "$HOME\sia\renterd\renterd.yml" -``` -{% endtab %} - -{% tab title="Zen Testnet" %} -```powershell -New-Item -Path "$HOME\sia\renterd_zen" -Name "renterd.yml" -ItemType "file"; ` -Start-Process "C:\WINDOWS\system32\notepad.exe" "$HOME\sia\renterd_zen\renterd.yml" -``` -{% endtab %} -{% endtabs %} - -Once Notepad loads, enter the following and configure it as needed. - -```yaml -seed: your seed phrase goes here -http: - password: your_api_password -autopilot: - heartbeat: 5m -s3: - enabled: true - disableAuth: false - keypairsV4: - your_access_key: your_private_key -``` - -Make sure to add your wallet seed and create an API password. The recovery phrase is the 12-word seed phrase you generated in the previous step. Type it carefully, with one space between each word, or copy it from the previous step. The password is used to unlock the `renterd` web UI; it should be something secure and easy to remember. +![](../../.gitbook/assets/renterd-install-screenshots/windows/03-renterd-config.png) {% hint style="warning" %} -`your_access_key` can be anywhere from 16 to 128 characters long, and `your_private_key` must be exactly 40 characters long. +If you are generating a new 12-word seed phrase. Make sure to write it down and store it in a safe place. You will need this seed phrase to recover your wallet in the case of unexpected system failure. {% endhint %} -Save your `renterd.yml` configuration using `ctrl+s` and close Notepad. - ---- ## Running `renterd` -Run the following command to start `renterd`. +Once installed, `renterd` can be run using the following command. -{% tabs %} -{% tab title="Mainnet" %} -```powershell -cd $HOME\sia\renterd; ` -.\renterd.exe -``` -{% endtab %} +{% hint style="warning" %} +If you are planning on run `renterd` on the `zen` or `anagami` testnet, the `-network` flag should be used to specify. Eg. `./renterd.exe -network zen|anagami`. +{% endhint %} -{% tab title="Zen Testnet" %} +{% tab %} ```powershell -cd $HOME\sia\renterd_zen; ` +cd $HOME\sia\renterd; ` .\renterd.exe ``` {% endtab %} -{% endtabs %} {% hint style="warning" %} Remember to leave the PowerShell open while `renterd` is running. If you close the command prompt window, `renterd` will stop. {% endhint %} -![](../../.gitbook/assets/renterd-install-screenshots/windows/04-renterd-success.png) +![](../../.gitbook/assets/renterd-install-screenshots/windows/04-renterd-running.png) -You can now access the Sia network using the `renterd` web UI by opening a browser and going to [http://localhost:9980](http://localhost:9980/). - -{% hint style="warning" %} -If you are running `renterd` on the Zen Testnet, you will need to access the web UI on port `9880` by going to [http://localhost:9880](http://localhost:9880). -{% endhint %} +Once loaded a web browser will open displaying `renterd`'s web UI. ![](../../.gitbook/assets/renterd-install-screenshots/renterd-success.png) -Enter the API `password` you created in your `renterd.yml` to unlock the `renterd` web UI. - {% hint style="success" %} -Congratulations, you have successfully set up `renterd`. +Congratulations, you have successfully set up `renterd`. Follow the on screen setup wizard to begin renting storage on the Sia network! {% endhint %} --- @@ -211,9 +138,7 @@ New versions of `renterd` are released regularly and contain bug fixes and perfo 1. Stop `renterd` if it is running. This can be accomplished by pressing `ctrl+c` in the PowerShell currently running `renterd`. 2. Download and install the latest version of `renterd`. - -{% tabs %} -{% tab title="Mainnet" %} +{% tab %} ```powershell wget https://sia.tech/downloads/latest/renterd_windows_amd64.zip -OutFile "$HOME\Downloads\renterd_windows_amd64.zip"; ` Expand-Archive "$HOME\Downloads\renterd_windows_amd64.zip" -DestinationPath "$HOME\sia\renterd"; ` @@ -222,35 +147,32 @@ Remove-Item -LiteralPath "$HOME\sia\renterd\bin" -Recurse ``` {% endtab %} -{% tab title="Zen Testnet" %} -```powershell -wget https://sia.tech/downloads/latest/renterd_zen_windows_amd64.zip -OutFile "$HOME\Downloads\renterd_zen_windows_amd64.zip"; ` -Expand-Archive "$HOME\Downloads\renterd_zen_windows_amd64.zip" -DestinationPath "$HOME\sia\renterd_zen"; ` -Move-Item -Path "$HOME\sia\renterd_zen\bin\renterd.exe" -Destination "$HOME\sia\renterd_zen\renterd.exe" -Force; ` -Remove-Item -LiteralPath "$HOME\sia\renterd_zen\bin" -Recurse -``` -{% endtab %} -{% endtabs %} - -3. Restart the `renterd` system service. -{% tabs %} -{% tab title="Mainnet" %} +3. Verify `renterd` has been updated. +{% tab %} ```powershell cd $HOME\sia\renterd; ` -.\renterd.exe +.\renterd.exe version ``` {% endtab %} -{% tab title="Zen Testnet" %} +4. Start `renterd`. +{% tab %} ```powershell -cd $HOME\sia\renterd_zen; ` +cd $HOME\sia\renterd; ` .\renterd.exe ``` {% endtab %} -{% endtabs %} -![Starting renterd](../../.gitbook/assets/renterd-install-screenshots/windows/04-renterd-success.png) +![](../../.gitbook/assets/renterd-install-screenshots/windows/04-renterd-running.png) {% hint style="success" %} Congratulations, you have successfully updated your version of `renterd`! {% endhint %} + +## Next Steps + +Now that you have `renterd` installed and running, you can start using it to store and retrieve data on the Sia network. You can access the web interface by navigating to `http://127.0.0.1:9980` in your web browser. If you installed `renterd` on a remote machine or a server, you will need to create an SSH tunnel to access the web interface. + +- [About Renting](../../about-renting.md) +- [Transferring Siacoins](../../transferring-siacoins.md) +- [Managing Your Files](../../renting-storage/managing-your-files.md)