diff --git a/README.md b/README.md new file mode 100644 index 0000000..5be338a --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +

S5 Docs

+
+ + S5 Doccumentation + +
+ +
+
+ + + docs.rs docs + +
+
+ +## Usage + +This project is made with [mdbook](https://github.com/rust-lang/mdBook). To build yourself: + +First install rust & dependencies: + +``` +curl https://sh.rustup.rs -sSf | sh +cargo install mdbook +``` + +Then build the book: + +``` +mdbook build +``` + +Then the build files will be in the `/book` directory. + +## Acknowledgement + +This work is supported by multiple [Sia Foundation](https://sia.tech) grants. diff --git a/book.toml b/book.toml index dcb580a..0d3d35d 100644 --- a/book.toml +++ b/book.toml @@ -5,6 +5,12 @@ multilingual = false src = "src" title = "S5 Network Docs" +[output.html] +smart-punctuation = true +site-url = "/" +git-repository-url = "https://github.com/s5-dev/docs/" +edit-url-template = "https://github.com/s5-dev/docs/edit/main/{path}" + [output.html.fold] enable = true level = 0 diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 3692fbe..bd19c59 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -2,36 +2,36 @@ [Introduction](README.md) - - [Basic Concepts](concepts/README.md) - - [Content-addressed data and CIDs](concepts/content-addressed-data.md) - - [Registry](concepts/registry.md) - - [Peer-to-peer](concepts/peer-to-peer-network.md) + + - [Content-addressed data and CIDs](concepts/content-addressed-data.md) + - [Registry](concepts/registry.md) + - [Peer-to-peer](concepts/peer-to-peer-network.md) - [Specification](spec/README.md) - - [Blobs](spec/blobs.md) - - [File System (FS5)]() + - [Blobs](spec/blobs.md) + - [File System (FS5)]() --- - [Guides](guide/README.md) - - [Deploy S5 Node with Sia renterd](guide/deploy-renterd.md) - - [Setup With Sia](guide/setup-with-sia.md) + - [Deploy S5 Node with Sia renterd](guide/deploy-renterd.md) + - [Setup With Sia S3](guide/setup-with-sia.md) - [Tools](tools/README.md) - - [cid.one](tools/cid-one.md) - - [s5.cx](tools/s5-cx.md) + - [cid.one](tools/cid-one.md) + - [s5.cx](tools/s5-cx.md) --- - [Install](install/README.md) - - [Config](install/config/README.md) - - [Caddy reverse proxy](install/caddy.md) + - [Config](install/config/README.md) + - [Caddy reverse proxy](install/caddy.md) - [Stores](stores/README.md) - - [S3-compatible providers](stores/s3.md) - - [Local](stores/local.md) - - [Sia Network](stores/sia.md) - - [Arweave](stores/arweave.md) + - [S3-compatible providers](stores/s3.md) + - [Local](stores/local.md) + - [Sia Network](stores/sia.md) + - [Arweave](stores/arweave.md) - [Metadata formats](metadata/README.md) - - [Web App](metadata/web-app.md) - - [Directory](metadata/directory.md) - - [Media](metadata/media.md) \ No newline at end of file + - [Web App](metadata/web-app.md) + - [Directory](metadata/directory.md) + - [Media](metadata/media.md) diff --git a/src/guide/README.md b/src/guide/README.md index 44744ca..734c774 100644 --- a/src/guide/README.md +++ b/src/guide/README.md @@ -1,3 +1,7 @@ # Guides -- [Setup with Sia](setup-with-sia.md) \ No newline at end of file +This section contains detailed guides for setting up S5 related concepts. For more broad details about how to configure different stores, go [here](../stores/index.html). +This article contains. + +- [Setup with Sia (recommended)](setup-with-sia.md) +- [Setup with Sia S3](./deploy-renterd.md) diff --git a/src/guide/deploy-renterd.md b/src/guide/deploy-renterd.md index 0be333f..54555a0 100644 --- a/src/guide/deploy-renterd.md +++ b/src/guide/deploy-renterd.md @@ -11,6 +11,7 @@ You can then use it with the Vup Cloud Storage app or just play with the S5 API - Some SC (siacoin) for forming contracts on the network and renting storage If you're looking for affordable providers with these specs, I found the new Netcup ARM Servers to be a pretty good choice () + - 7 EUR/month for 8 GB of RAM - 12 EUR/month for 16 GB of RAM @@ -91,7 +92,7 @@ Then restart Caddy with `systemctl restart caddy` First, install Podman using this command: `sudo apt-get -y install podman` -Create some needed directories: +Create some needed directories: ```sh mkdir -p /s5/config @@ -151,4 +152,4 @@ enabled = true Then run `podman restart s5-node` to restart the S5 Node. -Now you can use the "Register on S5 Node" button in the Vup "Storage Service" settings, enter the domain of your node and the newly generated invite code and you should be good to go! You'll likely want to use more than 10 GB of storage, so just use the Admin Web UI to set a higher tier for your newly created account. +Now you can use the "Register on S5 Node" button in the Vup "Storage Service" settings, enter the domain of your node and the newly generated invite code, and you should be good to go! You'll likely want to use more than 10 GB of storage, so just use the Admin Web UI to set a higher tier for your newly created account. diff --git a/src/guide/setup-with-sia.md b/src/guide/setup-with-sia.md index 4fd9d73..52f45c4 100644 --- a/src/guide/setup-with-sia.md +++ b/src/guide/setup-with-sia.md @@ -1,14 +1,13 @@ -# Setup With Sia +# Setup With Sia S3 -Please follow this guide instead: +It is recommended to use the direct Sia API integration as documented in the [full renterd setup guide with S5](deploy-renterd.md). But S5 also supports the S3 endpoints. -Sia is a decentralized, affordable and secure cloud storage platform. You can use it as a storage backend for your S5 Node. +First, you'll need a fully configured instance of **renterd** (the new Sia renter software) running somewhere. Here's a [great guide](https://blog.sia.tech/sia-innovate-and-integrate-christmas-2023-hackathon-9b7eb8ad5e0e) which shows you how to set one up easily on the Sia testnet. -First, you'll need a fully configured instance of **renterd** (the new Sia renter software) running somewhere. Here's a great guide which shows you how to set one up easily on the Sia testnet: - -Next, you need to set up a S5 Node using the instructions available at [/install/index.html](/install/index.html) +Next, you need to set up a S5 Node using the instructions available [here](../install/index.html) For configuring the S5 Node to use your Sia renter node, you will need to add this section to your `config.toml`: + ```toml [store.s3] accessKey = "MY_ACCESS_KEY" # Replace this with the access key from your renterd.yml @@ -16,6 +15,7 @@ bucket = "sfive" # Or just "default" endpointUrl = "YOUR_S3_ENDPOINT_URL" # http://localhost:7070 if you followed the Sia renterd testnet guide secretKey = "MY_SECRET_KEY" # Replace this with the secret key from your renterd.yml ``` + And then restart the node with `docker container restart s5-node` -You might also want to enable the **accounts** system on your node if it's available on the internet or if you want to use it with Vup, see [/install/config/index.html](/install/config/index.html) for details. \ No newline at end of file +You might also want to enable the **accounts** system on your node if it's available on the internet or if you want to use it with Vup, see [config instructions](../install/config/index.html) for details.