# 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:

* **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
  * 8GB of RAM
  * 256 GB SSD for `renterd`
* **Software Requirements:** Before installing `renterd`, you will need to install the [Homebrew](https://brew.sh) package manager. This will allow you to install and upgrade `renterd` easily.
* **Network Access:** `renterd` needs a stable internet connection and open network access in order to store and retrieve data on the Sia network.

{% hint style="warning" %}
To ensure proper functionality, we are recommending a minimum of 8 GB 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`.

![](https://3679771871-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6w9fYqdazlo30V4aFg36%2Fuploads%2Fgit-blob-b088aa30c0a9f0518900560d53deecd9d1acba2e%2F00-renterd-open-terminal.png?alt=media)

{% hint style="warning" %}
Before you install `renterd`, make sure you have the [Homebrew](https://brew.sh) package manager installed.
{% endhint %}

Once the Terminal loads, use `brew` to install `renterd`:

```console
brew install siafoundation/sia/renterd
```

![](https://3679771871-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6w9fYqdazlo30V4aFg36%2Fuploads%2Fgit-blob-5dbdc41da446d91729e7539fadb36307e726bcac%2F01-renterd-brew-install.png?alt=media)

To confirm `renterd` has been installed, run the following:

```console
renterd version
```

![](https://3679771871-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6w9fYqdazlo30V4aFg36%2Fuploads%2Fgit-blob-38df89da718c0f8b6963730e486e77f4379aaa38%2F12-renterd-version.png?alt=media)

***

## 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:

```console
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.

![](https://3679771871-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6w9fYqdazlo30V4aFg36%2Fuploads%2Fgit-blob-3c2fae35db40431a9ad92495986bc670f909d8c6%2F03-renterd-config-seed.png?alt=media)

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

![](https://3679771871-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6w9fYqdazlo30V4aFg36%2Fuploads%2Fgit-blob-2b96886efaaa3729f8c466ac78f90f9f387ed125%2F04-renterd-config-password.png?alt=media)

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.

![](https://3679771871-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6w9fYqdazlo30V4aFg36%2Fuploads%2Fgit-blob-cabf782f3bdecf0ef60e316cff8eb7af4f6c328a%2F05-renterd-config-s3.png?alt=media)

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`.

![](https://3679771871-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6w9fYqdazlo30V4aFg36%2Fuploads%2Fgit-blob-9cc302cf2c530cf6401e67fb06e1d0e9d752c2e2%2F06-renterd-config-s3-endpoint.png?alt=media)

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.

![](https://3679771871-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6w9fYqdazlo30V4aFg36%2Fuploads%2Fgit-blob-a5c083a993fc56df5a37c0ab4cb2548b58d11aac%2F07-renterd-config-s3-gen-keypair.png?alt=media)

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.

![](https://3679771871-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6w9fYqdazlo30V4aFg36%2Fuploads%2Fgit-blob-209c53c89fb27a96875706bf13afa28e1fdf4cdc%2F08-renterd-config-advanced-settings.png?alt=media)

***

## Running `renterd`

Run the following command to start `renterd`.

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

![](https://3679771871-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6w9fYqdazlo30V4aFg36%2Fuploads%2Fgit-blob-d0c4355569a9f2fee8b3797f1f50485183d6c357%2F09-renterd-startup.png?alt=media)

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/).

![](https://3679771871-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6w9fYqdazlo30V4aFg36%2Fuploads%2Fgit-blob-4e11391315d9ade8fc06fbab0bab046f1c9b9a68%2F10-renterd-webui.png?alt=media)

{% 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:

```console
brew upgrade siafoundation/sia/renterd
```

![](https://3679771871-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6w9fYqdazlo30V4aFg36%2Fuploads%2Fgit-blob-87522aac82009cbecce1ae192f8a43839facebf1%2F11-renterd-upgrade.png?alt=media)

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

```console
renterd version
```

![](https://3679771871-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6w9fYqdazlo30V4aFg36%2Fuploads%2Fgit-blob-38df89da718c0f8b6963730e486e77f4379aaa38%2F12-renterd-version.png?alt=media)

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