Skip to content

Latest commit

 

History

History
256 lines (194 loc) · 8.13 KB

windows.md

File metadata and controls

256 lines (194 loc) · 8.13 KB
Raw
cover coverY layout
0
cover title description tableOfContents outline pagination
visible size
true
hero
visible
true
visible
true
visible
true
visible
true
visible
true

Windows

This guide will walk you through setting up renterd on Windows. At the end of this guide, you should have:

  • Installed Sia renterd software
  • Created a renterd wallet

Pre-requisites

To ensure you will not run into any issues with running renterd it is recommended your system meets the following requirements:

  • Network Access: renterd needs a stable internet connection and open network access in order to store and retrieve data on the Sia network.

  • Operating System Compatibility: renterd is only compatible with Windows 64bit systems.

  • Hardware Requirements: A stable setup that meets the following specifications is recommended. Not meeting these requirements may result in preventing slabs from uploading and can lead to a loss of data.

    • A dual-core CPU
    • 16GB of RAM
    • An SSD with at least 128GB of free space.

{% hint style="warning" %} To ensure proper functionality, we are recommending 16GB RAM. This is because renterd will keep full slabs in memory when uploading. A full slab is 120MB, and a single upload may hold two or three slabs in memory. However, it is possible to run renterd with less RAM than this, and it may work fine depending on the use case. {% endhint %}

Installing renterd

Press windows key + R to open the run dialog. Type in powershell and press OK to open a Terminal.

Once the Terminal loads, run the following command to download and install the latest version of renterd.

{% tabs %} {% tab title="Mainnet" %}

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"; `
Move-Item -Path "$HOME\sia\renterd\bin\renterd.exe" -Destination "$HOME\sia\renterd\renterd.exe" -Force; `
Remove-Item -LiteralPath "$HOME\sia\renterd\bin" -Recurse

{% endtab %}

{% tab title="Zen Testnet" %}

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.

Installation of renterd completed successfully.

Creating a wallet

renterd uses BIP-39 12-word recovery phrases. To generate a new wallet recovery phrase, run the following command:

{% tabs %} {% tab title="Mainnet" %}

cd $HOME\sia\renterd\; `
.\renterd.exe seed

{% endtab %}

{% tab title="Zen Testnet" %}

cd $HOME\sia\renterd_zen\; `
.\renterd.exe seed

{% 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. {% endhint %}

Configure your renterd.yml file

Under $HOME\sia\renterd\bin create a new text document named renterd.yml.

{% tabs %} {% tab title="Mainnet" %}

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" %}

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.

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.

{% 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. {% endhint %}

Save your renterd.yml configuration using ctrl+s and close Notepad.

Running renterd

Run the following command to start renterd.

{% tabs %} {% tab title="Mainnet" %}

cd $HOME\sia\renterd; `
.\renterd.exe

{% endtab %}

{% tab title="Zen Testnet" %}

cd $HOME\sia\renterd_zen; `
.\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 %}

You can now access the Sia network using the renterd web UI by opening a browser and going to 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. {% endhint %}

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. {% endhint %}

Updating

New versions of renterd are released regularly and contain bug fixes and performance improvements.

To update:

  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" %}

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"; `
Move-Item -Path "$HOME\sia\renterd\bin\renterd.exe" -Destination "$HOME\sia\renterd\renterd.exe" -Force; `
Remove-Item -LiteralPath "$HOME\sia\renterd\bin" -Recurse

{% endtab %}

{% tab title="Zen Testnet" %}

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 %}

  1. Restart the renterd system service. {% tabs %} {% tab title="Mainnet" %}
cd $HOME\sia\renterd; `
.\renterd.exe

{% endtab %}

{% tab title="Zen Testnet" %}

cd $HOME\sia\renterd_zen; `
.\renterd.exe

{% endtab %} {% endtabs %}

Starting renterd

{% hint style="success" %} Congratulations, you have successfully updated your version of renterd! {% endhint %}