diff --git a/.gitbook/assets/adding_volume.png b/.gitbook/assets/adding_volume.png new file mode 100644 index 0000000..13c3dfe Binary files /dev/null and b/.gitbook/assets/adding_volume.png differ diff --git a/.gitbook/assets/announce.png b/.gitbook/assets/announce.png new file mode 100644 index 0000000..3681fcc Binary files /dev/null and b/.gitbook/assets/announce.png differ diff --git a/.gitbook/assets/bamboo.png b/.gitbook/assets/bamboo.png new file mode 100644 index 0000000..5db3d16 Binary files /dev/null and b/.gitbook/assets/bamboo.png differ diff --git a/.gitbook/assets/check_status.png b/.gitbook/assets/check_status.png new file mode 100644 index 0000000..16d6281 Binary files /dev/null and b/.gitbook/assets/check_status.png differ diff --git a/.gitbook/assets/config_1 (1).png b/.gitbook/assets/config_1 (1).png new file mode 100644 index 0000000..496459a Binary files /dev/null and b/.gitbook/assets/config_1 (1).png differ diff --git a/.gitbook/assets/config_1.png b/.gitbook/assets/config_1.png new file mode 100644 index 0000000..069c0d6 Binary files /dev/null and b/.gitbook/assets/config_1.png differ diff --git a/.gitbook/assets/configure_2.png b/.gitbook/assets/configure_2.png new file mode 100644 index 0000000..2f49b0c Binary files /dev/null and b/.gitbook/assets/configure_2.png differ diff --git a/.gitbook/assets/creating volume list.png b/.gitbook/assets/creating volume list.png new file mode 100644 index 0000000..0b69bfb Binary files /dev/null and b/.gitbook/assets/creating volume list.png differ diff --git a/.gitbook/assets/header.jpeg b/.gitbook/assets/header.jpeg new file mode 100644 index 0000000..bf52b69 Binary files /dev/null and b/.gitbook/assets/header.jpeg differ diff --git a/.gitbook/assets/hostd r 0.png b/.gitbook/assets/hostd r 0.png new file mode 100644 index 0000000..d83ed06 Binary files /dev/null and b/.gitbook/assets/hostd r 0.png differ diff --git a/.gitbook/assets/hostd r 1.png b/.gitbook/assets/hostd r 1.png new file mode 100644 index 0000000..7a81abf Binary files /dev/null and b/.gitbook/assets/hostd r 1.png differ diff --git a/.gitbook/assets/hostd r 2.png b/.gitbook/assets/hostd r 2.png new file mode 100644 index 0000000..e0bc573 Binary files /dev/null and b/.gitbook/assets/hostd r 2.png differ diff --git a/.gitbook/assets/hostd_sync.png b/.gitbook/assets/hostd_sync.png new file mode 100644 index 0000000..30c004c Binary files /dev/null and b/.gitbook/assets/hostd_sync.png differ diff --git a/.gitbook/assets/introduction_1.png b/.gitbook/assets/introduction_1.png new file mode 100644 index 0000000..2a1e829 Binary files /dev/null and b/.gitbook/assets/introduction_1.png differ diff --git a/.gitbook/assets/introduction_2.png b/.gitbook/assets/introduction_2.png new file mode 100644 index 0000000..db4690d Binary files /dev/null and b/.gitbook/assets/introduction_2.png differ diff --git a/.gitbook/assets/introduction_3.png b/.gitbook/assets/introduction_3.png new file mode 100644 index 0000000..40944f9 Binary files /dev/null and b/.gitbook/assets/introduction_3.png differ diff --git a/.gitbook/assets/introduction_4.png b/.gitbook/assets/introduction_4.png new file mode 100644 index 0000000..7e3c9d8 Binary files /dev/null and b/.gitbook/assets/introduction_4.png differ diff --git a/.gitbook/assets/jungle.png b/.gitbook/assets/jungle.png new file mode 100644 index 0000000..d96f145 Binary files /dev/null and b/.gitbook/assets/jungle.png differ diff --git a/.gitbook/assets/leaves.png b/.gitbook/assets/leaves.png new file mode 100644 index 0000000..7c3c0f1 Binary files /dev/null and b/.gitbook/assets/leaves.png differ diff --git a/.gitbook/assets/mountain.png b/.gitbook/assets/mountain.png new file mode 100644 index 0000000..24f0dd4 Binary files /dev/null and b/.gitbook/assets/mountain.png differ diff --git a/.gitbook/assets/qr.png b/.gitbook/assets/qr.png new file mode 100644 index 0000000..02c2b86 Binary files /dev/null and b/.gitbook/assets/qr.png differ diff --git a/.gitbook/assets/sia_original.png b/.gitbook/assets/sia_original.png new file mode 100644 index 0000000..af7d6ec Binary files /dev/null and b/.gitbook/assets/sia_original.png differ diff --git a/.gitbook/assets/siacentral.png b/.gitbook/assets/siacentral.png new file mode 100644 index 0000000..f7bca01 Binary files /dev/null and b/.gitbook/assets/siacentral.png differ diff --git a/.gitbook/assets/siastats.png b/.gitbook/assets/siastats.png new file mode 100644 index 0000000..7886e0b Binary files /dev/null and b/.gitbook/assets/siastats.png differ diff --git a/.gitbook/assets/zen faucet funding.png b/.gitbook/assets/zen faucet funding.png new file mode 100644 index 0000000..3d1867f Binary files /dev/null and b/.gitbook/assets/zen faucet funding.png differ diff --git a/README.md b/README.md index 8d05bd9..722d5cb 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,60 @@ --- -description: >- - Whether you're brand new to the Sia community or just need a refresher on the - basics, this article will get you up to speed. +cover: .gitbook/assets/header.jpeg +coverY: 0 --- -# Welcome to Sia! +# Introduction -Sia is a decentralized cloud storage platform secured by blockchain technology. The Sia storage network leverages underutilized hard drive capacity around the world to create a data storage marketplace that is more reliable and lower cost than traditional cloud storage providers. Sia has its own blockchain, and a utility token that powers it – the Siacoin. +## Welcome to the Sia Docs! -Your data is truly private and gets stored across the globe to eliminate any single point of failure and ensure the highest possible uptime. Since you hold the keys, you own your data. No outside company can access or control your files. +The Sia Docs is your gateway to the remarkable world of decentralized cloud storage. Whether you're a tech-savvy enthusiast or someone who simply wants to explore the potential of the decentralization of cloud storage and data security, you've come to the right place! -Data cannot be de-platformed. Files can not be hacked. +Our documentation aims to provide a comprehensive source of information and serve as a beacon of knowledge for anyone interested in embracing the power of decentralized cloud storage. -## Sia is here for good +The information in these docs has been taken from a number of sources, primarily the previous Sia Support Center and community-driven sites like the [Sia Wiki](https://web.archive.org/web/20180921135627/https://siawiki.tech/index), [SiaStats](https://siastats.info), and [SiaSetup](https://siasetup.info), and we aim educate our communitiy with what Sia has to offer! -Not only is your data safe on Sia, but you can feel confident that Sia isn't going anywhere. Sia has been in development for six years and has been live for five. The Sia software has been downloaded over a million times, and thousands of TB have been uploaded to the network since its inception. If the Sia dev team quit tomorrow, the network can autonomously run forever. +## Submitting your edits -Sia has a thriving community of renters, hosts, miners, data storage enthusiasts and an ecosystem of open source software and commercial data storage platforms. Discover the ecosystem on our [website's community and ecosystem page](https://sia.tech/community-ecosystem). +Keeping our documentation current is a substantial undertaking, and with GitBook, we've opened the door for community members to actively contribute ideas. Whether you want to suggest edits to existing content or create entirely new articles, you have the power to do so. +{% hint style="warning" %} +All submissions, undergo a review and approval process by a member of the team, which means your commit won't be merged immediately. +{% endhint %} +{% hint style="warning" %} +You must have a GitHub account to submit an edit proposal. If you haven't already, please log in or create a GitHub account before you proceed. +{% endhint %} -*** +1. To edit and submit a proposal via GitBook, click the **Page actions** (ellipsis) in the upper right corner of any page and click **Edit on GitHub**. -
+

Selecting the page actions, and edit on Github

-

Twitter

+After clicking **Edit on GitHub**, you'll be taken directly to the corresponding page on GitHub. - +2. Next, click **Edit the file** (pencil icon) to begin editing the markdown file. -

Youtube

+

Editing the markdown file via Github

- +{% hint style="info" %} +Simply toggle the **Preview** button to see how the Markdown will be formatted on the GitBook documentation. +{% endhint %} -

Discord

+3. Once you make your changes/additions to the markdown, click the **Commit Changes** button in the top right corner. Remember to do the following: + * Select the **"Create a new branch for the commit and start a pull request"** option. + * Add a reasonable title for this commit change(s) in the commit message textbox. + * In the extended description section, provide A brief description of the changes/additions made in this commit. If possible provide any links to resources that help you with your decision to contribute. - +

Committing changes and edits via Github

-

Reddit

+4. Once you're satisfied, click **Commit Changes** to submit your proposal - +## Further assistance -

Github

