From 4f57745ee7759052267ee2c9ca36a1628df334f9 Mon Sep 17 00:00:00 2001 From: Konrad Stepniak Date: Fri, 29 Nov 2024 16:37:30 +0100 Subject: [PATCH 1/3] docs: add a point about ubuntu 24.04 --- docs/src/getting-started/building/source.md | 6 ++++++ docs/src/getting-started/index.md | 1 + docs/src/getting-started/local-testnet/index.md | 2 +- docs/src/introduction.md | 2 -- 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/src/getting-started/building/source.md b/docs/src/getting-started/building/source.md index 420244e51..7018b65d6 100644 --- a/docs/src/getting-started/building/source.md +++ b/docs/src/getting-started/building/source.md @@ -3,12 +3,18 @@ This guide will outline how to setup your environment to build the Polka Storage parachain, we cover how to build the binaries directly on your system or using [Nix](https://nixos.org/download/) to ease the process. +
+Not all of the binaries can be built from polka-storage repository! +We depend on the zombienet and polkadot, polkadot-prepare-worker, polkadot-execute-worker binaries which need to be downloaded regardless. +
+ * [Get the code](#get-the-code) * [System dependencies](#system-dependencies) * [Using Nix](#using-nix) * [Pre-requisites](#pre-requisites) * [Building](#building) + ## Get the code To get started, first clone the repository and enter the repository's directory: diff --git a/docs/src/getting-started/index.md b/docs/src/getting-started/index.md index c72202470..565629c4c 100644 --- a/docs/src/getting-started/index.md +++ b/docs/src/getting-started/index.md @@ -7,6 +7,7 @@ This chapter goes through the process of setting up, running, and trying out the Before proceeding with the setup, please ensure the host system meets the following requirements: - **OS**: Linux x86_64/MacOS ARM x64 + - [Precompiled binaries](./local-testnet/index.md#native-binaries) were compiled under Ubuntu 24.04.1 LTS (glibc 2.39+). - **RAM**: Minimum 8GB, recommended 16GB or more ## Guides diff --git a/docs/src/getting-started/local-testnet/index.md b/docs/src/getting-started/local-testnet/index.md index d05dadb71..7ac2498eb 100644 --- a/docs/src/getting-started/local-testnet/index.md +++ b/docs/src/getting-started/local-testnet/index.md @@ -9,7 +9,7 @@ Charlie will be our contact point to the parachain network. ## Native Binaries The binaries for the latest releases are available to download and can be run without any additional dependencies. -We support `Linux x86_64` and `MacOS ARM x64`. The commands below will download: +We support `Linux x86_64 (Ubuntu 24.04.1 LTS/glibc 2.39+)` and `MacOS ARM x64`. The commands below will download: - [Relay Chain](https://github.com/paritytech/polkadot-sdk/releases) binaries (`polkadot`, `polkadot-prepare-worker`, `polkadot-execute-worker`), - Polka Storage Parachain binary (`polka-storage-node`), diff --git a/docs/src/introduction.md b/docs/src/introduction.md index 2532ce57b..30c3eeb62 100644 --- a/docs/src/introduction.md +++ b/docs/src/introduction.md @@ -23,8 +23,6 @@ We've now completed Phase 2 and have started work on Phase 3. - Proof of Replication - Proof of Spacetime - - We also present a complete [real-world scenario](./getting-started/demo-file-store.md) in which a [Storage Provider](./glossary.md#storage-provider) and a [Storage User](./glossary.md#storage-user) negotiate a deal, perform all the steps necessary to start the storage and then receive rewards (or punishments) for making it happen. **The Polka Storage project currently provides:** From 3a6c9e4a24cedbab66e8dfdaeabb3084def30c4f Mon Sep 17 00:00:00 2001 From: Konrad Stepniak Date: Mon, 2 Dec 2024 10:57:33 +0100 Subject: [PATCH 2/3] docs: add some disclaimers --- docs/src/getting-started/building/source.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/getting-started/building/source.md b/docs/src/getting-started/building/source.md index 7018b65d6..e73b3f8ad 100644 --- a/docs/src/getting-started/building/source.md +++ b/docs/src/getting-started/building/source.md @@ -4,8 +4,8 @@ This guide will outline how to setup your environment to build the Polka Storage we cover how to build the binaries directly on your system or using [Nix](https://nixos.org/download/) to ease the process.
-Not all of the binaries can be built from polka-storage repository! -We depend on the zombienet and polkadot, polkadot-prepare-worker, polkadot-execute-worker binaries which need to be downloaded regardless. +Not all of the binaries can be built from the polka-storage repository! +We depend on the zombienet and polkadot, polkadot-prepare-worker, polkadot-execute-worker binaries which need to be downloaded regardless (if not using Nix).
* [Get the code](#get-the-code) From 65a153b961a06f4833348b5fa056bb87cfdfb258 Mon Sep 17 00:00:00 2001 From: Konrad Stepniak Date: Mon, 2 Dec 2024 12:03:40 +0100 Subject: [PATCH 3/3] docs: move warning about the binaries lower --- docs/src/getting-started/building/source.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/src/getting-started/building/source.md b/docs/src/getting-started/building/source.md index e73b3f8ad..ed7bf3ab9 100644 --- a/docs/src/getting-started/building/source.md +++ b/docs/src/getting-started/building/source.md @@ -3,18 +3,12 @@ This guide will outline how to setup your environment to build the Polka Storage parachain, we cover how to build the binaries directly on your system or using [Nix](https://nixos.org/download/) to ease the process. -
-Not all of the binaries can be built from the polka-storage repository! -We depend on the zombienet and polkadot, polkadot-prepare-worker, polkadot-execute-worker binaries which need to be downloaded regardless (if not using Nix). -
- * [Get the code](#get-the-code) * [System dependencies](#system-dependencies) * [Using Nix](#using-nix) * [Pre-requisites](#pre-requisites) * [Building](#building) - ## Get the code To get started, first clone the repository and enter the repository's directory: @@ -24,7 +18,6 @@ git clone git@github.com:eigerco/polka-storage.git cd polka-storage ``` - ## System dependencies To build the binaries directly on your system you will need the following tools: @@ -50,6 +43,11 @@ $ sudo apt install -y libhwloc-dev \ curl ``` +
+Not all of the binaries can be built from the polka-storage repository! +We depend on the zombienet and polkadot, polkadot-prepare-worker, polkadot-execute-worker binaries which need to be downloaded regardless (if not using Nix). +
+ ## Using Nix You can use Nix to simplify the building process,