Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,7 @@ resources
# Generated content
/src/pages/awesome-swarm.mdx
test
*.zip
*.zip
*.csv
# Tools
.claude
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
20
22.21.0
17 changes: 9 additions & 8 deletions docs/bee/faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Bee FAQ
id: bee-faq
description: Addresses common questions about running Bee nodes including setup installation troubleshooting and blockchain interactions.
---

## Running a Bee Node
Expand All @@ -13,12 +14,12 @@ Depending on your needs you can run an ultra-light, light or full node.

### What are the differences between Bee node types?

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.
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.


#### What are the requirements for running a Bee node?

See the [getting started section](/docs/bee/installation/getting-started#software-requirements) for more information about running a Bee node.
See the [getting started section](./installation/getting-started.md#software-requirements) for more information about running a Bee node.

##### Full node

Expand All @@ -38,19 +39,19 @@ Typically, each node requires around 10 megabits per second (Mbps) of bandwidth

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.

It is also possible to [build from the source](/docs/bee/installation/build-from-source).
It is also possible to [build from the source](./installation/build-from-source.md).

##### How do I get the node's wallet's private key (use-case for Desktop app)?

See the [backup section](/docs/bee/working-with-bee/backups/) for more info.
See the [backup section](./working-with-bee/backups.md) for more info.

##### How do I import my private key to Metamask?

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.

##### Where can I find my password?

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.
You can find the password in the root of your data directory. See the [backup section](./working-with-bee/backups.md) for more info.

## Connectivity

Expand Down Expand Up @@ -91,11 +92,11 @@ We recommend you run your own [Gnosis Node using Nethermind](https://docs.gnosis

### How can I export my private keys?

See the section on [backups](/docs/bee/working-with-bee/backups) for exporting your keys.
See the section on [backups](./working-with-bee/backups.md) for exporting your keys.

### How to import bee node address to MetaMask?

1. See the [backup section](/docs/bee/working-with-bee/backups/) for info on exporting keys.
1. See the [backup section](./working-with-bee/backups.md) for info on exporting keys.
2. Go to Metamask and click "Account 1" --> "Import Account"
3. Choose the "Select Type" dropdown menu and choose "JSON file"
4. Paste the password (Make sure to do this first)
Expand Down Expand Up @@ -127,7 +128,7 @@ Get your chequebook contract address with: `curl http://localhost:1633/chequeboo

### Where can I find documents about the cashout commands?

Learn how to cash out [here](/docs/bee/working-with-bee/cashing-out).
Learn how to cash out [here](./working-with-bee/cashing-out.md).

### When I run http://localhost:1633/chequebook/balance I get "totalBalance" and "availableBalance" what is the difference?

Expand Down
1 change: 1 addition & 0 deletions docs/bee/installation/build-from-source.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Build from Source
id: build-from-source
description: Guides developers through compiling Bee directly from source code using Go git and make with step-by-step instructions.
---

Bee is written using the [Go](https://golang.org) language.
Expand Down
1 change: 1 addition & 0 deletions docs/bee/installation/connectivity.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Connectivity
id: connectivity
description: Explains network setup and NAT configuration to ensure Bee nodes can communicate with peers on both private and public networks.
---

To fully connect to the swarm, your Bee node needs to be able to both
Expand Down
19 changes: 10 additions & 9 deletions docs/bee/installation/docker.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Docker Install
id: docker
description: Provides comprehensive steps for deploying Bee nodes using Docker containers with volume management and network configuration.
---

# Docker Install
Expand All @@ -16,7 +17,7 @@ Note that in all the examples below we map the Bee API to 127.0.0.1 (localhost),
:::

:::info
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).
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).
:::


Expand Down Expand Up @@ -274,11 +275,11 @@ Congratulations! You have now installed your Bee node and successfully connected

### Set Target Neighborhood

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).
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).

### Logs and monitoring

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).
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).

**Viewing node logs:**

Expand Down Expand Up @@ -341,26 +342,26 @@ Replace `bee-1` with the name of your node if you've given it a different name.

## Back Up Keys

Once your node is up and running, make sure to [back up your keys](/docs/bee/working-with-bee/backups).
Once your node is up and running, make sure to [back up your keys](./../working-with-bee/backups.md).

## Getting help

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.

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`.
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`.


## Next Steps to Consider


### Access the Swarm
If you'd like to start uploading or downloading files to Swarm, [start here](/docs/develop/introduction).
If you'd like to start uploading or downloading files to Swarm, [start here](./../../develop/introduction.md).

### Explore the API
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.
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.

### Run a hive!
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.
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.

### Start building DApps on Swarm
If you would like to start building decentralised applications on Swarm, check out our section for [developing with Bee](/docs/develop/introduction).
If you would like to start building decentralised applications on Swarm, check out our section for [developing with Bee](./../../develop/introduction.md).
11 changes: 6 additions & 5 deletions docs/bee/installation/fund-your-node.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
---
title: Fund Your Node
id: fund-your-node
description: Outlines xDAI and xBZZ token requirements by use case and provides guidance on acquiring tokens from exchanges and faucets.
---

## Overview
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.

### xDAI is Required For:
- **Buying Postage Stamps** ([Uploading Data](/docs/develop/tools-and-features/buy-a-stamp-batch))
- **Stake Management Transactions** ([Staking](/docs/bee/working-with-bee/staking/))
- **Storage Incentives Transactions** ([Redistribution Game](/docs/concepts/incentives/redistribution-game/) )
- **Chequebook Deployment** ([Bandwidth Payments](/docs/concepts/incentives/bandwidth-incentives/))
- **Buying Postage Stamps** ([Uploading Data](./../../develop/tools-and-features/buy-a-stamp-batch.md))
- **Stake Management Transactions** ([Staking](./../working-with-bee/staking.md))
- **Storage Incentives Transactions** ([Redistribution Game](./../../concepts/incentives/redistribution-game.md))
- **Chequebook Deployment** ([Bandwidth Payments](./../../concepts/incentives/bandwidth-incentives.md))

### xBZZ is Required For:
- **Buying Postage Stamps** (scales with data size and duration)
Expand Down Expand Up @@ -69,7 +70,7 @@ curl -s localhost:1633/addresses | jq .ethereum
"0x9a73f283cd9212b99b5e263f9a81a0ddc847cd93"
```

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).
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).


*For support, ask in the [Develop on Swarm](https://discord.com/channels/799027393297514537/811574542069137449) Discord channel.*
Expand Down
41 changes: 21 additions & 20 deletions docs/bee/installation/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
---
title: Getting Started
id: getting-started
description: Introduces Bee node types their requirements and available installation methods to help users choose appropriate setup approaches.
---

*If you want to get a Bee node up and running ASAP, check out the [Quick Start](/docs/bee/installation/quick-start) guide.*
*If you want to get a Bee node up and running ASAP, check out the [Quick Start](./quick-start.md) guide.*

## Overview

This guide provides the essential background information to help you start running a Bee node, including:

- [Types of Bee nodes and their features](/docs/bee/installation/getting-started#node-types)
- [Choosing the right node type](/docs/bee/installation/getting-started#choosing-a-node-type)
- [Software requirements](/docs/bee/installation/getting-started#software-requirements)
- [Hardware requirements](/docs/bee/installation/getting-started#hardware-requirements)
- [Network requirements](/docs/bee/installation/getting-started#network-requirements)
- [Installation methods](/docs/bee/installation/getting-started#installation-methods)
- [Types of Bee nodes and their features](./getting-started.md#node-types)
- [Choosing the right node type](./getting-started.md#choosing-a-node-type)
- [Software requirements](./getting-started.md#software-requirements)
- [Hardware requirements](./getting-started.md#hardware-requirements)
- [Network requirements](./getting-started.md#network-requirements)
- [Installation methods](./getting-started.md#installation-methods)


:::caution[New Bee Users: Read This Guide in Full]
Expand All @@ -25,7 +26,7 @@ For new Bee users, it is strongly recommended to read through this ***entire gui

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.

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.
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.

## Choosing a Node Type
The node type you need to run will differ depending on your use-case:
Expand All @@ -36,13 +37,13 @@ The node type you need to run will differ depending on your use-case:
| **DApp Development** | Light, Full | Light nodes are sufficient for many DApp use cases. Full nodes are required for advanced features like GSOC and PSS. |
| **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. |

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.
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.

## Software Requirements

### Recommended Operating Systems
- Officially supported systems are listed in the [Bee releases](https://github.com/ethersphere/bee/releases).
- You can [build from source](/docs/bee/installation/build-from-source) if your OS is unsupported.
- You can [build from source](./build-from-source.md) if your OS is unsupported.
- **Swarm Desktop users** can use macOS, Windows, or Linux.
- **Linux/macOS recommended**: Most tools and documentation are designed for Unix-based systems.
- **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.
Expand All @@ -53,8 +54,8 @@ While not strictly required, these tools will *greatly* simplify your experience

- **[`jq`](https://jqlang.github.io/jq/)**: Formats JSON responses (recommended for API users).
- **[`curl`](https://curl.se/)**: Used for sending API requests (required for API interactions).
- **[Swarm CLI](/docs/bee/working-with-bee/swarm-cli/)**: Terminal-based Bee node management.
- **[Bee JS](/docs/develop/tools-and-features/bee-js)**: JavaScript library for programmatic API access.
- **[Swarm CLI](./../working-with-bee/swarm-cli.md)**: Terminal-based Bee node management.
- **[Bee JS](./../../develop/tools-and-features/bee-js.md)**: JavaScript library for programmatic API access.

## Hardware Requirements

Expand Down Expand Up @@ -83,10 +84,10 @@ A reliable, high-speed internet connection is recommended when running a full no
### RPC Endpoint

:::warning
***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).
***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).
:::

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.
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.

Bee nodes use the **`--blockchain-rpc-endpoint`** configuration option to specify which Gnosis Chain RPC service to connect to.

Expand All @@ -109,30 +110,30 @@ Without a properly configured RPC endpoint, a Bee node cannot interact with the

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.

See [this page](/docs/bee/installation/connectivity/) for more information on how to make sure your node can communicate with the network.
See [this page](./connectivity.md) for more information on how to make sure your node can communicate with the network.

For VPS/cloud-based setups, connectivity is typically unrestricted.

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.

## Installation Methods

### [Swarm Desktop](/docs/desktop/introduction)
### [Swarm Desktop](./../../desktop/introduction.md)
- Best for beginners.
- GUI-based interface.

### [Shell Script Install](/docs/bee/installation/shell-script-install)
### [Shell Script Install](./shell-script.md)
- Quick setup using a minimal script.
- Requires manual configuration for background operation.

### [Docker Install](/docs/bee/installation/docker)
### [Docker Install](./docker.md)
- Suitable for running multiple nodes.
- Offers easy container management.

### [Package Manager Install](/docs/bee/installation/package-manager-install)
### [Package Manager Install](./package-manager.md)
- Uses APT, RPM, or Homebrew.
- Runs Bee as a background service.

### [Building from Source](/docs/bee/installation/build-from-source)
### [Building from Source](./build-from-source.md)
- Most flexible, but requires advanced setup.

Loading