+Couldn’t find your answer here in our documentation? Don’t worry, we have more support options for you. - +Join the `#help` channel in the [Sia Discord](https://discord.com/invite/sia) where we have a huge community that loves helping users with their issues. -

Forum

+You can also [send us an email.](mailto:hello@sia.tech) We’ll respond as soon as we can. - -

Blog

-
diff --git a/SUMMARY.md b/SUMMARY.md index c6a02d6..424fccd 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,57 +1,49 @@ # Table of contents -* [Welcome to Sia!](README.md) +* [Introduction](README.md) ## Get Started with Sia -* [Introduction](get-started-with-sia/intro.md) -* [🚧 Learn about Sia](get-started-with-sia/sia101.md) -* [🚧 Learn about Siacoins](get-started-with-sia/learn-about-siacoins.md) -* [🚧 The importance of your seed](get-started-with-sia/the-importance-of-your-seed.md) +* [Learn about Sia](get-started-with-sia/sia101.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) * [Siacoin Total Supply](get-started-with-sia/siacoin-total-supply.md) ## Renting -* [🚧 About Renting on Sia](renting/about-renting.md) +* [About Renting on Sia](renting/about-renting.md) * [Setting up renterd](renting/setting-up-renterd/README.md) - * [🚧 Linux](renting/setting-up-renterd/linux.md) * [macOS](renting/setting-up-renterd/macos.md) - * [🚧 Windows](renting/setting-up-renterd/windows.md) -* [📷 Transferring Siacoins](renting/transferring-siacoins.md) + * [✏ Windows](renting/setting-up-renterd/windows.md) + * [✏ Linux](renting/setting-up-renterd/linux.md) +* [Transferring Siacoins](renting/transferring-siacoins.md) * [Renting Storage](renting/renting-storage.md) -* [Managing Files](renting/managing-your-files.md) -* [🚧 Renting FAQ](renting/renting-faq.md) +* [Managing your Files](renting/managing-your-files.md) ## Hosting * [About Hosting on Sia](hosting/about-hosting-on-sia.md) -* [🚧 Setting up hostd](hosting/setup-guides/README.md) - * [Linux](hosting/setup-guides/linux.md) +* [Setting up hostd](hosting/setup-guides/README.md) * [macOS](hosting/setup-guides/macos.md) - * [Windows](hosting/setup-guides/windows.md) -* [🚧 Transferring Siacoins](hosting/transferring-siacoins.md) -* [🚧 Adding Storage](hosting/adding-storage.md) -* [🚧 Configuring your Host](hosting/configuring-your-host.md) -* [🚧 Announcing your Host](hosting/announcing-your-host.md) -* [Dynamic DNS](hosting/dynamic-dns/README.md) - * [DuckDNS](hosting/dynamic-dns/duckdns.md) - * [Cloudflare (Advanced)](hosting/dynamic-dns/cloudflare-advanced.md) + * [✏ Windows](hosting/setup-guides/windows.md) + * [✏ Linux](hosting/setup-guides/linux.md) +* [Transferring Siacoins](hosting/transferring-siacoins.md) +* [Adding Storage](hosting/adding-storage.md) +* [Configuring your Host](hosting/configuring-your-host/README.md) + * [Dynamic DNS](hosting/configuring-your-host/dynamic-dns/README.md) + * [DuckDNS](hosting/configuring-your-host/dynamic-dns/duckdns.md) + * [Cloudflare](hosting/configuring-your-host/dynamic-dns/cloudflare-advanced.md) +* [Announcing your Host](hosting/announcing-your-host.md) * [Hosting FAQ](hosting/hosting-faq.md) ## Wallet * [About walletd](wallet/wallet-overview.md) * [Setting up walletd](wallet/setting-up-walletd/README.md) - * [📸 Linux](wallet/setting-up-walletd/linux.md) * [macOS](wallet/setting-up-walletd/macos.md) * [📸 Windows](wallet/setting-up-walletd/windows.md) + * [📸 Linux](wallet/setting-up-walletd/linux.md) * [Transferring Siacoins](wallet/transferring-siacoins.md) -* [🚧 Wallet FAQ](wallet/wallet-faq.md) - -## Mining - -* [About Mining on Sia](mining/about-mining-on-sia.md) -* [Sia mining pools](mining/sia-mining-pools.md) ## Siafunds @@ -61,14 +53,13 @@ ## Sia Integrations -* [🚧 Listing Siacoin on your exchange](sia-integrations/listing-siacoin-on-your-exchange.md) * [Using Sia Ledger app with Sia Central](sia-integrations/using-the-sia-ledger-nano-app-sia-central.md) * [Using the Sia Ledger Nano app with CLI](sia-integrations/using-the-sia-ledger-nano-app-cli.md) -* [🚧 Brand Guidelines](sia-integrations/sia-brand-guidelines.md) +* [Brand Guidelines](sia-integrations/sia-brand-guidelines.md) ## Testnet -* [🚧 What is Zen?](testnet/what-is-zen.md) +* [✏ Zen Testnet](testnet/zen-testnet.md) ## Miscellaneous diff --git a/get-started-with-sia/intro.md b/get-started-with-sia/intro.md deleted file mode 100644 index aea3bf1..0000000 --- a/get-started-with-sia/intro.md +++ /dev/null @@ -1,35 +0,0 @@ -# Introduction - -The goal of the Sia Docs is to be a comprehensive source of Sia information. Info in these docs has been taken from a number of sources, primarily the previous Sia Support Center and community-driven sites like the Sia Wiki, SiaStats, and SiaSetup. Thanks to these sites and the many others that have contributed to the Sia ecosystem over the years. - -Keeping docs up to date is no small task, and GitBook allows anyone in the community to submit an edit to a document, or even a completely new article on their own. While we still need to review and approve submissions, the pipeline to getting docs updated is significantly cleaner than it used to be. - -While this site can be updated by our users, a community never suffers from having too many resources. Where this site takes a targeted approach to onboarding new users and getting them up and running, another site might take a more philosophical approach. Yet another might focus on metrics. There's nothing wrong with redundancy – the entire Sia network is based on it. - -### Submit your edits! - -You can edit these docs by submitting a proposal in the [GitHub repo](https://github.com/SiaFoundation/docs). The simplest way is to click **Edit on GitHub** under the **ellipsis (...)** which appears in the upper right corner of every page. - -

Edit on Github

- -You'll be taken to GitHub, which is a website that lets multiple people collaborate on code. The code, in this case, is our support document. - -Login or create a GitHub account, then click **Edit the file in your fork of this project**. - -
- -Because you're contributing, you're not directly editing the file. This helps prevent people from vandalizing the site. You're making a fork of the support docs, which is your own little version of them where can you make any edits you want. - -Once you make your changes, scroll down to the bottom. Add a title to your edits, and a description that lets us know what you're changing and why. Click **Propose changes**. - -![](../.gitbook/assets/intro-3.png) - -This sends it to us. It won't be live right away – we have to review and approve your edits first. But this gives the community an incredible way to contribute to Sia documentation. - -## What to do if you need more help. - -Couldn’t find your answer here? Don’t worry, we have more support options for you. - -Join the #help channel in [the Sia Discord server.](https://sia.tech/discord) We have a huge community that loves helping users with their issues. - -You can also [send us an email.](mailto:hello@sia.tech) We’ll respond as soon as we can. diff --git a/get-started-with-sia/learn-about-siacoins.md b/get-started-with-sia/learn-about-siacoins.md index 6abab09..e397a28 100644 --- a/get-started-with-sia/learn-about-siacoins.md +++ b/get-started-with-sia/learn-about-siacoins.md @@ -1,40 +1,68 @@ -# 🚧 Learn about Siacoins +--- +cover: ../.gitbook/assets/header.jpeg +coverY: 0 +--- -## What are Siacoins? +# Learn about Siacoins -Siacoins are the utility tokens that power the Sia network. This article is included early on because anything you want to do on the network requires Siacoins. +## Siacoins: The Power Behind Sia Network -Siacoins are used in lots of ways but serve a single purpose – facilitating network operations. When you upload files to Sia, you pay for that storage in Siacoins. If you're a host and you're storing other people's data, you get paid for that in Siacoins. If you own Siafunds, your share of Sia network growth is paid out in, you guessed it, Siacoins. +Siacoins (SC) are the utility tokens powering the Sia network and are essential for any activity on the network. Siacoins (SC) serve a singular purpose – facilitating network operations – yet are utilized in various ways such as: -You can send Siacoins to others, or receive them at your own wallet address. You can store them in our official software, or on a hardware or paper wallet. You can get Siacoins by having someone send them to you, buying them on an exchange, or mining them. +* Uploading files to Sia, you use Siacoins to pay for storage. +* Earning Siacoins (SC) for storing others' data. +* Transferring by sending them to others or receiving them at your wallet address. -New Siacoins are made through proof-of-work mining. There are over 40 billion Siacoins out there right now, and that number will never stop growing. Sia is going to be the storage layer of the internet, and billions will be required for the petabytes and exabytes of data that will be stored on Sia. +Siacoins (SC) can be securely stored using our [official software](https://sia.tech/software/walletd), on a hardware wallet, or a paper wallet. Initially obtaining Siacoins (SC) is simple through methods such as having someone send them to you, purchasing them on an exchange, or engaging in mining activities. -## Where to buy Siacoins +New Siacoins (SC) are created through proof-of-work mining. Currently, there are over 40 billion Siacoins in circulation, and this number will continue to increase. Sia is poised to become the foundational storage layer of the internet, necessitating billions of Siacoins to accommodate the petabytes and exabytes of data that will be stored on our platform. -Whether you want to upload files to the decentralized cloud or lend your extra storage space to the network, you need Siacoins to use Sia. Siacoins can be sent to you once you make a Sia address, or you can mine them. Otherwise, you’ll need to buy them. +## How to obtain Siacoins -Siacoins are available on a number of major exchanges like Binance, Kraken, Upbit, and Poloniex. Get the full list [here](https://sia.tech/community-ecosystem?software=exchanges#software). +Whether you want to upload files to the decentralized cloud or lend your 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. -Some exchanges support direct fiat (local currency) to Siacoin purchases, but others require you to buy Bitcoins, Ethereum, or other crypto to make your purchase. We’ll walk you through the process of buying your first Siacoins. +### Buy from an exchange -### Buy SC from an exchange +Siacoins (SC) are listed on several prominent and can access the complete list of exchanges where Siacoins (SC) are available on our [official website](https://sia.tech/community-ecosystem?software=exchanges#software). Purchasing Siacoins (SC) from an exchange typically offers competitive prices but may involve a relatively steep learning curve for new users. -This option gets you the best prices but has a fairly intense on-ramp for a new user. +{% 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. +{% endhint %} -This example will use [Kraken](https://kraken.com), a US-based exchange that allows you to trade regular US dollars (USD), BTC, ETH, or USDT for Siacoins. But the general process will be similar no matter which exchange you use. +{% hint style="warning" %} +For those new to cryptocurrency purchases, it's advisable to begin with a modest amount until you feel confident and familiar with the process. +{% endhint %} -* [Sign up for an account](https://bittrex.zendesk.com/hc/en-us/articles/115005329167-Creating-a-Bittrex-Account-and-Performing-Verification) with Kraken. The process is simple, but fairly long and requires identity verification along the way. -* Once signed up, find the market you’re interested in. Purchase directly with [USD](https://bittrex.com/Market/Index?MarketName=USD-SC) or [Bitcoin](https://bittrex.com/Market/Index?MarketName=BTC-SC). -* Make a trade by specifying how many Siacoins you want to buy, and at what price. +Exchange wallets may not always be the ideal choice for storing cryptocurrencies, and will not serve the intended purpose of using Sia effectively. Now that you have Siacoins (SC), you're now able to transfer them to either [`renterd`](../renting/transferring-siacoins.md), [`hostd`](../hosting/transferring-siacoins.md) or [`walletd`](../wallet/transferring-siacoins.md) Sia wallet address. -{% hint style="warning" %} -If this is your first time purchasing crypto, start with a small amount until you’re comfortable with it. +### Receiving from others + +By sharing your generated Sia wallet address, Siacoins can be sent to you in a few minutes. Ensure the full address is without any extra spaces, and provide this address to whomever you're receiving the funds from. + +You can also receive Siacoins, simply share your QR code for others to scan and send funds to your wallet. + +

renterd Sia wallet address and QR code

+ +### Mining on the network + +\ +When you mine on a cryptocurrency network, you contribute computing power to help process and verify transactions on that network. Miners are the backbone of the network, verifying the integrity of the blockchain. On Sia, miners are rewarded with Siacoins (SC) for their services. + +Our [official website](https://sia.tech/community-ecosystem?software=mining\_pools) shows a list of mining pools for Siacoins (SC). Please see their individual 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 (SC) is paid out to those who mined the block. + +Unlike Bitcoin and some other cryptocurrency blockchains, the Sia block reward never stops and gives infinite rewards. This means that miners will always have an incentive to be part of Sia. Once the block reward reaches 30,000 coins, it stays there forever. + +{% 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 – which was reached at block 270,000 (300,000 - block height). {% endhint %} -* Now you have the Siacoins in your Kraken wallet, but exchange wallets aren’t a good place to store crypto, and you can’t use it for its intended purpose - using Sia. -* Transfer to your Sia wallet by [making a Sia address](broken-reference) and then withdrawing from Kraken. +#### Proof-of-work + +The Sia blockchain operates on Proof-of-Work, ensuring the integrity of transactions and contracts. Whether it's 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. + -Then enter in your SC address [that you made](broken-reference), and click **Buy Now** again to proceed through the transaction process. -## diff --git a/get-started-with-sia/sia101.md b/get-started-with-sia/sia101.md index 3744e52..a152373 100644 --- a/get-started-with-sia/sia101.md +++ b/get-started-with-sia/sia101.md @@ -1,54 +1,64 @@ --- -description: Let's take it from the top. +cover: ../.gitbook/assets/header.jpeg +coverY: 0 --- -# 🚧 Learn about Sia +# Learn about Sia -Sia has a few important terms that you'll want to get familiar with. These will be explained in more detail in their related sections, but here's a short sample. +The Sia Foundation is a non-profit organization committed to the advancement and enhancement of the Sia decentralized storage network. Our vision revolves around a future where individuals have complete ownership of their data. This future is one devoid of walled gardens, vendor lock-in, or the risk of a single provider having access to your information or holding your files hostage. Sia paves the way for this future by establishing a trustless marketplace where peers can directly buy and sell cloud storage. -* **Node:** Your instance or installation of Sia. -* **Renter:** Someone who uploads files to the network. -* **Host:** Someone who lends their storage space so others can upload files to the network. -* **Contracts:** Formed between renter and host, contracts determine how much data is being stored, for how long, and at what price. These are automatically tracked and completed by the software and blockchain. -* **Siacoins:** The cryptocurrency that powers Sia. -* **Siafunds:** A secondary, revenue-sharing token on the network that grants the holder Siacoins for every completed contract. +Sia is a decentralized cloud storage platform secured by blockchain technology. The Sia storage network leverages underutilized hard drive capacity around the world to create a data storage marketplace that is more reliable and lower cost than traditional cloud storage providers. Sia has its own blockchain, and a utility token that powers it – the Siacoin (SC). -## What Sia does +At the heart of Sia's philosophy are principles such as privacy, high performance, and robust engineering. Our primary objective is to bring the power of decentralization to data storage. We aim to empower you with full, exclusive control over your data, ensuring it remains safeguarded against theft, censorship, and unwarranted access. With Sia, your data truly belongs to you, and our documentation is here to guide you in harnessing the capabilities of this revolutionary platform. -When a file gets uploaded to Sia, it gets split up, encrypted, and sent all over the world. Renters upload files, hosts store those files, and everything is automated. Once you upload your files, the network ensures that they're always accessible to you by copying them multiple times. And they're never accessible to hosts because they only receive pieces of whole files that are already encrypted. +## Genesis of Sia -## Why it's here +Sia was conceived at HackMIT in 2013 by David Vorick and Luke Champine. The founders formed Nebulous Labs and later Skynet Labs to develop Sia. More recently, the Sia Foundation was formed as a non-profit dedicated to leading core development into the future. -Sia’s core goal is to bring decentralization to data storage. We want you to be able to store your data in a way that gives you full, exclusive control. We want to ensure you're protected against theft and censorship, and that you are never denied access to your data by hackers, miners, or developers. Your data belongs to you. +## ELI5: Understanding how Sia works -## Who makes Sia? +When a file is uploaded to Sia, it undergoes a process of fragmentation, encryption, and global distribution. Renters are responsible for uploading files, while hosts store these files, and the entire operation is automated. After uploading your files, the network guarantees continuous accessibility by creating multiple copies. Furthermore, hosts are never granted access to these files as they only receive encrypted fragments of the complete files. -Sia was conceived at HackMIT in 2013 by David Vorick and Luke Champine. The founders formed Nebulous Labs and later Skynet Labs to develop Sia. More recently, the Sia Foundation was formed as a non-profit dedicated to leading core development into the future. +Your data remains genuinely private and is distributed across the globe, eliminating any single point of failure and guaranteeing the utmost uptime reliability. As you hold the encryption keys, you retain full ownership of your data. No external entity can access or exert control over your files. + +Data cannot be subject to de-platforming, and your files are impervious to hacking attempts. + +### **Renting on Sia** + +Uploading files to Sia automatically designates you as a renter within the network. As a renter, you can upload your files to hosts—other users who have allocated their storage capacity for this purpose. + +The term 'renter' is employed because Sia initiates contracts with these hosts. These contracts specify the quantity of data to be stored, the duration of storage, and the associated cost. + +### Hosting on Sia + +Hosting on Sia signifies your commitment to providing surplus storage capacity to the network. By doing so, you actively contribute to the core principle of safeguarding data in the hands of its rightful owners—the renters. + +In return for your hosting services, you earn Siacoin, the cryptocurrency fueling the Sia network. Siacoin can be utilized to acquire your own storage space or exchange for other cryptocurrencies or fiat currencies on various crypto exchanges. + +Hosts play a pivotal role within the ecosystem, serving as indispensable contributors to the decentralized network that forms the heart of Sia. + +## Core software -## **Renting on Sia** +The Sia Foundation has developed a suite of scalable, high-performing, and easy-to-integrate software. -When you upload files to Sia, you become a **renter**. You upload files to other users who have made their space available, called **hosts**. We use the term renter because Sia creates contracts with other hosts: +### renterd -* to store a certain amount of data -* for a certain period of time -* for a certain amount of money +`renterd` aims to serve the needs of both everyday users -- who want a simple interface for storing and retrieving their data -- and developers -- who want a powerful, flexible, and reliable API for building apps on Sia. -## Hosting on Sia +### hostd -**Hosting** means you are contributing your excess storage space to Sia. You're helping to keep data where it belongs – safely in the hands of those who uploaded it, the **renters**. +`hostd` is designed to enhance the experience for storage providers within the Sia network. Tailored for both individual and large-scale storage providers, `hostd` boasts a user-friendly interface and a robust API, empowering providers to efficiently manage their storage resources and revenue. -You also earn Siacoin, the cryptocurrency that powers the Sia network. Siacoin can be used to purchase your own storage space, or converted to other cryptocurrency or fiat on crypto exchanges. +`hostd` incorporates an embedded web UI, simplifying deployment and enabling remote management capabilities, ensuring a smooth user experience across a diverse range of devices. -Hosts are a critical part of the ecosystem. You are contributing to the decentralized network that is the heart of Sia. +### walletd -## The Sia core software +`walletd` serves as a watch-only wallet server within the Sia ecosystem. It operates without access to any private keys, solely managing addresses derived from those keys. Its primary function is to monitor the blockchain for events about specific addresses. -The Sia Foundation has been developing a new suite of software that improves on `siad` and takes a more modular approach, with separate software for renting, hosting, wallet, and explorer. The software is generally more scalable, performant, and easier to integrate. +The server maintains knowledge of spendable outputs within the wallet, enabling it to aid in the creation and broadcasting of transactions that utilize these outputs. However, it is crucial to note that the exclusive task of signing transactions remains the responsibility of the client. -The new software is: +## We're here for good! -* **`renterd`** is a next-generation Sia renter, developed by the Sia Foundation. It aims to serve the needs of both everyday users -- who want a simple interface for storing and retrieving their personal data -- and developers -- who want a powerful, flexible, and reliable API for building apps on Sia. -* **`hostd`** is an advanced Sia host solution created by the Sia Foundation, designed to enhance the experience for storage providers within the Sia network. Tailored for both individual and large-scale storage providers, `hostd` boasts a user-friendly interface and a robust API, empowering providers to efficiently manage their storage resources and revenue. `hostd` incorporates an embedded web UI, simplifying deployment and enabling remote management capabilities, ensuring a smooth user experience across a diverse range of devices. -* **`walletd`** is a watch-only wallet server. It does not have access to any private keys, only addresses derived from those keys. Its role is to watch the blockchain for events relevant to particular addresses. The server therefore knows which outputs are spendable by the wallet at any given time, and can assist in constructing and broadcasting transactions spending those outputs. However, _signing_ transactions is the sole responsibility of the client. -* **`explored`** An explorer backend for Sia. +Not only is your data secure when using Sia, but you can also rest assured that Sia is here to stay. Sia has been in operation since 2015, with its software being downloaded over a million times. Moreover, thousands of terabytes of data have been uploaded to the network since its inception. Even if the Sia development team were to step away tomorrow, the network can continue to function autonomously indefinitely. +Sia has a thriving community of renters, hosts, miners, and data storage enthusiasts and an ecosystem of open-source software and commercial data storage platforms. Discover the community ecosystem on our [official website](https://sia.tech/community-ecosystem). diff --git a/get-started-with-sia/siacoin-total-supply.md b/get-started-with-sia/siacoin-total-supply.md index 27a18e8..9a8d244 100644 --- a/get-started-with-sia/siacoin-total-supply.md +++ b/get-started-with-sia/siacoin-total-supply.md @@ -1,10 +1,15 @@ +--- +cover: ../.gitbook/assets/header.jpeg +coverY: 0 +--- + # Siacoin Total Supply Siacoins are the utility token powering the Sia network and are intended to be used for the fulfillment of smart storage contracts on the decentralized network. ## So what's the total supply? -**Unlimited** – there will never be a cap on the number of Siacoins generated. Humans produce so much data that it is effectively a limitless amount – and when Sia is the industry-standard storage layer of the Internet, the network will need lots of Siacoins to fulfill all those contracts. Additionally, the Proof of Burn mechanic (more on this later) functions to eliminate coins from the supply, so there needs to be a constant allowance of new Siacoins being created. As of March 23, 2021, about 47.3 billion coins have been created, but the number of new coins introduced will slow as each new block is produced. By 2022, there should be about 50 billion coins in circulation. +**Unlimited** – there will never be a cap on the number of Siacoins generated. Humans produce so much data that it is effectively a limitless amount – and when Sia is the industry-standard storage layer of the Internet, the network will need lots of Siacoins to fulfill all those contracts. As of March 23, 2021, about 47.3 billion coins have been created, but the number of new coins introduced will slow as each new block is produced. By 2022, there should be about 50 billion coins in circulation. Additionally, if the block reward were to stop, miners would be disincentivized to continue providing their service to the network. diff --git a/get-started-with-sia/the-importance-of-your-seed.md b/get-started-with-sia/the-importance-of-your-seed.md index 1d8513c..77efc60 100644 --- a/get-started-with-sia/the-importance-of-your-seed.md +++ b/get-started-with-sia/the-importance-of-your-seed.md @@ -1,37 +1,38 @@ -# 🚧 The importance of your seed +--- +cover: ../.gitbook/assets/header.jpeg +coverY: 0 +--- -Your Sia seed is your key to your Siacoin balance, and in the future, it will be the key to your files as well. It’s the most important piece of information in your Sia experience. +# Your Sia Seed -## About the seed +Your Sia Seed holds the key to your Siacoin balance access to your files as well. It stands as the cornerstone of your Sia journey and the most important piece of information in your entire Sia experience. -* It’s 29 words... most of the time. There's a small chance you'll get a 28-word seed. -* It's generated when you first make your Siacoin wallet -* It will also be your wallet password unless you set a custom password -* If you have your correct seed, you can always recover your Siacoin balance. +## About the Seed -### Loss +* Sia is using BIP 39 with 128 bits of entropy and is made up of 12 words to generate your Seed. +* Your Seed is generated when you first create your Siacoin (SC) wallet in `renterd`, `hostd` or `walletd`. +* You can always recover your Siacoin balance using your Sia Seed. -If you lose your seed, your Siacoin balance will be permanently inaccessible. Because Sia is truly decentralized, the Sia dev team can’t access your seed at any time, for any reason. +## Ways of keeping your Seed safe -### Theft +Ensuring the safety of your Sia seed is of utmost importance. It's crucial to follow the proper procedures for securely storing it. Just like any other valuable digital information, never rely on its safety unless you have multiple separate backups in place. -If someone steals your seed, they can easily steal your Siacoin balance. Be wary of giving any untrusted third party your seed. +* **Use a Hardware Wallet:** Hardware wallets are considered one of the most secure methods for storing seeds, as they are offline and less susceptible to hacking. +* **Create a Paper Backup:** Write down your seed on paper and store it securely. Make multiple copies and keep them in different safe locations. +* **Use a Strong Password:** Encrypt your seed with a strong, unique password and store it separately from the seed. +* **Use a Biometric:** Keep your seed in a biometric secure app that relies on Opt into using unique physical identity verification. +* **Memorize Your Seed:** If possible, memorize your seed. However, ensure it's something you can remember accurately without writing it down. -### Keep it safe +{% hint style="warning" %} +A single incorrectly written word or mistyped letter renders the entire seed invalid, making it impossible to access your wallet or retrieve your Siacoins. Store it exactly as it was originally provided to you. +{% endhint %} -Because your seed is so important, you should have physical and digital methods of storing it safely. As with any piece of digital information that you care about, you shouldn't consider it safe unless you have multiple independent backups. +{% hint style="danger" %} +### Lost or Stolen -* Store it the same way it's given to you: all lower-case letters, with a space between each word. -* Make sure there is no space at the beginning or end of the seed. +If you lose your seed, your Siacoin balance will become **permanently** inaccessible. Since Sia operates as a fully decentralized platform. -#### Physically Safe +**The Sia development team cannot access your seed under any circumstances.** -Keep a laminated paper copy stored in a locked safe or a bank safety deposit box. - -#### Digitally Safe - -Keep your seed in a password or biometric (e.g., fingerprint) secured app like 1Password or LastPass. - -## Make sure it's correct - -Once you write it down, copy and paste it, or re-type it, ensure you've done so correctly. A single miswritten word or mistyped letter means the entire seed is incorrect and can no longer be used to unlock your wallet or recover your Siacoin. +In the unfortunate event that someone steals your seed, they will have the ability to easily abscond with your Siacoin balance. Thus, exercise utmost caution when it comes to sharing your seed with any third party that you do not fully trust. +{% endhint %} diff --git a/hosting/about-hosting-on-sia.md b/hosting/about-hosting-on-sia.md index 16ece10..0ca5ef2 100644 --- a/hosting/about-hosting-on-sia.md +++ b/hosting/about-hosting-on-sia.md @@ -2,14 +2,12 @@ description: >- Learn about the concepts and terms you'll need to be familiar with to host on the Sia network. +cover: ../.gitbook/assets/leaves.png +coverY: 0 --- # About Hosting on Sia -{% hint style="info" %} -Get started hosting on Sia with the official [`hostd` software](https://sia.tech/software/hostd). -{% endhint %} - **Hosting** means you are contributing your excess storage space to the Sia network. You're helping to keep data where it belongs – safely in the hands of those who uploaded it, the **renters**. You also earn Siacoins, the cryptocurrency that powers the Sia network. Siacoins can be used to purchase your own storage space, or converted to other cryptocurrency or fiat on crypto exchanges. @@ -27,11 +25,14 @@ As a host, you set your own prices. There are a lot of specific price points you ## **About Contracts** -Storage contracts are one of the most important features of the Sia network. They are what allow the entire Sia ecosystem to work in a trustless way – they form blockchain-enforced contracts between you and the people who rent your storage space that are automatically fulfilled. +Storage contracts are one of the most important features of the Sia network. They are what allow the entire Sia ecosystem to work in a trustless way – they form blockchain-enforced contracts between you and the people who store your data that are automatically fulfilled when each party meets their obligation. In other words, they let you form contracts with people you don't know to store your data, and they can't steal your money. + +* **Renters** are tasked with paying the host, and they are charged solely for the data storage they utilize. +* **Hosts** are responsible for data storage and receive compensation only after demonstrating successful storage. ## Earn Siacoins -As a host, you're part of a marketplace where you compete with other hosts for renter contracts. Competition should drive prices down, and demand should drive prices up. The goal is a market where people can upload their data with maximum security, minimum cost, and at fair rates that provide revenue to the hosts. +As a host, you're part of a marketplace where you compete with other hosts for storage contracts. Competition should drive prices down, and demand should drive prices up. The goal is a market where people can upload their data with maximum security, minimum cost, and at fair rates that provide revenue to the hosts. ## Fees @@ -43,7 +44,7 @@ Having collateral incentivizes hosts to be online and to keep their renter data ## Host Scoring -One of the most important factors that determine how you'll fair as a host is your host score. This is based on a number of metrics – some that you can directly affect, some that improve or diminish over time based on your performance. +One of the most important factors that determines success as a host is your score. This is based on a number of metrics – some that you can directly affect, some that improve or diminish over time based on your performance. Sia is a decentralized network - the code to evaluate these scoring metrics is contained within each renter's Sia instance. For that reason, each Sia renter you encounter builds their own host score for your host, so your host may be scored differently among different renters. Your host does not have one overall score across the Sia network, but many scores with many renters based on the metrics described below. Any website or service showing your Sia host rank is showing that particular source's view of your host, which may be different from what a renter comes up with. @@ -51,12 +52,12 @@ Sia is a decentralized network - the code to evaluate these scoring metrics is c {% tabs %} {% tab title="Host Uptime" %} -Host uptime is an incredibly important metric. You need to be online when people try to get their data, and since that might be anytime, you should be online all the time. You're allowed a small amount of downtime in order to address minor maintenance issues like restarting for updates, which amounts to approximately 14 hours per month. +to Host uptime is an incredibly important metric. You need to be online when people try to get their data, and since that might be any time, you should be online all the time. You're allowed a small amount of downtime in order to address minor maintenance issues like restarting for updates, which amounts to approximately 14 hours per month. In general, you should plan for your hosting computer to be turned on and online 24/7. If you can't commit to this, you shouldn't try to host on the Sia network. {% hint style="danger" %} -Warning: If you go offline for too long (less than 95% uptime) or lose renter data (by deleting it or experiencing a hardware failure), you can lose money by losing your collateral for active contracts. You can also become responsible for SiaFund fees for each contract. +Warning: If you go offline for too long (less than 80% uptime) or lose renter data (by deleting it or experiencing a hardware failure), you can lose money by losing your collateral for active contracts. You can also become responsible for SiaFund fees for each contract. {% endhint %} Below are the exact amounts that your score will change based on your uptime percentage. Greater than 98% uptime results in no penalty, which is the 14 hours a month explained above (2% of 720 hours in a month = 14 hours). @@ -142,10 +143,16 @@ Stay updated. Your host score drops if you're not running the latest version of We have an incredible community building on Sia. Third-party sites can develop their own methods for scoring hosts based on various metrics. For example, SiaStats has developed a [Host Monitor](https://siastats.info/hosts) which evaluates hosts on pricing relative to other hosts, and even evaluates host performance regularly by forming contracts with every host it can in order to test bandwidth and latency. SiaStats even has great visualization for each host to make judging their metrics easier. -These benchmarks are different from the core Sia protocol, but are still useful, and may be used to help monitor and improve your own host over time. +These benchmarks are different from the core Sia protocol but are still useful, and may be used to help monitor and improve your own host over time. Once you've started hosting, you'll probably want to keep an eye on your host score and see how you might be able to improve your host ranking. -## Software -The `hostd` software is how you offer storage on Sia. Software downloads can be found on the [`hostd` page](https://sia.tech/software/hostd) of the official website. + +{% hint style="info" %} +## **Getting Started with `hostd`** + +Contributing your storage space couldn't be any simpler by using Sia's `hostd` software! + +Get started hosting on Sia with the official [`hostd` software](https://sia.tech/software/hostd) and exploring our step-by-step [Setting up hostd ](setup-guides/)guide. +{% endhint %} diff --git a/hosting/adding-storage.md b/hosting/adding-storage.md index 78aa9be..756a997 100644 --- a/hosting/adding-storage.md +++ b/hosting/adding-storage.md @@ -1,21 +1,30 @@ -# 🚧 Adding Storage +--- +cover: ../.gitbook/assets/leaves.png +coverY: 0 +--- -## Add storage +# Adding Storage -A "volume" is a location on disk where `hostd` will store uploaded data. A volume can be anywhere, including network drives and external drives. You can create multiple volumes to combine storage from multiple drives. To add a volume: +When Hosting on Sia, you're required to allocate a location on your disk that `hostd` will store any uploaded data from renters. This is referred to as **volume**. -1. Click the "Volume" icon in the sidebar -2. Click the "Create Volume" button to add your first storage volume. +**Volume** can be located anywhere on the local or external drives, and you can create multiple volumes to combine storage from multiple drives. -

hostd create volume

+## Creating volume -1. Enter a name for the volume. We recommend something simple, like "hostdata.dat" -2. Use the built-in browser to select a folder to store the volume file. -3. Enter a maximum size for the volume. This is the maximum amount of data that can be stored in the volume. -4. Click "Create" to add the volume to \`hostd\` +Go to `hostd`. If you're asked to unlock the UI, use your custom password if you've set one. If you haven't got a wallet set up `hostd`, visit our [Setting up `hostd`](setup-guides/) guide otherwise choose from the sidebar **Volume**. -After clicking "Create," the volume will be displayed in the volumes list. Depending on the size of the volume and the filesystem, it may take a while to fully provision the new volume. The progress will be displayed in the UI. +Click on the **Create Volume** button in the top right-hand corner. -

hostd volume list

+1. Enter a name for the volume. We recommend something simple, like _hostdata1.dat_ or _data1.dat._ +2. Now select a folder to store the volume file. +3. Lastly, enter a maximum size for the volume. This is the maximum amount of data that can be stored in the volume. -### +

Creating volume on hostd

+ +4. Click **Create** to add the volume to `hostd`. + +### Checking the status + +After clicking **Create**, the volume will be displayed in the volumes list. Depending on the size of the volume and the filesystem, it may take a while to fully provision the new volume. The progress will be displayed in the UI. + +

hostd Volume list

diff --git a/hosting/announcing-your-host.md b/hosting/announcing-your-host.md index 6475a1b..5fbe273 100644 --- a/hosting/announcing-your-host.md +++ b/hosting/announcing-your-host.md @@ -1,19 +1,34 @@ -# 🚧 Announcing your Host +--- +cover: ../.gitbook/assets/leaves.png +coverY: 0 +--- -Now that your host has finished syncing, you can announce your host to the network. This will publish your host's net address and public key to the blockchain so renters can connect to your host and form contracts. The announcement transaction costs a small amount of Siacoins, which will be deducted from your wallet. +# Announcing your Host -To announce your host: +Now that your host has been configured and finished syncing, you can announce your host to the network. -1. Click the "Configuration" icon in the sidebar -2. Click the "Announce" button in the top right corner of the page -3. Click "Announce" in the dialog to confirm +Announcing your host serves as the bridge between your fully prepared host and potential renters seeking storage solutions. This process publishes information about your host, including its network address and public key, onto the blockchain, allowing renters to discover your host and establish contracts. -\ +{% hint style="warning" %} +An announcement transaction incurs a small fee in Siacoins (SC), which will be deducted from your wallet. Ensure your `hostd` wallet is funded by checking out [Transferring Siacoins](transferring-siacoins.md). +{% endhint %} +Go to `hostd`. If you're asked to unlock the UI, use your custom password if you've set one. If you haven't got a wallet set up `hostd`, visit our [Setting up `hostd`](setup-guides/) guide otherwise choose from the sidebar **Configuration**. +Click on the **Announce** button in the top right-hand corner. -\ +

Confirming the announcement of your host

+ +Finally, check the announcement fee and click **Announce** in the dialog to confirm. + +{% hint style="success" %} +Congratulation! Your host has now been successfully announced to the network and is now ready to be discovered by renters and establish contracts. +{% endhint %} ## Check your host's status -Once the announcement is confirmed you can check if your host is visible on the network by going to [https://troubleshoot.siacentral.com](https://troubleshoot.siacentral.com/). Enter your host's net address and click "Check Host". This tool will connect to your host and notify you of any issues. +Once the announcement is confirmed you can check if your host is visible on the network by going to [here](https://troubleshoot.siacentral.com). + +

SiaCentral Troubleshooter

+ +Enter your host's network address and click **Check Host**. This tool will connect to your host and notify you of any issues. diff --git a/hosting/configuring-your-host.md b/hosting/configuring-your-host.md deleted file mode 100644 index 8a8001d..0000000 --- a/hosting/configuring-your-host.md +++ /dev/null @@ -1,51 +0,0 @@ -# 🚧 Configuring your Host - -## Configure the host - -Now that you have a volume, you can configure your host. First, navigate to the "Configuration" page in the sidebar. This page contains all of the pricing and settings available to hosts. - -

hostd configuration page

- -### Accepting contracts - -The first setting to configure is the "Accepting Contracts" setting. This setting determines whether your host will accept new contracts. Most hosts will always have this toggled on. However, if you want to exit the network you can toggle this off to stop accepting new contracts. You will still be required to fulfill any existing contracts before fully shutting down your host. - -### Address - -The next setting to configure is your host's net address. This is the address that is published to the blockchain and used by renters to connect to your host. Some users use their public IP address, but we recommend setting up a domain. You can use a free service like DuckDNS or No-IP or purchase a custom domain from a registrar. - -Whichever method you choose, enter your address in the "Net Address" field followed by your host's RHP2 port, which defaults to `:9982`. For example, if your IP address is `199.111.78.80` you would enter `199.111.78.80:9982`. If your domain is `example.com`, you would enter `example.com:9982`. - -

Configure netaddress

- -#### Setup using Dynamic DNS - -* [Cloudflare](dynamic-dns/cloudflare-advanced.md) -* [DuckDNS](dynamic-dns/duckdns.md) -* [No-IP](broken-reference) - -#### Setup using public IP - -To find your public IP address click the following link: [https://icanhazip.com](https://icanhazip.com). It will display your public IP address. Copy this address to your clipboard. - -### Pricing - -On the Sia network, hosts set their prices for storage and bandwidth. The prices you select will determine how much you earn from hosting. - -{% hint style="info" %} -When setting prices, remember you are competing with other hosts. If your prices are too high, renters will choose other hosts. If your prices are too low, you will not earn enough to cover your costs. -{% endhint %} - -We've put together some recommendations for pricing below. These are just recommendations, you can set your prices to whatever you want and change your prices at any time. Hosts will need to experiment with different prices to find the right balance between earnings and utilization. - -* **Storage price:** the amount of Siacoins you charge per TB per month of storage. We recommend around $1 USD per TB per month to start. -* **Collateral:** the amount of Siacoins you lock per TB per month of storage. This should always be set to 2x your storage price. For example, if your storage price is 100 SC/TB/mo, you should set your collateral to 200 SC/TB/mo. -* **Ingress price:** the amount of Siacoins you charge per TB of data uploaded to your host. We recommend setting this low to encourage renters to upload data. Between $0.00 and $0.05 USD per TB. -* **Egress price:** the amount of Siacoins you charge per TB of data downloaded from your host. We recommend setting this higher to increase your earnings, above $5 USD per TB is a good starting point. -* **Maximum collateral:** the maximum amount of Siacoins you will lock into a single contract for collateral. This setting is important to limit your risk per contract. A good starting point is However, if you refuse to lock enough collateral for the data a renter wants to store, they will choose another host. Therefore, we recommend setting this around 10x your collateral price. For example, if your collateral price is 200 SC/TB/mo, you should set your maximum collateral to 2000 SC/TB/mo. - -We recommend leaving other settings, such as "Contract price", "Base RPC price", "Sector access price," and "Price table validity" at their default values. They are primarily for advanced users. - -Once you are happy with your prices, click the "Save Changes" button in the top right corner of the page. - -### diff --git a/hosting/configuring-your-host/README.md b/hosting/configuring-your-host/README.md new file mode 100644 index 0000000..6acc1d0 --- /dev/null +++ b/hosting/configuring-your-host/README.md @@ -0,0 +1,75 @@ +--- +cover: ../../.gitbook/assets/leaves.png +coverY: 0 +--- + +# Configuring your Host + +Setting up your host on Sia also involves configuring essential parameters such as storage, bandwidth, and other critical variables. These configurations are vital to maintaining the health of your host, ensuring it can effectively provide storage services to renters, and determining how much you earn from hosting. + +Go to `hostd`. If you're asked to unlock the UI, use your custom password if you've set one. If you haven't got a wallet set up `hostd`, visit our [Setting up `hostd`](../setup-guides/) guide otherwise choose from the sidebar **Configuration**. + +## Host + +### Accepting contracts + +The **Accepting Contracts** setting determines whether your host will accept new contracts. Most hosts will always have this toggled on. However, if you want to exit the network, you can toggle this off to stop accepting new contracts. You will still be required to fulfill any existing contracts before fully shutting down your host. + +### Address + +Setting the host's network **Address** is essential because it's published to the blockchain and used by renters to connect to your host. Some users use their public IP address, but we recommend setting up a domain. + +{% hint style="info" %} +You have several options for setting up Dynamic DNS. We recommend utilizing straightforward, no-cost services like [DuckDNS](dynamic-dns/duckdns.md) or [Cloudflare](dynamic-dns/cloudflare-advanced.md). Additionally, you can choose to purchase a custom domain from a registrar. + +Alternatively, you can set up a public IP address by clicking [here](https://icanhazip.com), which will display the public IP address that you can then copy to your clipboard. +{% endhint %} + +Enter your address followed by your host's RHP2 port (which defaults to `:9982`). + +For example: + +* If your IP address is `199.111.78.80` you would enter `199.111.78.80:9982`. +* If your domain is `example.com`, you would enter `example.com:9982`. + +{% hint style="warning" %} +In the **DNS** section of the host configuration, remember to also enable your chosen **Dynamic DNS Provider** if you opted for this option. +{% endhint %} + +## Pricing + +The prices you select will determine how much you earn from hosting. + +When setting your prices, you are in direct competition with other hosts. This means that should your prices be excessively high, renters may opt for alternative hosts. Conversely, if your prices are exceedingly low, you may not generate sufficient earnings to offset your operational expenses. + +Hosts are encouraged to explore a range of pricing options and make adjustments as needed to achieve the optimal balance between earnings and utilization. Nevertheless, we have provided the pricing recommendations table below for guidance. + +{% hint style="warning" %} +Please be aware that these recommendations are only suggestions, and you are free to modify your pricing at any time. +{% endhint %} + +| Variables | Description | Recommended Value | +| -------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------ | +| Storage price | The amount of Siacoins you charge per TB per month of storage. | **$1 USD per TB per month** | +| Egress price | The amount of Siacoins you charge per TB of data downloaded from your host. | **>$5.00 USD per TB** | +| **I**ngress price | The amount of Siacoins you charge per TB of data uploaded to your host | **Between $0.00 - $0.05 USD per TB** | +| Collateral Multiplier | The amount of Siacoins you lock per TB per month of storage | **2** | +| [Maximum collateral](#user-content-fn-1)[^1] | The maximum amount of Siacoins you will lock into a single contract for collateral. | **(Storage Price \* Collateral Multiple) \* 10** | +| Contract price | The base price to form or renew a contract with the host. | **0.2 SC** | +| Base RPC price | The price to execute an RPC. Its added to any additional cossts from the RPC. | **1 SC/Million** | +| Sector access price | The base price to read a sector from a disk. It's added to any other costs from the host. | **1 SC/Million** | +| Price table validity | The length of time a renter's registered price table remains valid. | **30 Minutes** | + +Click the **Save Changes** button in the top right corner of the page. + +## Waiting for sync + +Now that you have configured your host, you must wait for your host to finish syncing the blockchain. You can check the progress of the sync by mousing over the Sia logo at the top of the sidebar. + +

Checking the status of hostd syncing to the blockchain

+ +{% hint style="info" %} +Blockchain syncing can take several hours or even days depending on your hardware and internet connection. Make sure to have a stable internet connection to ensure your changes are made to your host. +{% endhint %} + +[^1]: It's important to set this to limit the risk per contract diff --git a/hosting/dynamic-dns/README.md b/hosting/configuring-your-host/dynamic-dns/README.md similarity index 100% rename from hosting/dynamic-dns/README.md rename to hosting/configuring-your-host/dynamic-dns/README.md diff --git a/hosting/dynamic-dns/cloudflare-advanced.md b/hosting/configuring-your-host/dynamic-dns/cloudflare-advanced.md similarity index 100% rename from hosting/dynamic-dns/cloudflare-advanced.md rename to hosting/configuring-your-host/dynamic-dns/cloudflare-advanced.md diff --git a/hosting/dynamic-dns/duckdns.md b/hosting/configuring-your-host/dynamic-dns/duckdns.md similarity index 100% rename from hosting/dynamic-dns/duckdns.md rename to hosting/configuring-your-host/dynamic-dns/duckdns.md diff --git a/hosting/setup-guides/README.md b/hosting/setup-guides/README.md index b6b8a39..6e69430 100644 --- a/hosting/setup-guides/README.md +++ b/hosting/setup-guides/README.md @@ -1,2 +1,2 @@ -# 🚧 Setup Guides +# Setting up hostd diff --git a/hosting/setup-guides/linux.md b/hosting/setup-guides/linux.md index b8cd58e..9c6bedd 100644 --- a/hosting/setup-guides/linux.md +++ b/hosting/setup-guides/linux.md @@ -13,7 +13,7 @@ layout: visible: true --- -# Linux +# ✏ Linux This guide will walk you through setting up a new `hostd` node on Linux. For this guide, we are using Ubuntu, but the steps should work with most Linux distros. At the end of this guide, you should have a working `hostd` node on the Sia network and be ready to accept contracts from renters. @@ -144,119 +144,6 @@ If you do not have a desktop environment:

hostd login

-## Send Siacoin to your wallet - -Before you can start hosting, you must send Siacoin to your wallet. Hosts must lock Siacoin as collateral to ensure they are financially incentivized to store data. Hosts also need Siacoin to submit storage proofs to the blockchain. Therefore, it is essential to always keep your wallet funded with Siacoin. If your wallet runs out of Siacoin, your host cannot submit storage proofs and you will lose collateral. - -To send Siacoin to your `hostd` wallet, you must get the wallet's address which can be found on the "Wallet" page of the `hostd` UI. - -{% hint style="info" %} -It is okay if your wallet is not synced at this point. You can still send funds to your wallet. However, they will not be available until the wallet is fully synced. -{% endhint %} - -We recommend around $50 USD worth of Siacoin to start hosting. Hosts are constantly locking collateral; you may need more or less depending on how much data you store. - -1. Navigate to the "Wallet" page by clicking the "Wallet" icon in the sidebar -2. Click the "Receive" button in the top right corner of the page -3. Copy your wallet address by clicking the "Copy" button or scan the QR code with your phone - -

hostd wallet address

- -## Add storage - -A "volume" is a location on disk where `hostd` will store uploaded data. A volume can be anywhere, including network drives and external drives. You can create multiple volumes to combine storage from multiple drives. To add a volume: - -1. Click the "Volume" icon in the sidebar -2. Click the "Create Volume" button to add your first storage volume. - -

hostd create volume

- -1. Enter a name for the volume. We recommend something simple, like "hostdata.dat" -2. Use the built-in browser to select a folder to store the volume file. -3. Enter a maximum size for the volume. This is the maximum amount of data that can be stored in the volume. -4. Click "Create" to add the volume to \`hostd\` - -After clicking "Create," the volume will be displayed in the volumes list. Depending on the size of the volume and the filesystem, it may take a while to fully provision the new volume. The progress will be displayed in the UI. - -

hostd volume list

- -## Configure the host - -Now that you have a volume, you can configure your host. First, navigate to the "Configuration" page in the sidebar. This page contains all of the pricing and settings available to hosts. - -

hostd configuration page

- -### Accepting contracts - -The first setting to configure is the "Accepting Contracts" setting. This setting determines whether your host will accept new contracts. Most hosts will always have this toggled on. However, if you want to exit the network you can toggle this off to stop accepting new contracts. You will still be required to fulfill any existing contracts before fully shutting down your host. - -### Address - -The next setting to configure is your host's net address. This is the address that is published to the blockchain and used by renters to connect to your host. Some users use their public IP address, but we recommend setting up a domain. You can use a free service like DuckDNS or No-IP or purchase a custom domain from a registrar. - -Whichever method you choose, enter your address in the "Net Address" field followed by your host's RHP2 port, which defaults to `:9982`. For example, if your IP address is `199.111.78.80` you would enter `199.111.78.80:9982`. If your domain is `example.com`, you would enter `example.com:9982`. - -

Configure netaddress

- -#### Setup using Dynamic DNS - -* [Cloudflare](../dynamic-dns/cloudflare-advanced.md) -* [DuckDNS](../dynamic-dns/duckdns.md) - -#### Setup using public IP - -To find your public IP address click the following link: [https://icanhazip.com](https://icanhazip.com). It will display your public IP address. Copy this address to your clipboard. - -### Pricing - -On the Sia network, hosts set their prices for storage and bandwidth. The prices you select will determine how much you earn from hosting. - -{% hint style="info" %} -When setting prices, remember you are competing with other hosts. If your prices are too high, renters will choose other hosts. If your prices are too low, you will not earn enough to cover your costs. -{% endhint %} - -We've put together some recommendations for pricing below. These are just recommendations, you can set your prices to whatever you want and change your prices at any time. Hosts will need to experiment with different prices to find the right balance between earnings and utilization. - -* **Storage price:** the amount of Siacoins you charge per TB per month of storage. We recommend around $1 USD per TB per month to start. -* **Collateral:** the amount of Siacoins you lock per TB per month of storage. This should always be set to 2x your storage price. For example, if your storage price is 100 SC/TB/mo, you should set your collateral to 200 SC/TB/mo. -* **Ingress price:** the amount of Siacoins you charge per TB of data uploaded to your host. We recommend setting this low to encourage renters to upload data. Between $0.00 and $0.05 USD per TB. -* **Egress price:** the amount of Siacoins you charge per TB of data downloaded from your host. We recommend setting this higher to increase your earnings, above $5 USD per TB is a good starting point. -* **Maximum collateral:** the maximum amount of Siacoins you will lock into a single contract for collateral. This setting is important to limit your risk per contract. A good starting point is However, if you refuse to lock enough collateral for the data a renter wants to store, they will choose another host. Therefore, we recommend setting this around 10x your collateral price. For example, if your collateral price is 200 SC/TB/mo, you should set your maximum collateral to 2000 SC/TB/mo. - -We recommend leaving other settings, such as "Contract price", "Base RPC price", "Sector access price," and "Price table validity" at their default values. They are primarily for advanced users. - -Once you are happy with your prices, click the "Save Changes" button in the top right corner of the page. - -## Port forwarding - -If you have a firewall or router, you will need to forward/open TCP ports 9981-9983. How to do so is outside of the scope of this guide; there are tutorials available for most routers/firewalls available on Google. - -## Waiting for sync - -Now that you have configured your host, you must wait for your host to finish syncing the blockchain. This can take several hours or even days depending on your hardware and internet connection. You can check the progress of the sync by mousing over the "Sia" logo at the top of the sidebar. - -

check sync status

- -## Announce your host - -Now that your host has finished syncing, you can announce your host to the network. This will publish your host's net address and public key to the blockchain so renters can connect to your host and form contracts. The announcement transaction costs a small amount of Siacoins, which will be deducted from your wallet. - -To announce your host: - -1. Click the "Configuration" icon in the sidebar -2. Click the "Announce" button in the top right corner of the page -3. Click "Announce" in the dialog to confirm - -

announce your host

- -After announcing, an "Unconfirmed" transaction will appear on the "Wallet" page. Once it is confirmed, your host will be visible on the network and renters will be able to form contracts with your host. - -

unconfirmed announcement transaction

- -## Check your host's status - -Once the announcement is confirmed you can check if your host is visible on the network by going to [https://troubleshoot.siacentral.com](https://troubleshoot.siacentral.com/). Enter your host's net address and click "Check Host". This tool will connect to your host and notify you of any issues. - ## Updating It is very important to keep your host up to date. New versions of hostd are released regularly and contain bug fixes and performance improvements. diff --git a/hosting/setup-guides/macos.md b/hosting/setup-guides/macos.md index 33cac0f..f15eb7f 100644 --- a/hosting/setup-guides/macos.md +++ b/hosting/setup-guides/macos.md @@ -8,7 +8,7 @@ This guide will walk you through setting up `hostd` on macOS. At the end of this * **Installed Sia `hostd` software:** You should have successfully installed the Sia `hostd` software on your macOS system with the appropriate binary. * **Functional `hostd` Node:** Your hostd node will be fully functional and operational on the Sia network. It will be ready to engage in various network activities, including contract negotiation, storage provision, and transaction handling. -* Created a `hostd` wallet: Have created a wallet with a Seed to access and manage your Sia network transactions and store your Siacoins in `hostd`. +* Created a `hostd` wallet: Created a wallet with a Seed to access and manage your Sia network transactions and store your Siacoins in `hostd`. ## Pre-requisites @@ -43,7 +43,7 @@ Remember to check which version to download to ensure it works correctly with yo

macOS Download folder

-2. Now that we have downloaded `hostd`, you may need unzip it and move it to a more accessible location: +2. Now that we have downloaded `hostd`, you may need to unzip it and move it to a more accessible location: * Double-click on the downloaded `hostd` zip file to unzip it if it hasn't done so automatically. * Click on the newly unzipped directory. * Right-click on the path bar at the bottom of the Finder window and click "Open in Terminal". @@ -77,7 +77,7 @@ hostd 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. Find out [more](../../get-started-with-sia/the-importance-of-your-seed.md) about the importance of your seed. +If you lose this phrase, you will lose access to your wallet and funds. Find out more about [Your Sia Seed](../../get-started-with-sia/the-importance-of-your-seed.md) and why it is important. {% endhint %} You will also see the wallet's funding address. You can send Siacoin to this address to fund your host. @@ -107,7 +107,7 @@ You can also set the `HOSTD_SEED` and `HOSTD_API_PASSWORD` environment variables

Starting hostd

-Your terminal will produce a range of different values you may not be familiar with, so feel free to check the tabs below to see what each of them are and why they are important: +Your terminal will produce a range of different values you may not be familiar with, so feel free to check the tabs below to see what each of them is and why they are important: {% tabs %} {% tab title="p2p" %} @@ -160,32 +160,6 @@ Enter your `API password` you created in the in the previous step to unlock `hos Congratulations on successfully setting up `hostd` and taking a significant step towards contributing your excess storage space to the Sia network. {% endhint %} -## Waiting for sync - -Now that you have configured your host, you must wait for your host to finish syncing the blockchain. This can take several hours or even days depending on your hardware and internet connection. You can check the progress of the sync by mousing over the "Sia" logo at the top of the sidebar. - -

check sync status

- -## Announce your host - -Now that your host has finished syncing, you can announce your host to the network. This will publish your host's net address and public key to the blockchain so renters can connect to your host and form contracts. The announcement transaction costs a small amount of Siacoins, which will be deducted from your wallet. - -To announce your host: - -1. Click the "Configuration" icon in the sidebar -2. Click the "Announce" button in the top right corner of the page -3. Click "Announce" in the dialog to confirm - -

announce your host

- -After announcing, an "Unconfirmed" transaction will appear on the "Wallet" page. Once it is confirmed, your host will be visible on the network and renters will be able to form contracts with your host. - -

unconfirmed announcement transaction

- -## Check your host's status - -Once the announcement is confirmed you can check if your host is visible on the network by going to [https://troubleshoot.siacentral.com](https://troubleshoot.siacentral.com/). Enter your host's net address and click "Check Host". This tool will connect to your host and notify you of any issues. - ## Updating It is very important to keep your host up to date. New versions of hostd are released regularly and contain bug fixes and performance improvements. diff --git a/hosting/setup-guides/windows.md b/hosting/setup-guides/windows.md index 336fdcc..47fe66c 100644 --- a/hosting/setup-guides/windows.md +++ b/hosting/setup-guides/windows.md @@ -2,7 +2,7 @@ description: Setup a new host on Windows --- -# Windows +# ✏ Windows This guide will walk you through setting up a new `hostd` node on Windows. For this guide, we are using Windows 11, but the steps should also work with Windows 10. At the end of this guide, you should have a working `hostd` node on the Sia network and be ready to accept contracts from renters. @@ -27,7 +27,7 @@ For this guide, we will download the Windows version and unzip the `hostd` binar Windows Defender may flag \``` hostd` `` as a virus. This is a false positive. You can add an exception to Windows Defender (read more here: [https://go.dev/doc/faq#virus](https://go.dev/doc/faq#virus)) {% endhint %} -

hostd in the Windows file explorer

+

hostd in the Windows file explorer

## Creating a wallet @@ -36,7 +36,7 @@ Windows Defender may flag \``` hostd` `` as a virus. This is a false positive. Y 1. Open Explorer and browse to the folder where you unzipped `hostd.exe` (in our case `C:\hostd`) 2. Hold the SHIFT key and right-click in the folder, then click `Open command window here` -

Open command window on Windows

+

Open command window on Windows

In the command prompt, run the following command to create a new wallet: @@ -44,7 +44,7 @@ In the command prompt, run the following command to create a new wallet: hostd.exe seed ``` -

Generate a new recovery phrase

+

Generate a new recovery phrase

After pressing enter, a new 12-word recovery phrase will be generated. Please write down this phrase and keep it in a safe place. You will need this phrase to recover your wallet. If you lose this phrase, you will lose access to your wallet and funds. You will also see the wallet's funding address. You can send Siacoin to this address to fund your host. @@ -62,7 +62,7 @@ You will be asked to input a password and a wallet recovery phrase. The password You can also set the `HOSTD_SEED` and `HOSTD_API_PASSWORD` environment variables so you do not have to reenter the values every time. {% endhint %} -

hostd startup message

+

hostd startup message

After entering your password and recovery phrase, `hostd` will start. You can now access the `hostd` UI by opening a browser and going to `http://localhost:9980`. Enter your password to unlock `hostd`. @@ -70,120 +70,7 @@ After entering your password and recovery phrase, `hostd` will start. You can no You must leave the command prompt window open while `hostd` is running. If you close the command prompt window, `hostd` will stop. {% endhint %} -

hostd login

- -## Send Siacoin to your wallet - -Before you can start hosting, you must send Siacoin to your wallet. Hosts must lock Siacoin as collateral to ensure they are financially incentivized to store data. Hosts also need Siacoin to submit storage proofs to the blockchain. Therefore, it is essential to always keep your wallet funded with Siacoin. If your wallet runs out of Siacoin, your host cannot submit storage proofs and you will lose collateral. - -To send Siacoin to your `hostd` wallet, you must get the wallet's address. This can be found on the "Wallet" page of the `hostd` UI. - -{% hint style="info" %} -It is okay if your wallet is not synced at this point. You can still send funds to your wallet. However, they will not be available until the wallet is fully synced. -{% endhint %} - -We recommend around $50 USD worth of Siacoin to start hosting. Hosts are constantly locking collateral; you may need more or less depending on how much data you store. - -1. Navigate to the "Wallet" page by clicking the "Wallet" icon in the sidebar -2. Click the "Receive" button in the top right corner of the page -3. Copy your wallet address by clicking the "Copy" button or scan the QR code with your phone - -

hostd wallet address

- -## Add storage - -A "volume" is a location on disk where `hostd` will store uploaded data. A volume can be anywhere, including network drives and external drives. You can create multiple volumes to combine storage from multiple drives. To add a volume: - -1. Click the "Volume" icon in the sidebar -2. Click the "Create Volume" button to add your first storage volume. - -

hostd add volume

- -1. Enter a name for the volume. We recommend something simple, like "hostdata.dat" -2. Use the built-in browser to select a folder to store the volume file. -3. Enter a maximum size for the volume. This is the maximum amount of data that can be stored in the volume. -4. Click "Create" to add the volume to \`hostd\` - -After clicking "Create," the volume will be displayed in the volumes list. Depending on the size of the volume and the filesystem, it may take a while to fully provision the new volume. The progress will be displayed in the UI. - -

hostd volume list

- -## Configure the host - -Now that you have a volume, you can configure your host. First, navigate to the "Configuration" page in the sidebar. This page contains all of the pricing and settings available to hosts. - -

hostd configuration page

- -### Accepting contracts - -The first setting to configure is the "Accepting Contracts" setting. This setting determines whether your host will accept new contracts. Most hosts will always have this toggled on. However, if you want to exit the network you can toggle this off to stop accepting new contracts. You will still be required to fulfill any existing contracts before fully shutting down your host. - -### Address - -The next setting to configure is your host's net address. This is the address that is published to the blockchain and used by renters to connect to your host. Some users use their public IP address, but we recommend setting up a domain. You can use a free service like DuckDNS or No-IP or purchase a custom domain from a registrar. - -Whichever method you choose, enter your address in the "Net Address" field followed by your host's RHP2 port, which defaults to `:9982`. For example, if your IP address is `199.111.78.80` you would enter `199.111.78.80:9982`. If your domain is `example.com`, you would enter `example.com:9982`. - -

Configure netaddress

- -#### Setup using Dynamic DNS - -* [Cloudflare](../dynamic-dns/cloudflare-advanced.md) -* [DuckDNS](../dynamic-dns/duckdns.md) - -#### Setup using public IP - -To find your public IP address click the following link: https://icanhazip.com. It will display your public IP address. Copy this address to your clipboard. - -### Pricing - -On the Sia network, hosts set their prices for storage and bandwidth. The prices you select will determine how much you earn from hosting. - -{% hint style="info" %} -When setting prices, remember you are competing with other hosts. If your prices are too high, renters will choose other hosts. If your prices are too low, you will not earn enough to cover your costs. -{% endhint %} - -We've put together some recommendations for pricing below. These are just recommendations, you can set your prices to whatever you want and change your prices at any time. Hosts will need to experiment with different prices to find the right balance between earnings and utilization. - -* **Storage price:** the amount of Siacoins you charge per TB per month of storage. We recommend around $1 USD per TB per month to start. -* **Collateral:** the amount of Siacoins you lock per TB per month of storage. This should always be set to 2x your storage price. For example, if your storage price is 100 SC/TB/mo, you should set your collateral to 200 SC/TB/mo. -* **Ingress price:** the amount of Siacoins you charge per TB of data uploaded to your host. We recommend setting this low to encourage renters to upload data. Between $0.00 and $0.05 USD per TB. -* **Egress price:** the amount of Siacoins you charge per TB of data downloaded from your host. We recommend setting this higher to increase your earnings, above $5 USD per TB is a good starting point. -* **Maximum collateral:** the maximum amount of Siacoins you will lock into a single contract for collateral. This setting is important to limit your risk per contract. A good starting point is However, if you refuse to lock enough collateral for the data a renter wants to store, they will choose another host. Therefore, we recommend setting this around 10x your collateral price. For example, if your collateral price is 200 SC/TB/mo, you should set your maximum collateral to 2000 SC/TB/mo. - -We recommend leaving other settings, such as "Contract price", "Base RPC price", "Sector access price," and "Price table validity" at their default values. They are primarily for advanced users. - -Once you are happy with your prices, click the "Save Changes" button in the top right corner of the page. - -## Port forwarding - -If you have a firewall or router you will need to forward/open TCP ports 9981-9983. How to do so is outside of the scope of this guide, there are tutorials available for most routers/firewalls available on Google. - -## Waiting for sync - -Now that you have configured your host, you must wait for your host to finish syncing the blockchain. This can take several hours or even days depending on your hardware and internet connection. You can check the progress of the sync by mousing over the "Sia" logo at the top of the sidebar. - -

check sync status

- -## Announce your host - -Now that your host has finished syncing, you can announce your host to the network. This will publish your host's net address and public key to the blockchain so renters can connect to your host and form contracts. The announcement transaction costs a small amount of Siacoins, which will be deducted from your wallet. - -To announce your host: - -1. Click the "Configuration" icon in the sidebar -2. Click the "Announce" button in the top right corner of the page -3. Click "Announce" in the dialog to confirm - -

announce your host

- -After announcing, an "Unconfirmed" transaction will appear on the "Wallet" page. Once it is confirmed, your host will be visible on the network and renters will be able to form contracts with your host. - -

unconfirmed announcement transaction

- -## Check your host's status - -Once the announcement is confirmed you can check if your host is visible on the network by going to https://troubleshoot.siacentral.com. Enter your host's net address and click "Check Host". This tool will connect to your host and notify you of any issues. +

hostd login

## Updating diff --git a/hosting/transferring-siacoins.md b/hosting/transferring-siacoins.md index f86c88c..d33453a 100644 --- a/hosting/transferring-siacoins.md +++ b/hosting/transferring-siacoins.md @@ -1,17 +1,81 @@ -# 🚧 Transferring Siacoins +--- +cover: ../.gitbook/assets/leaves.png +coverY: 0 +--- -Before you can start hosting, you must send Siacoin to your wallet. Hosts must lock Siacoin as collateral to ensure they are financially incentivized to store data. Hosts also need Siacoin to submit storage proofs to the blockchain. Therefore, it is essential to always keep your wallet funded with Siacoin. If your wallet runs out of Siacoin, your host cannot submit storage proofs and you will lose collateral. +# Transferring Siacoins -To send Siacoin to your `hostd` wallet, you must get the wallet's address which can be found on the "Wallet" page of the `hostd` UI. +Whether you're sending Siacoins to an exchange or receiving from a friend, `hostd` facilitates the transfer of Siacoins (SC) and is easily achieved via the UI. + +## Sending Siacoins + +Go to `hostd`. If you're asked to unlock the UI, use your custom password if you've set one. If you haven't got a wallet set up `hostd`, visit our [Setting up `hostd`](setup-guides/) guide otherwise choose from the sidebar **Wallet**. + +### Setup your transaction + +Click on the `Send` button. Enter the recipient's wallet address and the amount of Siacoins you want to send. Make sure that you've entered a Siacoin wallet address, and that you've entered it correctly. + +

Sending Siacoins via hostd

+ +{% hint style="warning" %} +Siacoins sent to mistyped addresses, or addresses of other types of cryptocurrency can not be retrieved. +{% endhint %} + +Click **Generate Transaction.** + +### Confirm your info + +Next, you need to confirm everything. You'll have a chance to double-check the currency, amount, and recipient address. The window will also show you estimated network fees. + +

Confirming your transaction

+ +Click **Setup** to change something. If it's all good, click B**roadcast transaction**. + +

Confirmation of a successful transaction broadcasted

+ +You'll immediately get a confirmation that your transaction has been successfully broadcasted. + +### Checking the status + +By looking at the transactions in the **Wallet** section of the UI, you can check the transaction status. It's normal to 'Unconfirmed' at the latest transaction, as it means the transaction is on its way but hasn't yet appeared in a block. + +

hostd wallet transaction list

{% hint style="info" %} -It is okay if your wallet is not synced at this point. You can still send funds to your wallet. However, they will not be available until the wallet is fully synced. +It might take a minute or two for the transaction to pop up in the wallet's transactions list. {% endhint %} -We recommend around $50 USD worth of Siacoin to start hosting. Hosts are constantly locking collateral; you may need more or less depending on how much data you store. +Once it's in a block, you can go back to check the status and see a new transaction type of **siacoin transfer**. -1. Navigate to the "Wallet" page by clicking the "Wallet" icon in the sidebar -2. Click the "Receive" button in the top right corner of the page -3. Copy your wallet address by clicking the "Copy" button or scan the QR code with your phone +## Receiving Siacoins + +Before you can start hosting, you must have Siacoins (SC) in your `hostd` wallet for the following: + +* Locking Siacoin as collateral to ensure they are financially incentivized to store data. +* Submitting storage proofs to the blockchain. If your wallet runs out of Siacoin, your host cannot submit storage proofs and you will lose collateral. + +{% hint style="info" %} +We recommend around **$50 USD worth of Siacoin** to start hosting. Hosts are constantly locking collateral; you may need more or less depending on how much data you store. +{% endhint %} + +{% hint style="warning" %} +If your wallet isn't synchronized right now. You can still transfer funds to your wallet, but please note that they won't be accessible until the wallet is completely synced. +{% endhint %} + +Go to `hostd`. If you're asked to unlock the UI, use your custom password if you've set one. If you haven't got a wallet set up `hostd`, visit our [Setting up `hostd`](setup-guides/)otherwise choose from the **sidebar** a **Wallet**. + +### Sharing the address or QR + +Copy and paste your address manually, or use the **Copy** button to the right to make sure you get the full address without any extra spaces, and provide this address to whomever you're receiving the funds from. + +You can also receive Siacoins by sharing your QR code for others to scan too. + +

Getting the address and QR of your hostd wallet

+ +By going to your **Dashboard**, and selecting the wallet you made the transaction with, you can check the transaction status. It's normal to 'Unknown' at the top of the list of transactions, it means the transaction is on its way but hasn't yet appeared in a block. + +{% hint style="info" %} +It might take a minute or two for the transaction to pop up in the wallet's transactions list. +{% endhint %} -\ +Once it's in a block, you can go back to check the status and see a new transaction type of **siacoin transfer**. diff --git a/mining/about-mining-on-sia.md b/mining/about-mining-on-sia.md deleted file mode 100644 index 55111fe..0000000 --- a/mining/about-mining-on-sia.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -description: >- - This is a high level overview of mining. It's intended for those who are brand - new to Sia or need a refresher. ---- - -# About mining on Sia - -## Why Mine? - -When you mine on a cryptocurrency network, you are contributing computing power to help process and verify transactions on that network. On the Sia network, the blockchain contains not just Siacoin transactions, but also the smart file contracts between [renters](broken-reference) and [hosts](broken-reference). Miners are the backbone of the network, verifying the integrity of the blockchain. On Sia, miners are rewarded with Siacoins for their service. - -## The Block Reward - -The block reward is the miner's incentive to contribute their computing power and electricity cost to the network. When a block is successfully verified, or solved, an amount of Siacoins is paid out to those who mined the block. - -When the Sia network launched, the block reward was 300,000 Siacoins. This decreases by one every block, with a floor at 30,000 – which was reached at block 270,000 (300,000 - block height). - -### Infinite Reward - -Unlike Bitcoin and some other cryptocurrency blockchains, the Sia block reward never stops. This means that miners will always have an incentive to be part of Sia. Once the block reward reaches 30,000 coins, it stays there forever. - -## Proof-of-Work - -The Sia blockchain runs on something called Proof of Work. Blockchains are an amazing thing, and they are versatile enough to power different platforms. They might power money, like Bitcoin. They might power utility and smart storage contracts, like Sia. No matter what the blockchain is in charge of, you need to be sure that the money you send or the contracts you enter into never change. - -A blockchain needs to be correct. There's no bank to record a transaction, and no third party to verify the validity of a contract. The whole reason anyone trusts a blockchain is because you don't need to trust anyone – you can be sure that the Bitcoin you receive is really yours; that the storage space you've rented on Sia is really there for your data. - -A lot of cost and resources go into verifying the transactions of a blockchain. Proof of Work provides a powerful stamp that says ‘this history cannot be changed without doing a lot of work and spending a lot of money’. In practice, that is a powerful deterrent. - -## The Current State of Sia Mining - -### A Short History - -Until January of 2018, the Sia blockchain was mined almost exclusively with GPUs, or the graphics cards inside a computer. Building a mining rig was easy, and could be done using parts from Amazon or a local computer shop. - -The graphics card is the component in a computer that processes the visual output of your machine. High-end graphics cards are typically used by gamers or design professionals so they can render complex video, but they are also pretty adept at mining cryptocurrency. - -Shortly after, the first ASICs were introduced into the Sia ecosystem. An ASIC, short for Application-Specific Integrated Circuit, is a computer whose sole purpose is to mine cryptocurrency. Because it doesn't have to worry about the many other things a computer might do, it can focus on one thing and do it incredibly well. - -Imagine you bought a computer whose only function was to search for and download pictures of red cars. A team of engineers could program it to very specifically search for red cars, download them, and put them in folders based on how many doors they had, or if they were light red or dark red. And it could ignore pictures of blue cars and yellow cars very easily. This is what an ASIC does for cryptocurrency mining. - -**Because of ASICs, GPU mining is now no longer profitable.** diff --git a/mining/sia-mining-pools.md b/mining/sia-mining-pools.md deleted file mode 100644 index b3de0c9..0000000 --- a/mining/sia-mining-pools.md +++ /dev/null @@ -1,12 +0,0 @@ -# Sia mining pools - -Here are some mining pools you can use to get started. Please see their documentation to get started. - -[SiaMining](https://siamining.com) - -[Luxor](https://mining.luxor.tech) - -[DxPool](https://www.dxpool.com) - -[F2Pool](https://www.f2pool.com) - diff --git a/miscellaneous/getting-involved.md b/miscellaneous/getting-involved.md index 24cc9de..9001c8d 100644 --- a/miscellaneous/getting-involved.md +++ b/miscellaneous/getting-involved.md @@ -1,11 +1,9 @@ -# Getting Involved - -## Learn more about Sia +--- +cover: ../.gitbook/assets/header.jpeg +coverY: 0 +--- -Sia provides an abundant array of valuable resources and excels in nurturing others' understanding of the Sia network. - -* [SiaStats](http://siastats.info/) - Charts and metrics of the Sia network. -* [Sia's API](https://api.sia.tech) - The Sia Storage Platform API documentation. +# Getting Involved ## Contribute to Sia @@ -21,7 +19,7 @@ We have a wonderful community, and we hope you'll find your place there! Check t Join our socials to become a part of our thriving community, where you can actively engage with our ecosystem and fellow members while staying updated with the latest content, news, and developments! -
+

Twitter

diff --git a/miscellaneous/glossary.md b/miscellaneous/glossary.md index bb81c90..adae861 100644 --- a/miscellaneous/glossary.md +++ b/miscellaneous/glossary.md @@ -22,7 +22,7 @@ C -**`Contracts`:** Formed between renter and host, contracts determine how much data is being stored, for how long, and at what price. These are automatically tracked and completed by the software and blockchain. +**Contracts:** Formed between renter and host, contracts determine how much data is being stored, for how long, and at what price. These are automatically tracked and completed by the software and blockchain. @@ -64,7 +64,7 @@ H -**`Host`:** Someone who lends their storage space so others can upload files to the network. +**Host:** Someone who lends their storage space so others can upload files to the network. diff --git a/renting/about-renting.md b/renting/about-renting.md index 010b1e3..35a56e6 100644 --- a/renting/about-renting.md +++ b/renting/about-renting.md @@ -1,65 +1,56 @@ --- description: >- - This page talks about the basic and terms you need to know to start renting. + This page discusses the basics of renting and the terms you need to know. Later pages walk you through the specific process. +cover: ../.gitbook/assets/jungle.png +coverY: 0 --- -# 🚧 About Renting on Sia +# About Renting on Sia -{% hint style="info" %} -Get started renting on Sia with the official [`renterd` software](https://sia.tech/software/renterd). -{% endhint %} - -When you upload files on the Sia Storage Platform, you become a **renter**. You upload files to other users who have made their space available, called **hosts**. We use the term renter because Sia creates contracts with other hosts: - -* to store a certain amount of data (whatever you upload) -* for a certain period of time (13 weeks by default, and it auto-renews) -* for a certain amount of money (the market dictates the prices) +**Renting** on Sia means you upload files on the Sia storage network to other users who have made their space available, called **hosts**. The term **renter** is used to describe an individual or entity that creates storage contracts with **hosts**: -You store data on the network by: +* To store a certain amount of data. +* For a certain period of time. +* For a certain amount of Siacoin. -* setting an allowance -* uploading your files +## The Marketplace -## The marketplace +\ +The Sia storage network is an open marketplace to connect consumers with providers for their data. The cost associated with this storage is competitively determined by hosts and renters within the market. If hosts discover that reducing prices allows them to secure more data for storage, they are inclined to do so. Similarly, if renters are willing to pay higher rates for storage with high-quality hosts, those hosts may opt to increase their prices. -The Sia storage network uses a marketplace to find storage for your data. The cost of this storage, often referred to as **pricing**, is the market rate determined competitively by hosts and renters. If hosts find they can lower prices and win more data to store as a result, they'll do it. If renters are willing to pay more to store on high-quality hosts, those hosts might raise their prices. +The price of storage is denominated in Siacoins (SC), and you will need Siacoins (SC) to form storage contracts and upload data. Hosts have the autonomy to establish their own prices, fostering a competitive marketplace where top-quality and dependable hosts vie for storage contracts from those seeking to store data. Typically, network pricing averages around **$3 per terabyte per month** including 3x redundancy. -The price of storage is listed in Siacoins, the cryptocurrency used to buy and sell storage on the network. You'll need to [get Siacoins](https://sia.tech/community-ecosystem?software=exchanges#software) in order to upload files. The price of a Siacoin can vary just like the price of any cryptocurrency. This is usually stable for periods of time, but can sometimes have more significant shifts depending on the crypto trading markets. - -Fortunately, the price of Siacoin doesn't really affect the price of Sia storage. Hosts set their own prices, which creates a marketplace where the best and most reliable hosts are competing for the storage contracts of those who want to upload data. Pricing on the network usually works out to around **$2 per TB per month.** Using Sia becomes more cost-efficient as you upload more data and store it for longer periods of time. - -Siacoins are utility tokens and their sole purpose is to fulfill contracts on the Sia network. +{% hint style="info" %} +Siacoin (SC) is a utility token whose sole purpose is to fulfill contracts on the Sia network. +{% endhint %} ## **About contracts** -Storage contracts are one of the most important features of the Sia network. They are what allow the entire Sia ecosystem to work in a trustless way – they form blockchain-enforced contracts between you and the people who store your data that are automatically fulfilled when each party meets their obligation. In other words, they let you form contracts with people you don't know to store your data, and they can't steal your money. +Storage contracts are one of the most important features of the Sia network. They are what allow the entire Sia ecosystem to work in a trustless way – they form blockchain-enforced agreements between you and your storage providers that are automatically resolved when each party meets their obligation. In other words, they let you form contracts with people you don't know to store your data. -A host's job is to store the data, and they only get paid when they have proved they have done so. A renter's job is to pay the host, and they only pay for the data storage they use. +* **Hosts** are responsible for data storage and receive compensation only after demonstrating successful storage for the agreed-upon period of time. +* **Renters** are tasked with paying the host, and they are charged solely for the data storage they utilize. -By default storage contracts last for three months and are automatically formed when you start uploading your files. +By default, storage contracts last for three months and are automatically formed when you start uploading your files. ## **Fees** -As a renter, you pay for the cost of renting storage space. There are also some other fees that you're responsible for. +As a renter, you pay for the cost of renting storage space. There are also some other fees that you're responsible for such as: -* **Contract Formation Fees** – Creating storage contracts on the blockchain requires a transaction, and there are very small fees associated with this. Contract formation fees are one-time per contract, and usually cost only a handful of Siacoins (a few cents). +* **Contract Formation Fees** – Creating storage contracts on the blockchain requires a transaction, and there are very small fees associated with this. Contract formation fees are one-time per contract and usually cost only a handful of Siacoins (SC). * **Bandwidth Fees** – You pay for the bandwidth you use when you upload or download files. This can also include wear and tear fees set by the host to help pay for their physical storage devices. -Because contract formation fees only happen once, and your initial upload will consume a lot of bandwidth, using Sia for longer periods of time results in lower average costs. - ## **Autopilot and your Allowance** -By default the Sia rentering software `renterd` runs with a module called `autopilot` enabled. `autopilot` is the software agent that automatically forms contracts based on your configured parameters. The most important parameter is your "allowance", setting your allowance is the first thing you'll do when getting started with renting. - -The allowance tells Sia how much money you're willing to spend on storage space, and makes sure more than this amount is not deducted from your wallet. +By default, the Sia rentering software `renterd` runs with a module called `autopilot` enabled. `autopilot` is the software agent that automatically forms contracts based on your configured parameters. The most important parameter is your "allowance", setting your allowance is the first thing you'll do when starting renting. -Most people just set their allowance and forget it, but it's a good idea to check in periodically. Setting your allowance too low might mean that Sia can't upload all your data, or might not be able to form the contracts with other hosts to begin with. You can change your allowance at any time in Sia. - -If your allowance is too high, you might end up overpaying for storage you could have had at a lower price. +The allowance tells Sia how much Siacoin you're willing to spend on storage space, and makes sure more than this amount is not deducted from your wallet. Setting your allowance too low might mean that Sia can't upload all your data, or might not be able to form the contracts with enough hosts. You can raise or lower your allowance at any time. Setting your allowance happens before uploading files, and Sia starts to automatically form the contracts it needs with new hosts so that you can upload when you're ready. You might see multiple transactions hit your wallet right after setting your allowance – this is your Siacoins getting set aside with each host. Don't worry - you'll get whatever Siacoins that you don't spend back at the end of the contract. With Sia, you only ever pay for what you use. -## **Uploading files** +{% hint style="info" %} +## **Getting Started with `renterd`** -Uploading files is done using the `renterd` Sia software either via API or its user-interface which is accessible via web browser. +Get started with renting on Sia by downloading the official [renterd software](https://sia.tech/rent) and exploring our step-by-step [Setting up renterd](setting-up-renterd/) guide. +{% endhint %} diff --git a/renting/managing-your-files.md b/renting/managing-your-files.md index f93e1c2..6ef1675 100644 --- a/renting/managing-your-files.md +++ b/renting/managing-your-files.md @@ -1,6 +1,11 @@ -# Managing Files +--- +cover: ../.gitbook/assets/jungle.png +coverY: 0 +--- -## Maintaining Data +# Managing your Files + +## Maintaining your Data To ensure the constant availability of your data, there are a few crucial tasks you should perform periodically. diff --git a/renting/renting-faq.md b/renting/renting-faq.md deleted file mode 100644 index e02d497..0000000 --- a/renting/renting-faq.md +++ /dev/null @@ -1,15 +0,0 @@ -# 🚧 Renting FAQ - - - -
- -Is my data secure? - -Your data is incomparably safe when you use Sia. Sia is a fully decentralized cloud storage network. It has been operating since 2015, hundreds of terabytes are currently being stored on it, and thousands of terabytes have been stored over the years. - -The data normally on Sia gets split up, encrypted, and the pieces are then distributed all around the world to different hosts. - -Check out our <....> - -
diff --git a/renting/renting-storage.md b/renting/renting-storage.md index 2a6e12c..c4bfc64 100644 --- a/renting/renting-storage.md +++ b/renting/renting-storage.md @@ -1,17 +1,22 @@ +--- +cover: ../.gitbook/assets/jungle.png +coverY: 0 +--- + # Renting Storage Uploading files on `renterd` is remarkably straightforward, making it accessible even to those new to the Sia network. With just a few simple steps, you can securely store your files and data on Sia's decentralized cloud storage platform, where a network of hosts ensures the redundancy and reliability of your files. `renterd` provides an intuitive interface for effortlessly transferring your files to the Sia network. ## Before you begin... -* **Install `renterd`**: Make sure you have the latest version of `renterd` installed on your machine. +* **Install `renterd`**: Make sure you have the latest version of `renterd` installed on your machine. * **Create a Wallet**: If you haven't already, create a Sia wallet to store your Siacoins. * **Fund Your Wallet**: Transfer Siacoins (SC) to your Sia wallet from an exchange or another source. You'll need these coins to pay for storage. ## Uploading your files in renterd {% hint style="warning" %} -Uploading files and data using `renterd` is a very straightforward process, assuming you have completed all the steps of the `renterd` guide and it running. Visit the [renterd](setting-up-renterd/) guides ensure everything is set up correctly before proceeding. +Uploading files and data using `renterd` is a very straightforward process, assuming you have completed all the steps of the `renterd` setup guide. Visit the [renterd](setting-up-renterd/) guides to ensure everything is set up correctly before proceeding. {% endhint %} 1. Access the `rentered` UI from your local host address. Enter your `API password` you created to unlock `renterd`. @@ -22,7 +27,7 @@ Uploading files and data using `renterd` is a very straightforward process, assu

File upload UI

-Once you've chosen the file(s) to upload, it will be classed as active uploads, give it a few seconds. +Once you've chosen the file(s) to upload, it will be classed as active upload, give it a few seconds. {% hint style="success" %} Congratulations on successfully uploading your file(s) using `renterd`! Your data is now securely stored on the Sia network, benefiting from the reliability and resilience of decentralized storage. @@ -39,6 +44,6 @@ For the more technical readers, here is what happens behind the scenes: * Files are chunked into 40MB chunks (if a file is smaller, it is padded to 40MB so that data looks identical as it moves across networks) * Each chunk is then erasure-coded using [Reed-Solomon](https://en.wikipedia.org/wiki/Reed%E2%80%93Solomon\_error\_correction) encoding. After processing, each chunk has 30 unique 4MB pieces associated with it. -* Each piece is then encrypted using [Threefish](https://en.wikipedia.org/wiki/Threefish) and uploaded to a distinct host. -* Because Reed-Solomon encoding is done with 10 data shards and 20 parity shards, any 10 pieces are sufficient for rebuilding the file. +* Each piece is then encrypted using [ChaCha20](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) and uploaded to a distinct host. +* As Reed-Solomon encoding is done with 10 data shards and 20 parity shards, any 10 pieces are sufficient for rebuilding the file. {% endhint %} diff --git a/renting/setting-up-renterd/linux.md b/renting/setting-up-renterd/linux.md index 92ef896..e389259 100644 --- a/renting/setting-up-renterd/linux.md +++ b/renting/setting-up-renterd/linux.md @@ -1,3 +1,129 @@ -# 🚧 Linux +# ✏ Linux -This guide will walk you through setting up a new `renterd` on Linux. For this guide, we are using Ubuntu, but the steps should work with most Linux distros. At the end of this guide, you should have a working `renterd` +This guide will walk you through setting up `renterd` on Linux. At the end of this guide, you should have the following: + +* **Installed Sia `renterd` software:** Successfully installed the Sia `renterd` software on your Linux system with the appropriate binary. +* **Created a `renterd` wallet**: Have created a wallet with a Seed to access and manage your Sia network transactions and store your Siacoins in `renterd`. + +## 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 that your Linux version is compatible with the walletd software. Check [releases](../../miscellaneous/releases.md) supported Linux versions. +* **System Updates:** Ensure that your Linux is up to date with the latest system updates, as these updates can contain important security fixes and improvements. + +## Getting `renterd` + +1. Download the latest version of `renterd` for your operating system from the [official website](https://sia.tech/software/renterd). For the purpose of this guide, we'll be downloading the Linux version of `renterd` and unzip the binary to `/usr/local/bin`. + +{% hint style="warning" %} +Remember to check which version to download to ensure it works correctly with your operating system. To do this click on the Apple icon in the top left corner of your toolbar, then click on “About This Mac.” If the processor/chips says: + +* **Intel** - `MacOS AMD64` +* **M1 or M2** - `MacOS ARM64` +{% endhint %} + +

macOS Download folder

+ +2. Now that we have downloaded `renterd`, you may need to unzip it and move it to a more accessible location: + * Double-click on the downloaded `renterd` zip file to unzip it if it hasn't done so automatically. + * Click on the newly unzipped directory. + * Right-click on the path bar at the bottom of the Finder window and click "Open in Terminal". + +

Options after right-clicking

+ +3. In the opened terminal window, move the `renterd` binary to `/usr/local/bin` by running the following command and press enter: + +```bash +sudo mv renterd /usr/local/bin +``` + +

Moving renterd binary

+ +You'll be prompted to authorize this action by providing your system password. Type this in and press enter to continue. + +4. 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. + +```bash +mkdir ~/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: + +```bash +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. Find out [more](../../get-started-with-sia/the-importance-of-your-seed.md) about the importance of your seed. +{% endhint %} + +

Generating a recovery phrase

+ +## Running `renterd` + +1. In the same terminal, run the following command to start `hostd`: + +```bash +renterd --dir ~/renterd +``` + +You will be prompted input both: + +* `API password` - This password is chosen by you and can be anything you want it to be. It will be used to unlock the `renterd` UI via your browser, it 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 used 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. Check out this \
to set this. +{% endhint %} + +2. After entering your desired `API password` and the created `seed`, `hostd` will start. + +

Starting renterd

+ +Your terminal will produce a two different values you may not be familiar with, so feel free to check the tabs below to see what each of them are and why they are important: + +{% tabs %} +{% tab title="p2p" %} +**api (Application Programming Interface) Component:** + +* "api" refers to the application programming interface, which allows different software components to communicate and interact with each other. +* `Listening on 127.0.0.1:9980` indicates that the application's API component is actively waiting for incoming connections on the local loopback IP address `127.0.0.1` and the port `9980`. +{% endtab %} + +{% tab title="bus" %} + +{% endtab %} +{% endtabs %} + +3. You can now access the `renterd` UI by opening a browser and going to `http://localhost:9980`. + +{% hint style="warning" %} +Remember to leave the terminal window open while `hostd` is running. If you close the command prompt window, `hostd`will stop. +{% endhint %} + + + +

renterd Login UI

+ +Enter your `API password` you created in the 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 very important 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](https://sia.tech/software/renterd). +2. Stop the `renterd` service with the command `sudo systemctl stop renterd` +3. Unzip and replace `renterd` in `/usr/local/bin` with the new version +4. Restart `renterd` with `sudo systemctl start renterd` diff --git a/renting/setting-up-renterd/macos.md b/renting/setting-up-renterd/macos.md index 8ca7488..395ad3f 100644 --- a/renting/setting-up-renterd/macos.md +++ b/renting/setting-up-renterd/macos.md @@ -1,9 +1,9 @@ # macOS -This guide will walk you through setting up `renterd` on macOS. At the end of this guide, you should have the following: +This guide will walk you through setting up `renterd` on macOS. At the end of this guide, you should have: * **Installed Sia `renterd` software:** Successfully installed the Sia `renterd` software on your macOS system with the appropriate binary. -* **Created a `renterd` wallet**: Have created a wallet with a Seed to access and manage your Sia network transactions and store your Siacoins in `renterd`. +* **Created a `renterd` wallet**: created a wallet with a Seed to store your Siacoins in `renterd`. ## Pre-requisites @@ -13,7 +13,7 @@ This guide will walk you through setting up `renterd` on macOS. At the end of th ## Getting `renterd` -1. Download the latest version of `renterd` for your operating system from the [official website](https://sia.tech/software/renterd). For the purpose of this guide, we'll be downloading the macOS version of `renterd` and unzip the binary to `/usr/local/bin`. +1. Download the latest version of `renterd` for your operating system from the [official website](https://sia.tech/software/renterd). For the purpose of this guide, we'll be downloading the macOS version of `renterd` {% hint style="warning" %} Remember to check which version to download to ensure it works correctly with your operating system. To do this click on the Apple icon in the top left corner of your toolbar, then click on “About This Mac.” If the processor/chips says: @@ -58,38 +58,38 @@ 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. Find out [more](../../get-started-with-sia/the-importance-of-your-seed.md) about the importance of your seed. +If you lose this phrase, you will lose access to your wallet and funds. [Read more](../../get-started-with-sia/the-importance-of-your-seed.md) about the importance of your seed. {% endhint %}

Generating a recovery phrase

## Running `renterd` -1. In the same terminal, run the following command to start `hostd`: +1. In the same terminal, run the following command to start `renterd`: ```bash renterd --dir ~/renterd ``` -You will be prompted input both: +You will be prompted to input both: * `API password` - This password is chosen by you and can be anything you want it to be. It will be used to unlock the `renterd` UI via your browser, it 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 used requested every time you start `renterd`. +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. Check out this \
to set this. {% endhint %} -2. After entering your desired `API password` and the created `seed`, `hostd` will start. +2. After entering your desired `API password` and the created `seed`, `renterd` will start.

Starting renterd

-Your terminal will produce a two different values you may not be familiar with, so feel free to check the tabs below to see what each of them are and why they are important: +Your terminal will produce two different values you may not be familiar with, so feel free to check the tabs below to see what each of them are and why they are important: {% tabs %} -{% tab title="p2p" %} +{% tab title="api" %} **api (Application Programming Interface) Component:** * "api" refers to the application programming interface, which allows different software components to communicate and interact with each other. @@ -104,7 +104,7 @@ Your terminal will produce a two different values you may not be familiar with, 3. You can now access the `renterd` UI by opening a browser and going to `http://localhost:9980`. {% hint style="warning" %} -Remember to leave the terminal window open while `hostd` is running. If you close the command prompt window, `hostd`will stop. +Remember to leave the terminal window open while `renterd` is running. If you close the command prompt window, `renterd` stop. {% endhint %} diff --git a/renting/setting-up-renterd/windows.md b/renting/setting-up-renterd/windows.md index 1f63579..9e41449 100644 --- a/renting/setting-up-renterd/windows.md +++ b/renting/setting-up-renterd/windows.md @@ -1,2 +1,129 @@ -# 🚧 Windows +# ✏ Windows +This guide will walk you through setting up `renterd` on Windows. At the end of this guide, you should have the following: + +* **Installed Sia `renterd` software:** Successfully installed the Sia `renterd` software on your Windows system with the appropriate binary. +* **Created a `renterd` wallet**: Created a wallet with a Seed to access and manage your Sia network transactions and store your Siacoins in `renterd`. + +## 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 that your Windows version is compatible with the walletd software. Check [releases](../../miscellaneous/releases.md) 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` + +1. Download the latest version of `renterd` for your operating system from the [official website](https://sia.tech/software/renterd). For the purpose of this guide, we'll be downloading the Windows version of `renterd` and unzipping the binary to `/usr/local/bin`. + +{% hint style="warning" %} +Remember to check which version to download to ensure it works correctly with your operating system. To do this click on the Apple icon in the top left corner of your toolbar, then click on “About This Mac.” If the processor/chips says: + +* **Intel** - `MacOS AMD64` +* **M1 or M2** - `MacOS ARM64` +{% endhint %} + +

macOS Download folder

+ +2. Now that we have downloaded `renterd`, you may need unzip it and move it to a more accessible location: + * Double-click on the downloaded `renterd` zip file to unzip it if it hasn't done so automatically. + * Click on the newly unzipped directory. + * Right-click on the path bar at the bottom of the Finder window and click "Open in Terminal". + +

Options after right-clicking

+ +3. In the opened terminal window, move the `renterd` binary to `/usr/local/bin` by running the following command and press enter: + +```bash +sudo mv renterd /usr/local/bin +``` + +

Moving renterd binary

+ +You'll be prompted to authorize this action by providing your system password. Type this in and press enter to continue. + +4. 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. + +```bash +mkdir ~/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: + +```bash +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. Find out [more](../../get-started-with-sia/the-importance-of-your-seed.md) about the importance of your seed. +{% endhint %} + +

Generating a recovery phrase

+ +## Running `renterd` + +1. In the same terminal, run the following command to start `hostd`: + +```bash +renterd --dir ~/renterd +``` + +You will be prompted input both: + +* `API password` - This password is chosen by you and can be anything you want it to be. It will be used to unlock the `renterd` UI via your browser, it 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 used 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. Check out this \
to set this. +{% endhint %} + +2. After entering your desired `API password` and the created `seed`, `hostd` will start. + +

Starting renterd

+ +Your terminal will produce a two different values you may not be familiar with, so feel free to check the tabs below to see what each of them are and why they are important: + +{% tabs %} +{% tab title="p2p" %} +**api (Application Programming Interface) Component:** + +* "api" refers to the application programming interface, which allows different software components to communicate and interact with each other. +* `Listening on 127.0.0.1:9980` indicates that the application's API component is actively waiting for incoming connections on the local loopback IP address `127.0.0.1` and the port `9980`. +{% endtab %} + +{% tab title="bus" %} + +{% endtab %} +{% endtabs %} + +3. You can now access the `renterd` UI by opening a browser and going to `http://localhost:9980`. + +{% hint style="warning" %} +Remember to leave the terminal window open while `hostd` is running. If you close the command prompt window, `hostd`will stop. +{% endhint %} + + + +

renterd Login UI

+ +Enter your `API password` you created in the 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 very important 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](https://sia.tech/software/renterd). +2. Stop the `renterd` service with the command `sudo systemctl stop renterd` +3. Unzip and replace `renterd` in `/usr/local/bin` with the new version +4. Restart `renterd` with `sudo systemctl start renterd` diff --git a/renting/transferring-siacoins.md b/renting/transferring-siacoins.md index e803169..bb2ce74 100644 --- a/renting/transferring-siacoins.md +++ b/renting/transferring-siacoins.md @@ -1,12 +1,15 @@ -# 📷 Transferring Siacoins +--- +cover: ../.gitbook/assets/jungle.png +coverY: 0 +--- -Whether you're sending Siacoins to an exchange or receiving from friend, `renterd` facilitate the transfer of Siacoins and easily achieved via the UI. +# Transferring Siacoins -## Sending Siacoins (SC) +Whether you're sending Siacoins to an exchange or receiving from a friend, `renterd` facilitates the transfer of Siacoins (SC) and is easily achieved via the UI. -Go to `renterd`. If you're asked to unlock the UI, use your custom password if you've set one. If you haven't got a wallet set up on `renterd`, visit our [Setting up renterd](setting-up-renterd/), otherwise choose from the **sidebar** a **Wallet**. +## Sending Siacoins -

renterd UI choosing "Wallet" from sidebar

+Go to `renterd`. If you're asked to unlock the UI, use your custom password if you've set one. If you haven't got a wallet set up `renterd`, visit our [Setting up `renterd`](setting-up-renterd/) guide otherwise choose from the **sidebar** a **Wallet**. ### Setup your transaction @@ -22,7 +25,7 @@ Click **Generate Transaction.** ### Confirm your info -Next, you need to confirm everything. You'll have a chance to double-check the currency, amount, and recipient address. The window will also show you estimated network fees. +Next, you need to confirm everything. You'll have a chance to double-check the amount and recipient address. The window will also show you estimated network fees.

Confirming your transaction

@@ -42,30 +45,24 @@ By looking at the transactions in the **Wallet** section of the UI, you can chec It might take a minute or two for the transaction to pop up in the wallet's transactions list. {% endhint %} -Once it's in a block, you can go back to check the status and see new transaction type of 'siacoin transfer'. - -\ +Once it's in a block, you can go back to check the status and see a new transaction type of **siacoin transfer**. -## Receiving Siacoins (SC) +## Receiving Siacoins Go to `renterd`. If you're asked to unlock the UI, use your custom password if you've set one. If you haven't got a wallet set up on `renterd`, visit our [Setting up renterd](setting-up-renterd/), otherwise choose from the **sidebar** a **Wallet**. -

renterd UI choosing "Wallet" from sidebar

- ### Sharing the address or QR -Copy and paste this manually, or use the **Copy** button to the right to make sure you get the full address without any extra spaces, and provide this address to whom ever you're receiving the fund from. +Copy and paste your address manually, or use the **Copy** button to the right to make sure you get the full address without any extra spaces, and provide this address to whomever you're receiving the funds from. -You can also receive Siacoin, simply share your wallet address by displaying your QR code for others to scan. +You can also receive Siacoins by sharing your QR code for others to scan too.

Getting the address and QR of your renterd wallet

-By going to your **Dashboard**, and selecting the wallet you made the transaction with, you can check the transaction status. It's normal to 'Unknown' at the top of the list of transactions, it means the transaction is on its way but hasn't yet appeared in a block. +By going to your **Dashboard**, and selecting the wallet you made the transaction with, you can check the transaction status. It's normal for unconfirmed transactions to say "Unknown." It means the transaction is on its way but hasn't yet appeared in a block. {% hint style="info" %} It might take a minute or two for the transaction to pop up in the wallet's transactions list. {% endhint %} -Once it's in a block, you can go back to check the status and see new transaction type of 'siacoin transfer'. - -\ +Once it's in a block, you can go back to check the status and see a new transaction type of **siacoin transfer**. diff --git a/sia-integrations/listing-siacoin-on-your-exchange.md b/sia-integrations/listing-siacoin-on-your-exchange.md deleted file mode 100644 index ee14e47..0000000 --- a/sia-integrations/listing-siacoin-on-your-exchange.md +++ /dev/null @@ -1,89 +0,0 @@ -# 🚧 Listing Siacoin on your exchange - -Sia is one of the best projects in the blockchain space. Sia is open source and completely decentralized. As such, exchanges should strive to implement the best projects that will enhance their platforms with as little involvement from the development team for that project as possible. - -## Some background on Siacoins - -Siacoins are used for buying and selling storage space on the Sia network. We believe that Siacoins are a pure utility token. Siacoins are generated only through Proof of Work mining, and there is no limit on the number of Siacoins that will be issued. - -## Download Sia - -Siacoins are stored in a Sia wallet. Our two official apps are Sia-UI or siac (for command-line interfaces). Only one instance of Sia can run at a time, so you’ll need to install it on multiple machines or virtual environments if you’d like to run more than a single wallet. - -You can download the latest release [directly from Github](https://github.com/SiaFoundation/siad/releases), or [from our website](https://sia.tech/get-started). - -## Technical Specifications for Sia - -* **CPU:** Sia does not require special CPU considerations -* **RAM:** 8 GB recommended -* **SSD:** 60 GB recommended (keep an eye on your consensus size!) - -As of October 2022, the blockchain is 41.88 GB, and you’ll need to download an entire copy to run your wallet. The blockchain grows by about 1 GB every two months. - -No special libraries are required for installation. - -## Review our API documentation - -[Sia API docs](https://api.sia.tech) - -## Setting up Sia - -This is where you come in. Every platform is different, and your team can determine how best to integrate the Siacoin wallet. While we don’t provide dedicated technical support, our developers can provide assistance with your issues. See the "[Point of contact](listing-siacoin-on-your-exchange.md#point-of-contact)" section at the bottom of the article. - -In the meantime, here are some answers to questions we’ve received regarding wallet setup for exchanges. - -**IP Access Restriction.** IP access is restricted to localhost with user-agent "Sia- Agent" required. We highly recommended keeping this as the default. - -**User Access Restriction.** Our API documentation has information on how to set up password authentication to access the API. - -**Transactions per block.** We recommend at most three multi-output transactions per block, and about 250 outputs per multi-output transaction. - -**TLS/SSL Availability.** TLS/SSL is not currently available. - -**Transaction Fee.** The transaction fee is automatically set, but you can always get an estimated range via the [API](https://api.sia.tech/#tpool-fee-get). - -**If the explorer returns incorrect info.** Instead of using the explorer, use the /consensus endpoints listed in the API documentation. These should get you the same info easily. We'll be working on the explorer soon. - -## Common API Requests - -**Generating wallet addresses** - -[https://api.sia.tech/#wallet-addresses-get](https://api.sia.tech/#wallet-addresses-get) - -**Getting transactions for an address** - -[https://api.sia.tech/#wallet-transactions-addr-get](https://api.sia.tech/#wallet-transactions-addr-get) - -**Sending to an address or set of addresses** - -[https://api.sia.tech/#wallet-siacoins-post](https://api.sia.tech/#wallet-siacoins-post) - -**Unlocking the wallet** - -[https://api.sia.tech/#wallet-unlock-post](https://api.sia.tech/#wallet-unlock-post) - -**Verifying an address** - -[https://api.sia.tech/#wallet-verify-address-addr-get](https://api.sia.tech/#wallet-verify-address-addr-get) - -**Changing the wallet password** - -[https://api.sia.tech/#wallet-changepassword-post](https://api.sia.tech/#wallet-changepassword-post) - -## A note about fees - -We believe in the quality of our project, and the spirit of fair play. The long-term value proposition of listing any token comes, of course, from the transaction fees that an exchange earns. And these fees can add up to substantial amounts. - -If your exchange requires any fee to list a coin, you can go ahead and skip us. We do not pay fees of any sort – whether they are called listing fees, marketing fees, sales budgets, etc. - -## Community Votes - -We don't participate in any type of community voting. Community votes typically come in two forms – those that are free and easy to manipulate or those that require paid votes and are still easy to manipulate. We'll never ask our community to participate in either in the future and urge all exchanges to add projects and tokens that they feel will benefit their users and the blockchain space. - -## A legal opinion - -If your exchange requires an opinion regarding Siacoin's status as it relates to US securities law, you can contact our team for a copy of either our self-written opinion, or an opinion from a US-based law firm. - -## Point of contact - -If you have any questions, [send an email to Steve](mailto:steve@sia.tech). He runs our support channels and will get you in contact with our dev team. diff --git a/sia-integrations/sia-brand-guidelines.md b/sia-integrations/sia-brand-guidelines.md index 0856239..2f4a025 100644 --- a/sia-integrations/sia-brand-guidelines.md +++ b/sia-integrations/sia-brand-guidelines.md @@ -1,92 +1,70 @@ -# 🚧 Brand guidelines for Sia in your project or site +# Brand Guidelines -Community and third-party (non-core) projects are an essential part of the Sia ecosystem. They expand the use-cases for Sia, and improve the network with solutions we aren’t actively working on. +Third-party projects constitute an integral part of the Sia ecosystem as they broaden the range of applications of Sia and enhance the network through solutions that are not actively being developed by our team. -We want users to be able to distinguish between core and non-core projects for a number of reasons: +We aim for users to discern between core and non-core projects for several reasons: -* Non-core projects typically involve a bit of centralization, and that’s ok. Users need choice, and centralization provides features that are much easier to implement than can be done on Sia. -* People might confuse your project with something built by the core team, and we want to make sure users know who to go to for help. -* You worked hard on your project, and we want it to stand out! +* Non-core projects often involve some level of centralization, which is entirely acceptable. Users benefit from having choices, and centralization allows for the implementation of features that are more accessible to achieve compared to those on Sia's core infrastructure. +* There's a potential for confusion where users might mistake your project for something created by the core team. Therefore, we want to ensure that users are well-informed about where to seek assistance. +* Acknowledgment of dedication to your project, and we desire to give it the recognition it deserves, allowing it to stand out prominently. -In an effort to promote these goals, please use the following as guidelines when developing your brand. +## Guidelines -## Official Sia assets +These Sia brand guidelines will provide valuable assistance to those developing their project by ensuring clarity, consistency, and a clear distinction not just between other projects, but also core Sia offerings, ultimately fostering user trust and recognition. -The official assets include our logo and wordmark in a variety of high-quality formats, as well as the built with Sia logo for third-party projects. +### Official Sia assets -
+The official Sia assets, including our logo and wordmark in a variety of high-quality formats, can be downloaded [here](https://sia.tech/assets/official-sia-assets.zip). -

Sia_Logo.png

+{% hint style="warning" %} +We strongly recommend using any of the `built-with-sia` logo variations to showcase your integration. This logo serves as a badge of association with Sia, so feel free to incorporate it anywhere necessary to your project. +{% endhint %} - - -

Sia_Logo.svg

- - - -

Sia_Wordmark.png

- - - -

Sia_Wordmark.svg

- - +### Logo and Wordmark -

built-with-Sia-color.png

+The Sia Foundation strictly owns the trademark in the US and advises against using the Sia logo and wordmark directly in any capacity such as projects. To prevent confusion and misrepresentation, users are allowed only to style the original logo and wordmark. - -

built-with-Sia-color.svg

- +
-

built-with-Sia-mono.png

+

Original Sia Logo and wordmark

-

built-with-Sia-mono.svg

+

Example of styling of the original (Siastats logo)

-## `built with Sia` - -If you are building a project featuring Sia, use the `built with Sia` logo to showcase your integration. You can drop this in the app, website, or anywhere else that makes sense. - -## Naming your project - -You have a lot of freedom here. Feel free to use the word “Sia” however you want in your project, with two exceptions: - -* Don’t call your project “Sia”. Because that’s our name. -* Don't use the term “Sia” and then a generic term that directly relates to our business like “Cloud”, “Storage”, or "Backup". - -Current examples of good naming in the community are: SiaStats, Siasync, SiaWiki, and Siamining. You know it's about Sia, and get a good idea of what specifically the project might focus on. - -Just remember, if you’re trying to make a play on words, we pronounce Sia like “sigh-uh” and not “see-ya”. - -You can also create a wonderfully custom name that represents you or your work. Some examples are projects like Pixeldrain, Filebase, and roadie. - -## Logo and Wordmark +{% hint style="warning" %} +The logo can be similar but **must** be easily differentiated from the original Sia logo and wordmark by both color and design. +{% endhint %} -We’re a little more strict on this one. We own the trademark in the US for both the Sia logo and wordmark: +### Naming -![](../.gitbook/assets/brand-2.png) +The trademark name **Sia** is pronounced _“sigh-uh”_ and not _“see-ya”_. -We’d prefer that your project not use the Sia logo or wordmark directly in any capacity, but you can style on it as long as a normal user wouldn’t confuse it for the real thing. +Using the **Sia** is accepted upon naming your project, however with two restrictions: -A good example of this is SiaStats: +* Naming your project solely **Sia**. +* Naming your project **Sia** and then appending a term that directly relates to our business such as **Cloud**, **Storage**, or **Backup**. -![](../.gitbook/assets/brand-3.png) +Some examples of this include **SiaStats**, **Siasync**, **SiaWiki**, and **Siamining**. These names provide a clear indication that the focus is on **Sia**. -The logo is similar, but is easily differentiated from the Sia logo by both the color and the design using a line graph in the center. Plus, it perfectly represents what the site is about - Sia and stats! +You also have the option to craft a uniquely personalized name that reflects your identity or your creative efforts. Illustrative instances of such custom names include **Pixeldrain**, **Filebase**, and **roadie**. -## Color +### Color -Sia uses a number of colors. +Sia incorporates a variety of colors. When crafting your own logo, you can freely choose from our color palette or develop one that suits your vision. -![](../.gitbook/assets/brand-4.png) +![Sia color pallette](../.gitbook/assets/brand-4.png) -If you use the exact Sia logo or wordmark in any way, like to represent the fact that you integrate with Sia on your site, the image should either use our green or one of these grays. In other words, don't use our exact logo or wordmark and change the color to match your color scheme. +Using the exact Sia logo or wordmark to represent your integration with Sia is accepted, but **must** remain the same colors. -When designing your own logo, feel free to draw from our color palette or create your own. +{% hint style="danger" %} +We prohibit the use of the Sia logo or wordmark and changing the color. +{% endhint %} -We can't wait to see what you build! Be sure you let us know in [Discord](https://sia.tech/discord). +{% hint style="info" %} +We're eagerly anticipating what you'll create! If you have any uncertainties regarding our Sia branding guidelines, please don't hesitate to reach out via our Discord. Make sure to inform us on [Discord](https://sia.tech/discord). +{% endhint %} diff --git a/testnet/what-is-zen.md b/testnet/what-is-zen.md deleted file mode 100644 index 19c9260..0000000 --- a/testnet/what-is-zen.md +++ /dev/null @@ -1,16 +0,0 @@ -# 🚧 What is Zen? - -{% hint style="info" %} -The Zen testnet is a dedicated test environment, and the zSC acquired or used on the testnet holds no real-world value. -{% endhint %} - -The Sia Foundation is thrilled to announce the launch of the first Sia testnet, Zen—an exclusive platform designed for testing hardforks, software developments, and integrations within the Sia ecosystem. The Zen testnet offers developers, builders, and enthusiasts a secure environment to experiment and explore the capabilities of Siacoin without the risk of losing real Siacoins. - -One of the notable features of the Zen testnet is the availability of zSC through the Zen Faucet. The faucet provides a convenient way to acquire zSC for testing purposes, enabling developers to conduct tests and refine their applications or integrations without financial concerns. - -To facilitate a seamless testing experience, the Sia Foundation also launched a user-friendly block explorer. With the block explorer, users can dive into the intricacies of the Siacoin network, track transactions, and monitor block confirmations, gaining valuable insights into the testnet's activity. - -The Zen testnet serves as an invaluable platform for builders, developers, and the community to explore the potential of the Sia network. It creates an essential space for refining ideas, testing innovations, and contributing to developing a robust Siacoin network. - -To embark on your journey with the Zen testnet and access zSC for testing, visit the Zen Faucet at \[[https://zen.sia.tech/faucet](https://zen.sia.tech/faucet)] and explore the testnet's activity using the block explorer at \[[https://zen.sia.tech](https://zen.sia.tech/)]. Join the community of innovators shaping the future of decentralized storage with Siacoin. - diff --git a/testnet/zen-testnet.md b/testnet/zen-testnet.md new file mode 100644 index 0000000..0f5a9ce --- /dev/null +++ b/testnet/zen-testnet.md @@ -0,0 +1,59 @@ +# ✏ Zen Testnet + +The Sia Foundation has made a test environment available for users wishing to test hardforks, software developments, and integration within the Sia ecosystem via the Zen Testnet. + +The Zen Testnet offers a secure environment to experiment with `renterd`, `hostd`, and `walletd`and explore the capabilities of Siacoin without the risk of losing real Siacoins, but also with no real-world value. + +{% hint style="warning" %} +Please ensure that you have already downloaded the correct testnet binary for either`renterd`, `hostd` or `walletd` compatible with your operating system from our [official website](https://sia.tech). +{% endhint %} + +## Running testnet via terminal + +Running the Zen testnet for our Sia software is very similar to running it on the mainnet, however, we must specify the `-tags=testnet` flag in our terminal or console, to enable the test environment. + +### macOS + +1. Open a terminal window and `path/to/the/` folder. These folders will be called `renterd`, `hostd`, or `walletd` depending on which testnet you'd like to run. +2. Run the following command, which `` is replaced with either `renterd`, `hostd`, and `walletd` : + +```bash +go run -tags=testnet ./cmd/ +``` + +3. You will be prompted to input a `API password`. This password is chosen by you and can be anything you want it to be. It will be used to unlock the Zen testnet UI via your browser. + +{% hint style="info" %} +If you haven't done so yet, refer to the **Creating a Wallet** setup guides in the previous sections of the documentation. You'll specifically need this for generating a seed for `renterd` or `hostd`. +{% endhint %} + +### Windows + + + +### Linux + + + +{% hint style="warning" %} +Remember to leave the terminal window open while `walletd` is running. If you close the command prompt window, `walletd`will stop. +{% endhint %} + +## Funding your testnet address + +With the availability of zSC, the [Zen testnet faucet](https://zen.siascan.com/faucet) provides a convenient way to acquire zSC by simply providing your Sia wallet's address. + +Once on the page, enter the generated Sia wallet address of either `renterd`, `hostd`, or `walletd` , then enter the amount of Siacoins (SC) you wish to fund that address with. + +

Zen Testnet Faucet funding

+ +{% hint style="info" %} +It might take a minute or two for your wallet to be funded and for the transaction to pop up in the wallet's transactions list. +{% endhint %} + +## Block Explorer + +Users also have access to the block explorer. With the block explorer, users can dive into the intricacies of the Siacoin network, track transactions, and monitor block confirmations, gaining valuable insights into the testnet's activity. + +\[[https://zen.sia.tech](https://zen.sia.tech/)]. + diff --git a/wallet/setting-up-walletd/macos.md b/wallet/setting-up-walletd/macos.md index 377363d..ecd5fef 100644 --- a/wallet/setting-up-walletd/macos.md +++ b/wallet/setting-up-walletd/macos.md @@ -58,17 +58,17 @@ mkdir ~/walletd 
walletd --dir ~/walletd
-You will be prompted input a `API password`. This password is chosen by you and can be anything you want it to be. It will be used to unlock the `walletd` UI via your browser, it should be something secure and easy to remember. This value are not stored anywhere; you will need to re-enter it every time you start `walletd`. +You will be prompted to input a `API password`. This password is chosen by you and can be anything you want it to be. It will be used to unlock the `walletd` UI via your browser, should be something secure and easy to remember. This value is not stored anywhere; you will need to re-enter it every time you start `walletd`. {% hint style="info" %} -You can also set the SIA`_API_PASSWORD` environment variables so you do not have to re-enter the values every time. Check out this \
to set this. +You can also set the SIA`_API_PASSWORD` environment variables so you do not have to re-enter the values every time. {% endhint %} 2. After entering your desired `API password`, `walletd` will start.

Starting walletd via macOS terminal

-Your terminal will produce a two different values you may not be familiar with, so feel free to check the tabs below to see what each of them are and why they are important: +Your terminal will produce two different values you may not be familiar with, so feel free to check the tabs below to see what each of them is and why they are important: {% tabs %} {% tab title="p2p" %} diff --git a/wallet/transferring-siacoins.md b/wallet/transferring-siacoins.md index 4498c0a..23d2de1 100644 --- a/wallet/transferring-siacoins.md +++ b/wallet/transferring-siacoins.md @@ -1,12 +1,15 @@ -# Transferring Siacoins +--- +cover: ../.gitbook/assets/mountain.png +coverY: 0 +--- -## Sending Siacoins (SC) +# Transferring Siacoins -Whether you're sending Siacoins to an exchange or a friend, it's easy and can be done right in `walletd`. +## Sending Siacoins -Go to `walletd`. If you're asked to unlock the wallet, use either your seed or a custom password if you've set one. If you haven't got a wallet set up, visit our Setup Guide, otherwise choose from the **Dashboard** a wallet you wish send Siacoins from. +Whether you're sending Siacoins (SC) to an exchange or a friend, it's easy and can be done right in `walletd`. -

Wallet dashboard

+Go to `walletd`. If you're asked to unlock the wallet, use either your seed or a custom password if you've set one. If you haven't got a wallet set up, visit our[ Setting up `walletd`](setting-up-walletd/) guide, otherwise choose from the **Dashboard** a wallet you wish to send Siacoins from. ### Setup your transaction @@ -44,17 +47,13 @@ By going to your **Dashboard**, and selecting the wallet you made the transactio It might take a minute or two for the transaction to pop up in the wallet's transactions list. {% endhint %} -Once it's in a block, you can go back to check the status and see new transaction type of 'siacoin transfer'. - -

Successfully sending Siacoins via walletd

+Once it's in a block, you can go back to check the status and see a new transaction type of 'siacoin transfer'. -## Receiving Siacoins (SC) +## Receiving Siacoins -At some point, you'll need to receive Siacoins. You might be receiving them over from an exchange wallet, another Sia wallet you own, or requesting Siacoins from a friend. No matter the reason, it's easy to \ or retrieve your address in `walletd` to receive Siacoins. +At some point, you'll need to receive Siacoins. You might be receiving them from an exchange wallet, another Sia wallet you own, or requesting Siacoins from a friend. No matter the reason, it's easy to \ or retrieve your address in `walletd` to receive Siacoins. -Go to the `walletd`. If you're asked to unlock the wallet, use either your seed or a custom password if you've set one. If you haven't got a wallet set up, visit our \, otherwise choose from the **Dashboard** a wallet you wish receive Siacoins from. - -

Wallet dashboard

+Go to the `walletd`. If you're asked to unlock the wallet, use either your seed or a custom password if you've set one. If you haven't got a wallet set up, visit our [Setting up walletd](setting-up-walletd/) guide, otherwise choose from the **Dashboard** a wallet you wish to receive Siacoins from. Click on the **Addresses** in the top right corner and you'll be presented the wallet address. @@ -62,9 +61,9 @@ Click on the **Addresses** in the top right corner and you'll be presented the w ### Sharing the address or QR -Copy and paste this manually, or use the **Copy** button to the right to make sure you get the full address without any extra spaces, and provide this address to whom ever you're receiving the fund from. +Copy and paste your address manually, or use the **Copy** button to the right to make sure you get the full address without any extra spaces, and provide this address to whomever you're receiving the fund from. -You can also receive Siacoin, simply share your wallet address by displaying your QR code for others to scan. +You can also receive Siacoins by sharing your QR code for others to scan too.

Getting the address and QR of your wallet

@@ -74,6 +73,4 @@ By going to your **Dashboard**, and selecting the wallet you made the transactio It might take a minute or two for the transaction to pop up in the wallet's transactions list. {% endhint %} -Once it's in a block, you can go back to check the status and see new transaction type of 'siacoin transfer'. - -

Successful receiving Siacoin to walletd

+Once it's in a block, you can go back to check the status and see a new transaction type of 'siacoin transfer'. diff --git a/wallet/wallet-faq.md b/wallet/wallet-faq.md deleted file mode 100644 index 660de50..0000000 --- a/wallet/wallet-faq.md +++ /dev/null @@ -1,26 +0,0 @@ -# 🚧 Wallet FAQ - - - -
- -I lost my seed, what should I do? - -Losing your seed means permanently losing access to your coins. - -Your Sia seed grants full access to your wallet and balance of Siacoins. - -The decentralized nature of Sia ensures that the Sia dev team is unable to access your seed under any circumstances, emphasis the responsibility for users to safeguarding their own seed. - -Learn more about the [importance of your seed](../get-started-with-sia/the-importance-of-your-seed.md)**.** - -
- -
- -How do I my current wallet and start over? - - - -
- diff --git a/wallet/wallet-overview.md b/wallet/wallet-overview.md index cafd52b..d2097f0 100644 --- a/wallet/wallet-overview.md +++ b/wallet/wallet-overview.md @@ -1,8 +1,13 @@ +--- +cover: ../.gitbook/assets/mountain.png +coverY: 0 +--- + # About walletd `walletd` is the best place for users within our network to manage and transact their Siacoins. It is the official wallet web application made by the developers of the Sia network. -* Safely send, receive and store Siacoins and Siafunds. +* Safely send, receive, and store Siacoins and Siafunds. * Watch the blockchain for events relevant to particular addresses. * Monitor wallet balance and transactions * Supports Ledger hardware wallets @@ -11,7 +16,7 @@ Watch our Wallet Overview video tour to see what the `walletd` user interface lo \