Skip to content
Peter-Jan Brone edited this page Apr 20, 2023 · 12 revisions

Welcome to the renterd wiki, a collection of information about renterd and how to use it to rent storage on the Sia network.

This wiki is a WIP and will be extended over time as renterd evolves.

About renterd

The Sia network is a distributed marketplace of cloud storage where hosts sell their disk space and renters can rent it using a token called Siacoin. The software renters use to get access to that marketplace is called renterd. The d stands for daemon, a term used for software running as a background process on a server. While running, renterd serves an http API that can be used to upload files to the Sia network and download them. Software that wants to use Sia as a backend consumes this API similar to how it would use the API of other storage providers. The actual upload/download of files to/from the network is then handled by renterd.

We recommend that you first check out the learning material on our website to get a high level overview of how Sia works before diving into renterd. If you know how to run renterd already and want to get started building right away take a look at the API docs.

Useful Links

Docker

We also host official docker images. At this time we automatically build master, stable, master-testnet and stable-testnet images.

You can run renterd with the following command assuming you already have a seed. See here how to obtain a seed.

docker run -d --name renterd -e RENTERD_API_PASSWORD="<PASSWORD>" -e RENTERD_SEED="<SEED>" -p 127.0.0.1:9880:9880/tcp -p :9881:9981/tcp ghcr.io/siafoundation/renterd:stable-testnet
Clone this wiki locally