Skip to content

Commit 787cd85

Browse files
committed
refactor: convert links to modern Docusaurus format, migrate deprecated config, and add quiet build script
1 parent fa9738c commit 787cd85

63 files changed

Lines changed: 4588 additions & 2012 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.claude/settings.local.json

Lines changed: 0 additions & 7 deletions
This file was deleted.

.nvmrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
20
1+
22.21.0

docs/bee/faq.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ Depending on your needs you can run an ultra-light, light or full node.
1414

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

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

1919

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

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

2424
##### Full node
2525

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

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

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

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

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

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

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

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

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

5656
## Connectivity
5757

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

9393
### How can I export my private keys?
9494

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

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

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.
100100
2. Go to Metamask and click "Account 1" --> "Import Account"
101101
3. Choose the "Select Type" dropdown menu and choose "JSON file"
102102
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
128128

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

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

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

docs/bee/installation/docker.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Note that in all the examples below we map the Bee API to 127.0.0.1 (localhost),
1717
:::
1818

1919
:::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).
2121
:::
2222

2323

@@ -275,11 +275,11 @@ Congratulations! You have now installed your Bee node and successfully connected
275275
276276
### Set Target Neighborhood
277277
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).
279279
280280
### Logs and monitoring
281281
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).
283283
284284
**Viewing node logs:**
285285
@@ -342,26 +342,26 @@ Replace `bee-1` with the name of your node if you've given it a different name.
342342
343343
## Back Up Keys
344344
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).
346346
347347
## Getting help
348348
349349
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.
350350
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`.
352352
353353
354354
## Next Steps to Consider
355355
356356
357357
### 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).
359359
360360
### 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.
362362
363363
### 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.
365365
366366
### 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).

docs/bee/installation/fund-your-node.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ description: Outlines xDAI and xBZZ token requirements by use case and provides
88
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.
99

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

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

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

7575

7676
*For support, ask in the [Develop on Swarm](https://discord.com/channels/799027393297514537/811574542069137449) Discord channel.*

docs/bee/installation/getting-started.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ id: getting-started
44
description: Introduces Bee node types their requirements and available installation methods to help users choose appropriate setup approaches.
55
---
66

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

99
## Overview
1010

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

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

2020

2121
:::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
2626

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

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

3131
## Choosing a Node Type
3232
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:
3737
| **DApp Development** | Light, Full | Light nodes are sufficient for many DApp use cases. Full nodes are required for advanced features like GSOC and PSS. |
3838
| **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. |
3939

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

4242
## Software Requirements
4343

4444
### Recommended Operating Systems
4545
- 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.
4747
- **Swarm Desktop users** can use macOS, Windows, or Linux.
4848
- **Linux/macOS recommended**: Most tools and documentation are designed for Unix-based systems.
4949
- **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
5454

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

6060
## Hardware Requirements
6161

@@ -84,10 +84,10 @@ A reliable, high-speed internet connection is recommended when running a full no
8484
### RPC Endpoint
8585

8686
:::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).
8888
:::
8989

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

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

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

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

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

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

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

119119
## Installation Methods
120120

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

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

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

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

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

docs/bee/installation/hive.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ id: hive
44
description: Describes tools and orchestration methods for managing multiple Bee nodes using Docker Compose Helm or manual configuration.
55
---
66

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
88
swarm comes together.
99

1010
### Docker
1111

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

1414
### Docker Compose
1515

@@ -37,4 +37,4 @@ Configure your nodes as desired, but ensure that the values `api-addr`, `data-di
3737

3838
### Monitoring
3939

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

Comments
 (0)