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/faq.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,12 +14,12 @@ Depending on your needs you can run an ultra-light, light or full node.
14
14
15
15
### What are the differences between Bee node types?
16
16
17
-
A bee node can be configured to run in various modes based on specific use cases and requirements. [See here](/docs/bee/installation/getting-started) for an overview of the differences.
17
+
A bee node can be configured to run in various modes based on specific use cases and requirements. [See here](./installation/getting-started.md) for an overview of the differences.
18
18
19
19
20
20
#### What are the requirements for running a Bee node?
21
21
22
-
See the [getting started section](/docs/bee/installation/getting-started#software-requirements) for more information about running a Bee node.
22
+
See the [getting started section](./installation/getting-started.md#software-requirements) for more information about running a Bee node.
23
23
24
24
##### Full node
25
25
@@ -39,19 +39,19 @@ Typically, each node requires around 10 megabits per second (Mbps) of bandwidth
39
39
40
40
Bee is compatible with Windows and a Bee `.exe` file can be found on the [`releases` page](https://github.com/ethersphere/bee/releases) of the Bee repo.
41
41
42
-
It is also possible to [build from the source](/docs/bee/installation/build-from-source).
42
+
It is also possible to [build from the source](./installation/build-from-source.md).
43
43
44
44
##### How do I get the node's wallet's private key (use-case for Desktop app)?
45
45
46
-
See the [backup section](/docs/bee/working-with-bee/backups/) for more info.
46
+
See the [backup section](./working-with-bee/backups.md) for more info.
47
47
48
48
##### How do I import my private key to Metamask?
49
49
50
50
You can import the `swarm.key` json file in MetaMask using your password file or the password you have set in your bee config file.
51
51
52
52
##### Where can I find my password?
53
53
54
-
You can find the password in the root of your data directory. See the [backup section](/docs/bee/working-with-bee/backups/) for more info.
54
+
You can find the password in the root of your data directory. See the [backup section](./working-with-bee/backups.md) for more info.
55
55
56
56
## Connectivity
57
57
@@ -92,11 +92,11 @@ We recommend you run your own [Gnosis Node using Nethermind](https://docs.gnosis
92
92
93
93
### How can I export my private keys?
94
94
95
-
See the section on [backups](/docs/bee/working-with-bee/backups) for exporting your keys.
95
+
See the section on [backups](./working-with-bee/backups.md) for exporting your keys.
96
96
97
97
### How to import bee node address to MetaMask?
98
98
99
-
1. See the [backup section](/docs/bee/working-with-bee/backups/) for info on exporting keys.
99
+
1. See the [backup section](./working-with-bee/backups.md) for info on exporting keys.
100
100
2. Go to Metamask and click "Account 1" --> "Import Account"
101
101
3. Choose the "Select Type" dropdown menu and choose "JSON file"
102
102
4. Paste the password (Make sure to do this first)
@@ -128,7 +128,7 @@ Get your chequebook contract address with: `curl http://localhost:1633/chequeboo
128
128
129
129
### Where can I find documents about the cashout commands?
130
130
131
-
Learn how to cash out [here](/docs/bee/working-with-bee/cashing-out).
131
+
Learn how to cash out [here](./working-with-bee/cashing-out.md).
132
132
133
133
### When I run http://localhost:1633/chequebook/balance I get "totalBalance" and "availableBalance" what is the difference?
Copy file name to clipboardExpand all lines: docs/bee/installation/docker.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Note that in all the examples below we map the Bee API to 127.0.0.1 (localhost),
17
17
:::
18
18
19
19
:::info
20
-
This guide sets options using environment variables as part of the Docker startup commands such as `-e BEE_API_ADDR=":1633"`, however there are [several other methods available for configuring options](/docs/bee/working-with-bee/configuration).
20
+
This guide sets options using environment variables as part of the Docker startup commands such as `-e BEE_API_ADDR=":1633"`, however there are [several other methods available for configuring options](./../working-with-bee/configuration.md).
21
21
:::
22
22
23
23
@@ -275,11 +275,11 @@ Congratulations! You have now installed your Bee node and successfully connected
275
275
276
276
### Set Target Neighborhood
277
277
278
-
When installing your Bee node it will automatically be assigned a neighborhood. However, when running a full node with staking there are benefits to periodically updating your node's neighborhood. Learn more about why and how to set your node's target neighborhood [here](/docs/bee/installation/set-target-neighborhood).
278
+
When installing your Bee node it will automatically be assigned a neighborhood. However, when running a full node with staking there are benefits to periodically updating your node's neighborhood. Learn more about why and how to set your node's target neighborhood [here](./set-target-neighborhood.md).
279
279
280
280
### Logs and monitoring
281
281
282
-
Docker provides convenient built-in tools for logging and monitoring your node, which you've already encountered if you've read through earlier sections of this guide. For a more detailed guide, [refer to the section on logging](/docs/bee/working-with-bee/logs-and-files).
282
+
Docker provides convenient built-in tools for logging and monitoring your node, which you've already encountered if you've read through earlier sections of this guide. For a more detailed guide, [refer to the section on logging](./../working-with-bee/logs-and-files.md).
283
283
284
284
**Viewing node logs:**
285
285
@@ -342,26 +342,26 @@ Replace `bee-1` with the name of your node if you've given it a different name.
342
342
343
343
## Back Up Keys
344
344
345
-
Once your node is up and running, make sure to [back up your keys](/docs/bee/working-with-bee/backups).
345
+
Once your node is up and running, make sure to [back up your keys](./../working-with-bee/backups.md).
346
346
347
347
## Getting help
348
348
349
349
The CLI has documentation built-in. Running `bee` gives you an entry point to the documentation. Running `bee start -h` from within your Docker container or `bee start --help` will tell you how you can configure your Bee node via the command line arguments.
350
350
351
-
You may also check out the [configuration guide](/docs/bee/working-with-bee/configuration), or simply run your Bee terminal command with the `--help` flag, eg. `bee start --help` or `bee --help`.
351
+
You may also check out the [configuration guide](./../working-with-bee/configuration.md), or simply run your Bee terminal command with the `--help` flag, eg. `bee start --help` or `bee --help`.
352
352
353
353
354
354
## Next Steps to Consider
355
355
356
356
357
357
### Access the Swarm
358
-
If you'd like to start uploading or downloading files to Swarm, [start here](/docs/develop/introduction).
358
+
If you'd like to start uploading or downloading files to Swarm, [start here](./../../develop/introduction.md).
359
359
360
360
### Explore the API
361
-
The [Bee API](/docs/bee/working-with-bee/bee-api) is the primary method for interacting with Bee and getting information about Bee. After installing Bee and getting it up and running, it's a good idea to start getting familiar with the API.
361
+
The [Bee API](./../working-with-bee/bee-api.md) is the primary method for interacting with Bee and getting information about Bee. After installing Bee and getting it up and running, it's a good idea to start getting familiar with the API.
362
362
363
363
### Run a hive!
364
-
If you would like to run a hive of many Bees, check out the [hive operators](/docs/bee/installation/hive) section for information on how to operate and monitor many Bees at once.
364
+
If you would like to run a hive of many Bees, check out the [hive operators](./hive.md) section for information on how to operate and monitor many Bees at once.
365
365
366
366
### Start building DApps on Swarm
367
-
If you would like to start building decentralised applications on Swarm, check out our section for [developing with Bee](/docs/develop/introduction).
367
+
If you would like to start building decentralised applications on Swarm, check out our section for [developing with Bee](./../../develop/introduction.md).
Copy file name to clipboardExpand all lines: docs/bee/installation/fund-your-node.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,10 @@ description: Outlines xDAI and xBZZ token requirements by use case and provides
8
8
Bee nodes require **xDAI** (for gas fees) and **xBZZ** (for storage and bandwidth) to function properly. The amount needed depends on your node type and use case.
Fund your node with the appropriate amount of xDAI and xBZZ based on the recommended amounts specified in [the chart above](/docs/bee/installation/fund-your-node#token-amounts-by-use-case).
73
+
Fund your node with the appropriate amount of xDAI and xBZZ based on the recommended amounts specified in [the chart above](./fund-your-node.md#token-amounts-by-use-case).
74
74
75
75
76
76
*For support, ask in the [Develop on Swarm](https://discord.com/channels/799027393297514537/811574542069137449) Discord channel.*
:::caution[New Bee Users: Read This Guide in Full]
@@ -26,7 +26,7 @@ For new Bee users, it is strongly recommended to read through this ***entire gui
26
26
27
27
Bee nodes can be run in three different modes, ***full***, ***light***, or ***ultra-light***. Full nodes provide complete access to all of Swarm's features including downloads, uploads, full participation in Swarm's incentives systems, and advanced messaging features such as PSS and GSOC. Light nodes are primarily for downloading and uploading only. Ultra-light nodes are the most limited, and only allow users to download a small amount of data with the free-tier limits set by full node operators.
28
28
29
-
The [Node Types](/docs/bee/working-with-bee/node-types) page provides you with an in-depth look into the features and limitations of each node type along with instructions for how to set node options for all three types.
29
+
The [Node Types](./../working-with-bee/node-types.md) page provides you with an in-depth look into the features and limitations of each node type along with instructions for how to set node options for all three types.
30
30
31
31
## Choosing a Node Type
32
32
The node type you need to run will differ depending on your use-case:
@@ -37,13 +37,13 @@ The node type you need to run will differ depending on your use-case:
37
37
|**DApp Development**| Light, Full | Light nodes are sufficient for many DApp use cases. Full nodes are required for advanced features like GSOC and PSS. |
38
38
|**Earning xBZZ & Supporting the Network**| Full | Full nodes are necessary for storage incentives and long-term xBZZ earnings. Running multiple nodes? Consider using [Docker](https://www.docker.com/), [Docker Compose](https://docs.docker.com/compose/), or [Kubernetes](https://kubernetes.io/) for easier management. |
39
39
40
-
Refer to the [Node Types](/docs/bee/working-with-bee/node-types) page for deep dive into each node type, their features and limitations, and configuration instructions.
40
+
Refer to the [Node Types](./../working-with-bee/node-types.md) page for deep dive into each node type, their features and limitations, and configuration instructions.
41
41
42
42
## Software Requirements
43
43
44
44
### Recommended Operating Systems
45
45
- Officially supported systems are listed in the [Bee releases](https://github.com/ethersphere/bee/releases).
46
-
- You can [build from source](/docs/bee/installation/build-from-source) if your OS is unsupported.
46
+
- You can [build from source](./build-from-source.md) if your OS is unsupported.
47
47
-**Swarm Desktop users** can use macOS, Windows, or Linux.
48
48
-**Linux/macOS recommended**: Most tools and documentation are designed for Unix-based systems.
49
49
-**Windows users**: While a Window release of Bee is available, you may also consider using [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) and using a Linux version of Bee.
@@ -54,8 +54,8 @@ While not strictly required, these tools will *greatly* simplify your experience
54
54
55
55
-**[`jq`](https://jqlang.github.io/jq/)**: Formats JSON responses (recommended for API users).
56
56
-**[`curl`](https://curl.se/)**: Used for sending API requests (required for API interactions).
-**[Bee JS](./../../develop/tools-and-features/bee-js.md)**: JavaScript library for programmatic API access.
59
59
60
60
## Hardware Requirements
61
61
@@ -84,10 +84,10 @@ A reliable, high-speed internet connection is recommended when running a full no
84
84
### RPC Endpoint
85
85
86
86
:::warning
87
-
***Free public RPC endpoints are discouraged*** since they may enforce rate limiting or may not store the historical smart contract data required by Bee nodes. [Read more](/docs/bee/working-with-bee/configuration#setting-blockchain-rpc-endpoint).
87
+
***Free public RPC endpoints are discouraged*** since they may enforce rate limiting or may not store the historical smart contract data required by Bee nodes. [Read more](./../working-with-bee/configuration.md#setting-blockchain-rpc-endpoint).
88
88
:::
89
89
90
-
An [RPC (Remote Procedure Call) endpoint](/docs/references/glossary#rpc-endpoint) is required to allow your node to interact with **Gnosis Chain**, which is required for transactions like purchasing postage stamps, staking xBZZ, and storage incentives related transactions.
90
+
An [RPC (Remote Procedure Call) endpoint](./../../references/glossary.md#rpc-endpoint) is required to allow your node to interact with **Gnosis Chain**, which is required for transactions like purchasing postage stamps, staking xBZZ, and storage incentives related transactions.
91
91
92
92
Bee nodes use the **`--blockchain-rpc-endpoint`** configuration option to specify which Gnosis Chain RPC service to connect to.
93
93
@@ -110,30 +110,30 @@ Without a properly configured RPC endpoint, a Bee node cannot interact with the
110
110
111
111
If running Bee on a home network, there is a good chance it is behind NAT by default. Often simply [enabling port forwarding](https://www.noip.com/support/knowledgebase/general-port-forwarding-guide) will be enough to allow your node to start communicating smoothly with the rest of the network.
112
112
113
-
See [this page](/docs/bee/installation/connectivity/) for more information on how to make sure your node can communicate with the network.
113
+
See [this page](./connectivity.md) for more information on how to make sure your node can communicate with the network.
114
114
115
115
For VPS/cloud-based setups, connectivity is typically unrestricted.
116
116
117
117
If your home network happens to be using [CGNAT (Carrier-Grade NAT)](https://en.wikipedia.org/wiki/Carrier-grade_NAT), you may face significant difficulty with setting up your node so it can connect with the rest of the network. Contacting your IP provider may be required.
Copy file name to clipboardExpand all lines: docs/bee/installation/hive.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
@@ -4,12 +4,12 @@ id: hive
4
4
description: Describes tools and orchestration methods for managing multiple Bee nodes using Docker Compose Helm or manual configuration.
5
5
---
6
6
7
-
Due to the mechanics of Swarm's [storage incentives](/docs/concepts/incentives/redistribution-game), node operators may wish to run multiple nodes in order to maximize earning potential. Read [The Book of Swarm](https://www.ethswarm.org/the-book-of-swarm-2.pdf) for more information on how the
7
+
Due to the mechanics of Swarm's [storage incentives](./../../concepts/incentives/redistribution-game.md), node operators may wish to run multiple nodes in order to maximize earning potential. Read [The Book of Swarm](https://www.ethswarm.org/the-book-of-swarm-2.pdf) for more information on how the
8
8
swarm comes together.
9
9
10
10
### Docker
11
11
12
-
Up-to-date [Docker images for Bee](/docs/bee/installation/docker) are provided.
12
+
Up-to-date [Docker images for Bee](./docker.md) are provided.
13
13
14
14
### Docker Compose
15
15
@@ -37,4 +37,4 @@ Configure your nodes as desired, but ensure that the values `api-addr`, `data-di
37
37
38
38
### Monitoring
39
39
40
-
See the [logging section](/docs/bee/working-with-bee/logs-and-files) for more information on how to access your node's metrics. Share your community creations (such as [swarmMonitor](https://github.com/doristeo/SwarmMonitoring) - thanks doristeo!) in the [#node-operators](https://discord.gg/X3ph5yGRFU) channel of our Discord server so we can add you to our list of all things that are [awesome](https://github.com/ethersphere/awesome-swarm) and Swarm. 🧡
40
+
See the [logging section](./../working-with-bee/logs-and-files.md) for more information on how to access your node's metrics. Share your community creations (such as [swarmMonitor](https://github.com/doristeo/SwarmMonitoring) - thanks doristeo!) in the [#node-operators](https://discord.gg/X3ph5yGRFU) channel of our Discord server so we can add you to our list of all things that are [awesome](https://github.com/ethersphere/awesome-swarm) and Swarm. 🧡
0 commit comments