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/access-the-swarm/host-your-website.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
@@ -43,7 +43,7 @@ Make sure you trust the gateway you are interacting with! To ensure that you are
43
43
44
44
First we will need to upload the website assets to Swarm in order to
45
45
get its Swarm reference hash, see
46
-
[uploading a directory](/docs/installation/upload-a-directory)
46
+
[uploading a directory](/docs/access-the-swarm/upload-a-directory)
47
47
for more information.
48
48
49
49
This time we will also include the `Swarm-Index-Document` header set to the `index.html`. This will cause Bee to serve each directories `index.html` file as default when browsing to the directory root `/` url. We will also provide a custom error page, using the `Swarm-Error-Document` header.
Copy file name to clipboardExpand all lines: docs/access-the-swarm/pinning.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ There are two flavours of pinning, *local* and *global*.
20
20
If a node operator wants to keep content so that it can be accessed only by local users of that node, via the [APIs](/docs/api-reference/api-reference) or Gateway, chunks can be *pinned* either during upload, or retrospectively using the Swarm reference.
21
21
22
22
:::caution
23
-
Files pinned using local pinning will still not necessarily be available to the rest of the network. Read [global pinning](/docs/advanced/persistence#global-pinning) to find out how to keep your files available to the whole of the swarm.
23
+
Files pinned using local pinning will still not necessarily be available to the rest of the network. Read [global pinning](/docs/access-the-swarm/pinning#global-pinning) to find out how to keep your files available to the whole of the swarm.
24
24
:::
25
25
26
26
### Pin During Upload
@@ -87,7 +87,7 @@ The previous example showed how we can pin content upon upload. It is also possi
87
87
To do so, we can send a `POST` request including the swarm reference to the files pinning endpoint.
@@ -112,7 +112,7 @@ While the pin operation will attempt to fetch content from the network if it is
112
112
113
113
## Global Pinning
114
114
115
-
[Local pinning](/docs/advanced/persistence#local-pinning) ensures that your own node does not delete uploaded files. But other nodes that store your
115
+
[Local pinning](/docs/access-the-swarm/pinning#global-pinning) ensures that your own node does not delete uploaded files. But other nodes that store your
116
116
chunks (because they fall within their *neighbourhood of responsibility*) may have deleted content
117
117
that has not been accessed recently to make room for new chunks.
In Swarm, all data is public by default. To protect sensitive content, it must be encrypted so that only authorised users are able to decrypt and then view the plaintext content.
7
+
8
+
The Bee client provides a facility to encrypt files and directories while uploading which are only able to be read by users with access to the corresponding decryption key.
9
+
10
+
# Encrypt and Upload a File
11
+
12
+
To encrypt a file simply include the `Swarm-Encrypt: true` header with your HTTP request.
Here we see that, when using the Bee node's encryption function, the reference hash that is returned is 128 hex characters long. The first 64 characters of this are the familiar Swarm address - the reference that allows us to retrieve the data from the swarm - it is the same as the reference we would get uploading unencrypted files to using Bee it is safe to share.
25
+
26
+
The second second part of the reference is a 64 character decryption key which is required to decrypt the referenced content and view the original data in the clear, this is sensitive key material and must be kept private.
27
+
28
+
It is important that this data is not be sent in requests to a public gateway as this would mean that gateway would be able to decrypt your data. However, if you are running a node on your local machine, you may safely use the api bound to `localhost`. The key material is never exposed to the network so your data remains safe.
29
+
30
+
:::info
31
+
Encryption is disabled by default on all Swarm Gateways to keep your data safe. [Install Bee on your computer](/docs/installation/quick-start) to use the encryption feature.
32
+
:::
33
+
34
+
# Download and Decrypt a File
35
+
36
+
To retrieve your file, simply supply the full 64 byte string to the files endpoint, and the Bee client will download and decrypt all the relevant chunks and restore them to their original format.
Never use public gateways when requesting full encrypted references, the hash contains sensitive key information which should be kept private. Run [your own node](/docs/installation/quick-start) to get to use Bee's encryption features.
We may also pass the appropriate mime type in the `Content-Type` header, and a file name to the `name` query parameter so that the file will be correctly handled by web browsers and other applications.
Data uploaded to the swarm is always public. In Swarm, sensitive files must be [encrypted](/docs/installation/store-with-encryption) before uploading to ensure their contents always remains private.
52
+
Data uploaded to the swarm is always public. In Swarm, sensitive files must be [encrypted](/docs/access-the-swarm/store-with-encryption) before uploading to ensure their contents always remains private.
53
53
:::
54
54
55
55
When succesful, a json formatted response will be returned, containing a **swarm reference** or **hash** which is the *address* of the uploaded file, for example:
@@ -62,7 +62,7 @@ Keep this *address* safe, as we'll use it to retrieve our content later on.
62
62
In Swarm, every piece of data has a unique *address* which is a unique and reproducible cryptographic hash digest. If you upload the same file twice, you will always receive the same hash. This makes working with data in Swarm super secure!
63
63
64
64
:::info
65
-
If you are uploading a large file it is useful to track the status of your upload as it is processed into the network. Head over to the advanced usage section to learn how to [follow the status of your upload](/docs/advanced/tags).
65
+
If you are uploading a large file it is useful to track the status of your upload as it is processed into the network. Head over to the advanced usage section to learn how to [follow the status of your upload](/docs/access-the-swarm/syncing).
66
66
67
67
Once your file has been **completely synced with the network**, you will be able to turn off your computer and other nodes will take over to serve the data for you!
68
68
:::
@@ -74,17 +74,17 @@ Once your file is uploaded into Swarm, it can be retrieved with a simple HTTP GE
74
74
Substitute the *hash* in the last part of the url to be the reference to your own data.
To share files with someone who isn't running a Bee node yet, simply change the host in the link to be one of our public gateways. Send the link to your friends, and they will be able to download the file too!
<!-- If you are unable to download your file from a different Bee node, you may be experiencing connection issues, see [troubleshooting connectivity](/docs/troubleshooting/connectivitiy) for assistance. -->
Copy file name to clipboardExpand all lines: docs/api-reference/api-reference.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
@@ -21,7 +21,7 @@ Detailed information about Bee API endpoint can be found here:
21
21
The debug-API is disabled by default but be enabled by setting the `enable-debug-api` configuration option to `true`. The debug-API exposes functionality to inspect the state of your Bee node while it is running, as well as some other features that should not be exposed to the public internet. The Debug API runs on port `:1635` by default.
22
22
23
23
:::info
24
-
For a new installation of Bee, the debug API endpoint is not yet exposed for security reasons. To enable the debug API endpoints, set `debug-api-enable` to `true` in your [configuration file](/docs/installation/configuration#configuring-bee-installed-using-a-package-manager) and restart your Bee service.
24
+
For a new installation of Bee, the debug API endpoint is not yet exposed for security reasons. To enable the debug API endpoints, set `debug-api-enable` to `true` in your [configuration file](/docs/working-with-bee/configuration) and restart your Bee service.
25
25
:::
26
26
27
27
- <ahref="/debug-api"target="_blank"rel="noopener noreferrer">Debug API reference.</a>,
Copy file name to clipboardExpand all lines: docs/bee-developers/starting-a-test-network.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
@@ -3,7 +3,7 @@ title: Starting a Test Network
3
3
id: starting-a-test-network
4
4
---
5
5
6
-
A test network can be used to test your applications in an isolated environment before you deploy to Swarm mainnet. It can be started by overriding the default configuration values of your Swarm node. Throughout this tutorial, we will make use of configuration files to configure the nodes but of course you can also do the same using flags or environment variables (see [Start your node](/docs/installation/configuration)).
6
+
A test network can be used to test your applications in an isolated environment before you deploy to Swarm mainnet. It can be started by overriding the default configuration values of your Swarm node. Throughout this tutorial, we will make use of configuration files to configure the nodes but of course you can also do the same using flags or environment variables (see [Start your node](/docs/working-with-bee/configuration)).
Copy file name to clipboardExpand all lines: docs/bee-developers/useful-dev-info.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
@@ -49,7 +49,7 @@ Developers can gain an additional level of insight into the node by enabling `tr
49
49
- Start jaeger:
50
50
`docker run -p 6831:6831/udp -p 16686:16686 jaegertracing/all-in-one:latest`
51
51
52
-
- start locally two bee nodes (different data dirs and ports) and connect them (see "Start a test network" in the [advanced section](/docs/advanced/starting-a-test-network)) with `--tracing` flag provided for both nodes
52
+
- start locally two bee nodes (different data dirs and ports) and connect them (see "Start a test network" in the [advanced section](/docs/bee-developers/starting-a-test-network)) with `--tracing` flag provided for both nodes
53
53
54
54
- Make a call to the PingPong API on one of the two nodes (`curl -XPOST localhost:1735/pingpong/<overlay address other node>`).
Copy file name to clipboardExpand all lines: docs/dapps-on-swarm/bee-js.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
@@ -5,7 +5,7 @@ id: bee-js
5
5
6
6
Bee-js is Bee's complementary javascript library. It is the technology underpinning the [swarm-cli](/docs/working-with-bee/bee-tools) and [bee-dashboard](/docs/working-with-bee/bee-tools) tools and is a powerful tool for building completely decentralised apps.
7
7
8
-
For more information on how to develop with Bee without blowing all your gBZZ, read [this guide](/docs/dapps-on-swarm/develop-on-swarm)
8
+
For more information on how to develop with Bee without blowing all your gBZZ, read [this guide](/docs/dapps-on-swarm/develop-on-bee)
9
9
10
10
See the [bee-js](https://bee-js.ethswarm.org/) documentation for detailed information on using and installing the library.
Copy file name to clipboardExpand all lines: docs/dapps-on-swarm/feeds.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ id: feeds
6
6
Swarm feeds cleverly combine [single owner chunks](/docs/dapps-on-swarm/chunk-types) into a data structure which enables you to have static addresses for your mutable content. This means that you can signpost your data for other Bees, and then update at will.
7
7
8
8
:::info
9
-
Although it's possible to interact with feeds directly, it can be involve a little data juggling and crypto magic. For the easiest route, see [the bee-js feeds functionality](/docs/dapps-on-swarm/bee-js) and [swarm-cli](/docs/using-swarm/bee-tools), or for the super 1337, share your implementations in other languages in the [#develop-on-swarm](https://discord.gg/C6dgqpxZkU) channel of our [Discord Server](https://discord.gg/wdghaQsGq5).
9
+
Although it's possible to interact with feeds directly, it can be involve a little data juggling and crypto magic. For the easiest route, see [the bee-js feeds functionality](/docs/dapps-on-swarm/bee-js) and [swarm-cli](/docs/working-with-bee/bee-tools), or for the super 1337, share your implementations in other languages in the [#develop-on-swarm](https://discord.gg/C6dgqpxZkU) channel of our [Discord Server](https://discord.gg/wdghaQsGq5).
10
10
:::
11
11
12
12
### What are Feeds?
@@ -15,7 +15,7 @@ A feed is a collection of Single Owner Chunks with predicatable addresses. This
15
15
16
16
### Creating and Updating a Feed
17
17
18
-
In order to edit a feed, you will need to sign your chunks using an Ethereum keypair. For the intrepid, check out the [The Book of Swarm](https://gateway.ethswarm.org/bzz/latest.bookofswarm.eth/) on precise details on how to do this. For the rest of us, both [bee-js](/docs/dapps-on-swarm/bee-js) and [swarm-cli](/docs/using-swarm/bee-tools) provide facilities to achieve this using javascript and a node-js powered command line tool respectively.
18
+
In order to edit a feed, you will need to sign your chunks using an Ethereum keypair. For the intrepid, check out the [The Book of Swarm](https://gateway.ethswarm.org/bzz/latest.bookofswarm.eth/) on precise details on how to do this. For the rest of us, both [bee-js](/docs/dapps-on-swarm/bee-js) and [swarm-cli](/docs/working-with-bee/bee-tools) provide facilities to achieve this using javascript and a node-js powered command line tool respectively.
19
19
20
20
### No More ENS Transaction Charges
21
21
@@ -31,4 +31,4 @@ Use [bee-js](/docs/dapps-on-swarm/bee-js) to use feeds to store values as a simp
31
31
32
32
#### Store the History of a File
33
33
34
-
Use [swarm-cli](/docs/using-swarm/bee-tools) to store a file at the same location, and update whenever you like without changing the address.
34
+
Use [swarm-cli](/docs/working-with-bee/bee-tools) to store a file at the same location, and update whenever you like without changing the address.
0 commit comments