Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .gitbook/assets/indexd-screenshots/indexd-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,23 @@ layout:
visible: true
---

Sia is the world's safest cloud storage, by design—a purely decentralized peer-to-peer network with **no central access point**, **no gatekeepers**, and **no insanely expensive hardware requirements**. It offers a radically new level of **privacy**, **security**, **performance** and **pricing** — all through a unique **nonprofit model**.
Sia is decentralized, peer-to-peer cloud storage with no central provider and no gatekeepers. Files are encrypted on your own device before upload, so no storage provider can read your data, and you hold the keys. The network is developed by a non-profit and runs on open-source software.

So whether youre a developer looking to build on an open-source and decentralized cloud platform, or a user ready to take control of your data, you’re in the right place!
Whether you're a developer building on Sia or a user storing your own data, these docs cover how to use the network.

Our documentation is your comprehensive guide and single source of truth for learning how to interact with the Sia Network.
# Where to start

* **Store your data** — the simplest way to start is the [Sia Storage app with a free Sia Storage account](renting/using-sia-storage.md) (50 GB). For how it works, see [About Storing Your Data](renting/about-renting.md).
* **Provide storage and earn Siacoin** — set up [`hostd`](hosting/about-hosting-on-sia.md).
* **Hold and manage Siacoin** — use [`walletd`](wallet/wallet-overview.md).
* **Build an application on Sia** — see the [Sia Developer Portal](https://devs.sia.storage).
* **Not sure which software you need?** — [Which Sia software do I need?](get-started-with-sia/sia-software-overview.md)
Comment on lines +24 to +30

# Get Involved

## Contribute to Docs

Keeping our docs up to date is important, and we welcome community contributions—whether suggesting edits or adding new articles.
We welcome community contributions to the docs—whether suggesting edits or adding new articles.

1. To submit edits via GitHub, click dropdown in the top-right corner and select **Edit on GitHub**. You’ll be taken directly to the corresponding page on GitHub.

Expand All @@ -49,23 +55,23 @@ You can toggle the **Preview** button to see how the markdown will be formatted.
4. Once you're satisfied, click **Commit Changes** to submit your edits.

{% hint style="success" %}
Congratulations! You’ve successfully submitted your edits via GitHub. Your edits will be reviewed by The Sia Foundation.
You’ve submitted your edits via GitHub. Your edits will be reviewed by The Sia Foundation.
{% endhint %}

## Contribute to Sia

Our core team of engineers at The Sia Foundation believes that principles are everything—in **Systems Creativity**, **Technical Integrity**, and **Personal Agency**. As a 100% open-source project, we've had countless individuals contribute to the core code and to apps built on top of the network. These contributions **invest in and strengthen the Sia cloud storage network, engage the Sia community, and educate the public about the urgency of data privacy and ownership**.
Our core team of engineers at The Sia Foundation works according to three principles: **Systems Creativity**, **Technical Integrity**, and **Personal Agency**. As a fully open-source project, we've had many individuals contribute to the core code and to apps built on top of the network.

Check out our [GitHub](https://github.com/SiaFoundation) to follow along or contribute code to help further our mission.
Check out our [GitHub](https://github.com/SiaFoundation) to follow along or contribute code.

## Join our Community

Join our [Discord](https://discord.com/invite/sia)—a hub for developers, users, and anyone curious about decentralized cloud storage, privacy, and security. It’s the place for support, collaboration, and updates. Want to contribute? Head to `#contributors` to say hi, ask questions, or share your Sia-related code or app.
Join our [Discord](https://discord.com/invite/sia) for developers, users, and anyone curious about decentralized cloud storage, privacy, and security. It's where you can find support and updates. Want to contribute? Head to `#contributors` to say hi, ask questions, or share your Sia-related code or app.

{% hint style="info" %}
**Need Assistance?**

Join the `#help` channel on our [Discord](https://discord.com/invite/sia), where the community is always ready to help.
Join the `#help` channel on our [Discord](https://discord.com/invite/sia), where the community can help.

You can also [email us](mailto:hello@sia.tech), and we’ll get back to you as soon as possible.
{% endhint %}
22 changes: 13 additions & 9 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,37 @@
## Get Started with Sia

* [Learn about Sia](get-started-with-sia/sia101.md)
* [Which Sia software do I need?](get-started-with-sia/sia-software-overview.md)
* [Learn about Siacoins](get-started-with-sia/learn-about-siacoins.md)
* [Your Sia Seed](get-started-with-sia/the-importance-of-your-seed.md)

## Store Your Data

* [About Storing Data on Sia](renting/about-renting.md)
* [Installing renterd](renting/setting-up-renterd/README.md)
* [Using Sia Storage](renting/using-sia-storage.md)
* [Setting up indexd](renting/setting-up-indexd/README.md)
* [Docker](renting/setting-up-indexd/docker.md)
* [Transferring Siacoins](renting/transferring-siacoins.md)
* [Setting up renterd](renting/setting-up-renterd/README.md)
* [macOS](renting/setting-up-renterd/macos.md)
* [Linux](renting/setting-up-renterd/linux/README.md)
* [Debian](renting/setting-up-renterd/linux/debian.md)
* [Ubuntu](renting/setting-up-renterd/linux/ubuntu.md)
* [Other](renting/setting-up-renterd/linux/other.md)
* [Docker](renting/setting-up-renterd/docker.md)
* [Windows](renting/setting-up-renterd/windows.md)
* [Transferring Siacoins](renting/transferring-siacoins.md)
* [Storing Your Data](renting/renting-storage/README.md)
* [Storing Your Data](renting/renting-storage/README.md)
* [Managing Your Files](renting/renting-storage/managing-your-files.md)

## Build on Sia

* [Sia Developer Portal](https://devs.sia.storage)
* [SDK Quickstart](https://devs.sia.storage/docs/quickstart)

## Provide Storage

* [About Providing Storage on Sia](hosting/about-hosting-on-sia.md)
* [Installing hostd](hosting/setting-up-hostd/README.md)
* [Setting up hostd](hosting/setting-up-hostd/README.md)
* [Linux](hosting/setting-up-hostd/linux/README.md)
* [Debian](hosting/setting-up-hostd/linux/debian.md)
* [Ubuntu](hosting/setting-up-hostd/linux/ubuntu.md)
Expand Down Expand Up @@ -59,7 +68,6 @@
## Integrations

* [Sia Ledger app with Sia Central](sia-integrations/using-the-sia-ledger-nano-app-sia-central.md)
* [Sia Ledger Nano app with CLI](sia-integrations/using-the-sia-ledger-nano-app-cli.md)
* [S3 Integrations](sia-integrations/s3-integrations/README.md)
* [Jellyfin](sia-integrations/s3-integrations/jellyfin.md)
* [Nextcloud](sia-integrations/s3-integrations/nextcloud.md)
Expand All @@ -70,9 +78,5 @@
* [V2: The Final Cut - Network Upgrade (December 2025)](miscellaneous/sias-december-2025-hardfork-ecosystem-status.md)
* [V2 Hardfork - June 2025](v2/README.md)
* [How to Upgrade: Exchanges](v2/exchanges.md)
* [Sia Ecosystem Fork Status](navigating-the-v2-hardfork/sia-ecosystem-fork-compliance.md)
* [Siacoin Total Supply](miscellaneous/siacoin-total-supply.md)
* [Siafunds](/siafunds/learn-about-siafunds.md)
* [Withdrawing Siafunds](siafunds/how-to-cash-out-siafunds.md)
* [SEC Settlement](siafunds/sec-settlement-faq.md)
* [Brand Guidelines](miscellaneous/sia-brand-guidelines.md)
14 changes: 7 additions & 7 deletions get-started-with-sia/learn-about-siacoins.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,23 @@ layout:

# Learn about Siacoins

## Siacoins: The Power Behind Sia Network
## Siacoins on the Sia Network

Siacoins (SC) are the utility tokens powering the Sia network and are essential for any activity on the network. Siacoins serve a singular purpose – facilitating network operations – yet are utilized in various ways, such as:
Siacoins (SC) are the utility tokens used on the Sia network and are required for any activity on the network. Siacoins serve a single purpose – facilitating network operations – and are used in various ways, such as:

* Uploading files to Sia, you use Siacoins to pay for storage.
* Earning Siacoins for storing others' data.
* Transferring by sending them to others or receiving them at your wallet address.

Siacoins can be securely stored using our [official software](https://sia.tech/software/walletd) on a hardware or paper wallet. Initially, obtaining Siacoins is simple: having someone send them to you, purchasing them on an exchange, or engaging in mining activities.
Siacoins can be stored using our [official software](https://sia.tech/software/walletd) on a hardware or paper wallet. You can obtain Siacoins by having someone send them to you, purchasing them on an exchange, or mining.

## How to obtain Siacoins

Whether you want to upload files to the decentralized cloud or lend extra storage space to the network, you need Siacoins to use Sia. Siacoins can be sent to you once you make a Sia wallet address, or you can mine them. Otherwise, you'll need to buy them.

### Buy from an exchange

Siacoins are listed on several prominent exchanges, and you can access the complete list of exchanges where Siacoins are available on our [official website](https://sia.tech/community?category=exchanges). Purchasing Siacoins from an exchange typically offers competitive prices but may involve a relatively steep learning curve for new users.
Siacoins are listed on several exchanges, and you can find the list of exchanges where Siacoins are available on our [official website](https://sia.tech/community?category=exchanges). Purchasing Siacoins from an exchange typically offers competitive prices but may involve a steep learning curve for new users.

{% hint style="info" %}
Some exchanges support direct fiat (local currency) to Siacoin purchases, but others require you to buy Bitcoins, Ethereum, or other cryptos to make your purchase. Please visit the exchange's official website to find out more.
Expand All @@ -53,23 +53,23 @@ You can also receive Siacoins, share your QR code for others to scan, and send f
### Mining on the network

\
When you mine on a cryptocurrency network, you contribute computing power to help process and verify transactions. Miners are the backbone of the network, verifying the integrity of the blockchain. On Sia, miners are rewarded with Siacoins for their services.
When you mine on a cryptocurrency network, you contribute computing power to help process and verify transactions. Miners verify the integrity of the blockchain. On Sia, miners are rewarded with Siacoins for their services.

Our [official website](https://sia.tech/community-ecosystem?software=mining\_pools) shows a list of Siacoins mining pools. Please see their documentation to get started.

#### The Block Rewards

The block reward is the miner's incentive to contribute their computing power and electricity costs to the network. When a block is successfully verified or solved, an amount of Siacoins is paid out to those who mined the block.

Unlike Bitcoin and other cryptocurrency blockchains, the Sia block reward never stops and gives infinite rewards. This means miners will always be incentivized to be part of Sia. Once the block reward reaches 30,000 coins, it stays there forever.
Unlike Bitcoin and other cryptocurrency blockchains, the Sia block reward does not stop decreasing to zero. Once the block reward reaches 30,000 coins, it stays at that level, so miners continue to receive a reward for each block.

{% hint style="info" %}
When the Sia network launched, the block reward was 300,000 Siacoins. This decreases by one every block, with a floor at 30,000 – reached at block 270,000 (300,000 - block height).
{% endhint %}

#### Proof-of-work

The Sia blockchain operates on Proof-of-Work, ensuring the integrity of transactions and contracts. Whether used for power cryptocurrencies like Bitcoin or utility and smart storage contracts like Sia, trust is inherent in a blockchain's immutability. With no central authority to oversee transactions or contract validity, the assurance comes from the blockchain itself. Proof-of-Work serves as a robust safeguard, deterring any attempts to alter the history of the blockchain through significant effort and expense.
The Sia blockchain operates on Proof-of-Work to maintain the integrity of transactions and contracts. Whether used to power cryptocurrencies like Bitcoin or utility and storage contracts like Sia, trust comes from a blockchain's immutability. With no central authority to oversee transactions or contract validity, the assurance comes from the blockchain itself. Proof-of-Work deters attempts to alter the history of the blockchain by making it require significant effort and expense.



64 changes: 64 additions & 0 deletions get-started-with-sia/sia-software-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
description: A side-by-side guide to the Sia software and the terms used across these docs.
layout:
title:
visible: true
description:
visible: true
tableOfContents:
visible: true
outline:
visible: true
pagination:
visible: true
---

# Which Sia software do I need?

There are several pieces of Sia software, each for a different job. Use this page to find the one that matches what you want to do.

| I want to… | Use |
|------------|-----|
| Store and manage files the easy way | The **Sia Storage app** (desktop, mobile) with a [Sia Storage](https://sia.storage) account — 50 GB free |
| Use Sia through an S3-compatible API | [`s3d`](https://github.com/SiaFoundation/s3d), connected to an indexer such as Sia Storage |
| Build my own app | The [Sia Storage SDKs](https://devs.sia.storage) |
| Run the indexer myself instead of using Sia Storage | [`indexd`](../renting/setting-up-indexd/) — requires PostgreSQL |
| Provide storage and earn Siacoin | [`hostd`](../hosting/about-hosting-on-sia.md) |
| Hold and manage Siacoin | [`walletd`](../wallet/wallet-overview.md) |
| Run the older all-in-one renter | [`renterd`](../renting/setting-up-renterd/) — no longer the preferred way to store data |

## How the pieces fit together

To store data on Sia you run a **client** that connects to an **indexer**. The client encrypts your files and moves them to and from storage providers; the indexer manages contracts and keeps your data healthy. By itself, an indexer like Sia Storage doesn't store your files — you need a client to use it. See [About Storing Your Data](../renting/about-renting.md) for more.

### Clients — how you use Sia storage

* **Sia Storage app** — desktop and mobile apps for storing and retrieving files. Point it at an indexer; a Sia Storage account is the easiest option.
* **`s3d`** — a lightweight, S3-compatible gateway. It translates the AWS S3 API to Sia and connects to an indexer such as Sia Storage, so existing S3 tools and applications can use Sia storage.
* **Sia Storage SDKs** — client libraries (Rust, Go, Python, JavaScript) for building your own app. The Sia Storage app and `s3d` are currently the only ready-made clients.

### Indexer — the backend

* **Sia Storage** — a hosted indexer. It manages contracts and keeps your data healthy for you, with 50 GB free and nothing to run. Recommended for most people.
* **`indexd`** — the indexer software, for running the backend yourself instead of using Sia Storage. Requires PostgreSQL.

### Other software

* **`hostd`** — storage-provider software. Stores encrypted data for the network and earns Siacoin.
* **`walletd`** — a standalone wallet for Siacoin and Siafunds, with Ledger support.
* **`renterd`** — the original all-in-one renter (wallet, contracts, and an upload/download UI in one program). Still works, but no longer the preferred way to store data.

## Glossary

* **Renter** — anyone storing data on Sia. The renter forms and pays for storage contracts; today an indexer fills this role on your behalf.
* **Storage provider (host)** — an operator running `hostd` that stores encrypted data and earns Siacoin.
* **Client** — software you run to store and retrieve files, such as the Sia Storage app or `s3d`. A client connects to an indexer.
* **Indexer** — the backend that manages contracts, tracks where data lives, and keeps it healthy. Sia Storage is a hosted indexer; `indexd` is the software for running your own.
* **Contract** — a blockchain-enforced agreement between a renter and a storage provider covering how much data to store, for how long, and at what price.
* **Object** — the application-level view of a stored file: its data, metadata, and storage layout under a single content-derived ID.
* **Slab** — a unit of an object's data that is erasure-coded into shards.
* **Shard** — one erasure-coded, encrypted piece of a slab, stored by a single provider.
* **Erasure coding** — a method of splitting data into redundant pieces so the original can be rebuilt from a subset of them.
* **Siacoin (SC)** — the network's utility token, used to pay for storage.
* **Siafund** — a separate token that receives a fee from storage contracts.
* **Recovery phrase (seed)** — the secret words that control a wallet and let you recover it.
Loading