You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/bee/working-with-bee/bee-api.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Detailed information about Bee API endpoints can be found in the [API reference
17
17
18
18
## Interacting With the API
19
19
20
-
You can interact with the Bee API using standard HTTP requests, allowing you to programmatically access all of your Bee node's various functions such as [purchasing stamp batches](/docs/develop/tools-and-features/buy-a-stamp-batch), [uploading and downloading](/docs/develop/access-the-swarm/upload-and-download), [staking](/docs/bee/working-with-bee/staking), and more.
20
+
You can interact with the Bee API using standard HTTP requests, allowing you to programmatically access all of your Bee node's various functions such as [purchasing stamp batches](/docs/develop/tools-and-features/buy-a-stamp-batch), [uploading and downloading](/docs/develop/upload-and-download), [staking](/docs/bee/working-with-bee/staking), and more.
Copy file name to clipboardExpand all lines: docs/concepts/access-control.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ id: access-control
6
6
The Access Control Trie (ACT) implements the operation of encryption at the chunk level, with the presence of a decryption/encryption key being the only distinction between accessing private and public data.
7
7
8
8
:::info
9
-
This article describes the high level concepts and functionalities of ACT. If you're ready to try it out for yourself, please refer to this [hands on usage guide with specific details](/docs/develop/access-the-swarm/act/).
9
+
This article describes the high level concepts and functionalities of ACT. If you're ready to try it out for yourself, please refer to this [hands on usage guide with specific details](/docs/develop/act/).
10
10
:::
11
11
12
12
In decentralized public data storage systems like Swarm, data is distributed across multiple nodes. Ensuring
Copy file name to clipboardExpand all lines: docs/concepts/what-is-swarm.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ Built on top of the overlay network is also an [incentives layer](/docs/concepts
56
56
57
57
The third part of Swarm is a component that provides high-level data access and defines APIs for base-layer features. This layer is responsible for providing an easy-to-use interface for developers to interact with Swarm's underlying storage and communication infrastructure.
58
58
59
-
Swarm's high-level data access component provides [APIs that allow developers to perform various operations](/api/) on the network, including [uploading and downloading data](/docs/develop/access-the-swarm/upload-and-download) and searching for content. These APIs are designed to be simple and intuitive, making it easy for developers to build decentralised applications on top of Swarm.
59
+
Swarm's high-level data access component provides [APIs that allow developers to perform various operations](/api/) on the network, including [uploading and downloading data](/docs/develop/upload-and-download) and searching for content. These APIs are designed to be simple and intuitive, making it easy for developers to build decentralised applications on top of Swarm.
Copy file name to clipboardExpand all lines: docs/develop/host-your-website.md
+19-17Lines changed: 19 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,19 +6,21 @@ id: host-your-website
6
6
import Tabs from '@theme/Tabs';
7
7
import TabItem from '@theme/TabItem';
8
8
9
-
# Hosting a Website on Swarm and Linking it to ENS
9
+
This guide explains how to host a website on Swarm using `swarm-cli`and make it accessible through [Ethereum Name Service (ENS)](https://ens.domains/).
10
10
11
-
This guide explains how to host a static website on Bee using `swarm-cli` and make it accessible through [Ethereum Name Service (ENS)](https://ens.domains/).
11
+
## Host a Site With **swarm-cli**
12
12
13
-
**Part one** covers uploading and accessing your site through the raw Swarm hash.
13
+
This three part guide shows you how to get your website hosted on Swarm with just a few simple commands by using `swarm-cli` from your terminal.
14
+
15
+
**Part one** covers uploading and accessing your site through the raw Swarm hash.
14
16
15
17
**Part two** shows how to register your Swarm hash with your ENS domain so it can be easily accessed by anyone through public ENS gateways like `eth.limo`, `bzz.link`, or `localhost` on a Bee node.
16
18
17
-
**Part three** shows how to upload your website through a feed and register the feed manifest with ENS in order to provide a static hash for the website. This means you no longer need to update your ENS record every time you make a change to your website, and is the recommended method for hosting a publicly accessible website on Swarm.
19
+
**Part three** shows you how to use feeds to make you website accessible at a static hash, and then use that hash to connect with your ENS domain. This is highly recommended for any site which will have future updates - without this step you would need to re-register your ENS domain every time you updated the site.
18
20
19
-
## 1. Hosting and Accessing Your Website on Swarm
21
+
###1. Upload & Access by Hash
20
22
21
-
### Prerequisites
23
+
####Prerequisites
22
24
23
25
* A running Bee node (either a [standard installation](/docs/bee/installation/quick-start) or [Swarm Desktop](/docs/desktop/install))
24
26
* A valid postage batch
@@ -29,7 +31,7 @@ This guide explains how to host a static website on Bee using `swarm-cli` and ma
29
31
You can download the example website files from the [ethersphere/examples](https://github.com/ethersphere/examples/tree/main/basic-static-website) repository.
30
32
31
33
32
-
### Uploading the Website
34
+
####Uploading the Website
33
35
34
36
1. Go to the folder containing your website files.
Alternatively, you can run your own Ethereum node and use that as the RPC.
142
144
:::
143
145
144
-
### Using the Official ENS Guide
146
+
####Using the Official ENS Guide
145
147
146
148
The ENS team provides a clear walkthrough with screenshots showing how to add a content hash to your domain with their [easy to use app](https://app.ens.domains/):
147
149
@@ -155,7 +157,7 @@ The guide covers:
155
157
* Confirming the transaction
156
158
157
159
158
-
### Swarm-Specific Step
160
+
####Swarm-Specific Step
159
161
160
162
When you reach Step 2 in the ENS guide (“Add content hash record”), enter your Swarm reference in the following format:
161
163
@@ -178,7 +180,7 @@ This works across:
178
180
You do not need to encode the hash or use any additional tools. `bzz://<hash>` is sufficient.
179
181
180
182
181
-
## 3. (Recommended) Host Your Website via a Feed Instead of a Raw Hash
183
+
###3. (Recommended) Avoid Repeated ENS Registrations with Feeds
182
184
183
185
If you plan to update your website in the future, you should publish your website hash to a **feed** rather than pointing ENS directly to the raw content hash.
184
186
@@ -197,7 +199,7 @@ In this section, you will:
197
199
198
200
This ensures future website updates require no ENS changes.
199
201
200
-
### Prerequisite: Have your initial site hash
202
+
####Prerequisite: Have your initial site hash
201
203
202
204
From Part One you should already have uploaded your site and seen something like:
203
205
@@ -210,7 +212,7 @@ We will refer to this as `<site-hash>` in the examples below.
210
212
> In the next step we will re-upload the site using a feed so that ENS can always track updates.
### Step 2: Upload your website to a feed (creates the manifest automatically)
232
+
####Step 2: Upload your website to a feed (creates the manifest automatically)
231
233
232
234
<Tabs>
233
235
<TabItemvalue="linux"label="Linux / macOS">
@@ -275,7 +277,7 @@ Save this hash, you will use it for the next step.
275
277
This is your **permanent website reference**. It is a reference to a feed manifest which points to the latest feed entry so that you can use it as a static, unchanging reference for your website even as you make multiple updates to the site. Every time you update the website through the feed, this manifest will point to the hash for the newest version of the website.
276
278
277
279
278
-
### Step 3: Use the feed reference as the ENS contenthash
280
+
####Step 3: Use the feed reference as the ENS contenthash
279
281
280
282
Follow the same [official ENS guide](https://support.ens.domains/en/articles/12275979-how-to-add-a-decentralized-website-to-an-ens-name) for registering a content hash adding your content hash in the ENS UI (see [Section 2](#2-connecting-your-website-to-ens)). However, this time, rather than registering your website's hash directly, register the feed manifest hash we saved from the previous step (`6c30ef2254ac15658959cb18dd123bcce7c16d06fa7d0d4550a1ee87b0a846a2` from our example above).
Copy file name to clipboardExpand all lines: docs/develop/tools-and-features/erasure-coding.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ For more details of erasure coding costs, see [here](/docs/concepts/DISC/erasure
45
45
46
46
## Downloading Erasure Encoded Data
47
47
48
-
For a downloader, the process for downloading a file which has been erasure encoded does not require any changes from the [normal download process](/docs/develop/access-the-swarm/upload-and-download). There are several options for adjusting the default behaviour for erasure encoded downloads, however there is no need to adjust them.
48
+
For a downloader, the process for downloading a file which has been erasure encoded does not require any changes from the [normal download process](/docs/develop/upload-and-download). There are several options for adjusting the default behaviour for erasure encoded downloads, however there is no need to adjust them.
49
49
50
50
### Default Download Behaviour
51
51
@@ -87,7 +87,7 @@ An example download request may look something like this:
87
87
88
88
For this request, the redundancy strategy is set to 3 (RACE), which means that it will initiate a request for all data and parity chunks and continue to retrieve chunks until enough have been retrieved to reconstruct the source data. This is in contrast with the default strategy of DATA where only the data chunks will be retrieved.
89
89
90
-
However, as noted above, it is recommended to not adjust the default settings for these options, so a typical request would actually look like this (which is the exact same as a [normal download](/docs/develop/access-the-swarm/upload-and-download) without any additional options set):
90
+
However, as noted above, it is recommended to not adjust the default settings for these options, so a typical request would actually look like this (which is the exact same as a [normal download](/docs/develop/upload-and-download) without any additional options set):
0 commit comments