Skip to content

Latest commit

 

History

History
166 lines (108 loc) · 5.74 KB

macos.md

File metadata and controls

166 lines (108 loc) · 5.74 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

macOS

This guide will walk you through setting up renterd on macOS. 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 supported on the following macOS versions:

    • macOS 12: Monterey (Star)
    • macOS 13: Ventura (Rome)
    • macOS 14: Sonoma (Sunburst)

  • System Updates: Ensure that your macOS is up to date with the latest system updates, as these updates can contain important security fixes and improvements.

  • 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 quad-core CPU
    • 8 GB of RAM
    • An SSD with at least 128GB of free space.

  • Software Requirements: Before installing renterd, you will need to install the Homebrew package manager. This will allow you to install and upgrade renterd easily.

{% 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 CMD + Space to open Spotlight search and open a terminal.

{% hint style="warning" %} Before you install renterd, make sure you have the Homebrew package manager installed. {% endhint %}

Once the Terminal loads, use brew to install renterd:

brew install siafoundation/sia/renterd

To confirm renterd has been installed, run the following:

renterd version

Configuring renterd

Now that you have renterd installed, you will need to create a seed phrase and admin password. To launch the built-in configuration wizard, run the following:

mkdir "$HOME/Library/Application Support/renterd"
cd "$HOME/Library/Application Support/renterd"
renterd config

Once the configuration wizard loads, you will first be asked to enter a seed phrase. If you do not already have one, type seed to generate a new one. For the purpose of this guide, we will create a new seed phrase.

Next, you will be asked to create an admin password. This will be used to unlock the renterd web UI.

You will now be asked if you would like to configure renterd's S3 settings. If you do not intend to use S3, you can type no to skip this step. For the purpose of this guide, however, we will type yes and configure the S3 endpoint.

Next, you will be asked to configure the S3 address. If you would like to use something other than the default, you can enter it now. Otherwise, hit enter to use the default port 8080.

You will now be asked to generate a new key pair. Type auto and hit enter to have a key pair generated automatically for you.

Finally, you will be asked if you would like to configure renterd's advanced settings. Type no and hit enter to exit the configuration wizard.

Running renterd

Run the following command to start renterd.

cd "$HOME/Library/Application Support/renterd"
renterd

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

{% 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 upgrade your renterd to the newest version, make sure you have shut down renterd and then run the following:

brew upgrade siafoundation/sia/renterd

You can confirm you have upgraded to the latest version of renterd using the following command:

renterd version

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