Skip to content

Latest commit

 

History

History
112 lines (78 loc) · 4.68 KB

windows.md

File metadata and controls

112 lines (78 loc) · 4.68 KB
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

  • Network Access: renterd interacts with the Sia network, so you need a stable internet connection and open network access to connect to the Sia blockchain.
  • Operating System Compatibility: Ensure your Windows version is compatible with the renterd software. Check releases supported by Windows versions.
  • System Updates: Ensure that your Windows is up to date with the latest system updates, as these updates can contain important security fixes and improvements.

Getting renterd

{% hint style="info" %} You may need to run this step in administrative mode, so right-click Command Prompt and select Run as administrator. {% endhint %}

  1. Download the latest version of renterd for your operating system from the official website. For this guide, we'll be downloading the Windows version of renterd .
  2. Now that we have downloaded renterd, you may need to unzip it.
    • Right-click the downloaded renterd zip file and select Extract All to unzip it if it hasn't done so automatically. Select an accessible destination to extract the file.
    • Click on the newly unzipped directory.
  3. Finally, for good practice, create a folder on the home drive. This folder will be utilized specifically to store data related to the renterd software. Open the Command Prompt and run the following command:
mkdir C:\Users\<your_username>\renterd

Creating a wallet

  1. renterd uses BIP-39 12-word recovery phrases. If you already have a 12-word seed, skip this step; otherwise, run the following command to generate a new wallet recovery phrase:
renterd seed

A new 12-word recovery phrase will be generated, so please copy and store it in a safe place, as you will need this phrase to recover your wallet.

{% hint style="warning" %} If you lose this phrase, you will lose access to your wallet and funds. Read more about the importance of your seed. {% endhint %}

Generating a recovery phrase

Running renterd

  1. IRun the following in your Command Prompt to start renterd:
 renterd

You will be prompted to input both:

  • API password - You choose this password, which can be anything you want. It will be used to unlock the renterd UI via your browser and should be something secure and easy to remember.
  • wallet seed - The recovery phrase is the 12-word phrase you generated in the previous step. Type it carefully, with one space between each word, or copy it from the previous step.

These values are not stored anywhere and will be requested every time you start renterd.

{% hint style="info" %} You can also set the RENTERD_SEED and RENTERD_API_PASSWORD environment variables so you do not have to re-enter the values every time. {% endhint %}

  1. After entering your desired API password and the created seed, renterd will start.

Starting renterd

  1. You can now access the renterd UI by opening a browser and going to http://localhost:9980.

{% hint style="warning" %} Remember to leave the Command Prompt open while renterd it is running. If you close the command prompt window, renterd stop. {% endhint %}

renterd Login UI

Enter your API password you created in the previous step to unlock renterd.

{% hint style="success" %} Congratulations on successfully setting up renterd and taking a significant step towards renting storage space on the Sia network. {% endhint %}

Updating

It is essential to keep your host up to date. New versions of renterd are released regularly and contain bug fixes and performance improvements.

To update:

  1. Download the latest version of renterd from the official website.
  2. Stop the renterd service with Crtl+C.
  3. Unzip and replace renterd with the new version.
  4. Restart renterd.