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-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
@@ -7,7 +7,7 @@ Welcome to the Dev area! We love PR's! 🐝
7
7
8
8
We would would love you to get involved with our [Github repo](https://github.com/ethersphere/bee).
9
9
10
-
All the action can be found in our Mattermost instance, [The Beehive](https://beehive.ethswarm.org/). Sign up and get involved with our buzzing hive of daily dev chat.
10
+
All the action can be found in our [Discord Server](https://discord.gg/wdghaQsGq5). Sign up and get involved with our buzzing hive of daily dev chat.
11
11
12
12
If you would like to contribute, please read the [coding guidelines](https://github.com/ethersphere/bee/blob/master/CODING.md) before you get started.
Copy file name to clipboardExpand all lines: docs/installation/configuration.md
+50-5Lines changed: 50 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,15 +70,22 @@ This produces the following file contents, showing the default configuration of
70
70
api-addr: :1633
71
71
bootnode:
72
72
- /dnsaddr/bootnode.ethswarm.org
73
+
bootnode-mode: false
73
74
clef-signer-enable: false
74
75
clef-signer-endpoint: ""
76
+
clef-signer-ethereum-address: ""
75
77
cors-allowed-origins: []
76
78
data-dir: /Users/sig/.bee
79
+
db-block-cache-capacity: "33554432"
77
80
db-capacity: "5000000"
81
+
db-disable-seeks-compaction: false
82
+
db-open-files-limit: "200"
83
+
db-write-buffer-size: "33554432"
78
84
debug-api-addr: :1635
79
85
debug-api-enable: false
80
86
gateway-mode: false
81
87
global-pinning-enable: false
88
+
help: false
82
89
nat-addr: ""
83
90
network-id: "1"
84
91
p2p-addr: :1634
@@ -144,6 +151,16 @@ Set this to true to enable signing using Ethereum's 'Clef' external signer. Clef
144
151
145
152
You may also specify a custom ipc file path for your Clef signer.
146
153
154
+
#### --clef-signer-ethereum-address
155
+
156
+
*default* **selects the clef address at index 0**
157
+
158
+
Use this command to specify which Bee Clef address is used if you have imported multiple keys into Bee Clef.
159
+
160
+
:::warning
161
+
If you have multiple addresses imported into your instance of Bee Clef, you must specify your address for each node, including the first one, as addresses may been re-ordered during import.
162
+
:::
163
+
147
164
#### --cors-allowed-origins
148
165
149
166
*default* `[]`
@@ -188,6 +205,32 @@ They are the cryptographic proof of your network identity and cannot be recovere
188
205
189
206
Chunk database capacity in chunks. A chunk is 4096 bytes in size, so the total database capacity in kb can be estimated as `db-capacity * 4096`. The default 5,000,000 chunks is therefore approximately 20.5gb. We recommend a minimum of 2.5gb capacity for a node to be able to effectively function in the network. Light nodes that do not participate in storing may be able to specify less.
190
207
208
+
*The below four options expose low-level configurations for [LevelDB](https://pkg.go.dev/github.com/syndtr/goleveldb@v1.0.0/leveldb/opt#Options) method [Openfile](https://pkg.go.dev/github.com/syndtr/goleveldb@v1.0.0/leveldb#OpenFile). Please let us know how you get on with tweaking these settings on your hardware in the `#swarm-infrastructure` channel on our [Discord server](https://discord.gg/wdghaQsGq5)*
209
+
210
+
#### --db-block-cache-capacity
211
+
*default* `33554432`
212
+
213
+
Corresponds to LevelDB `BlockCacheCapacity` (see above)
214
+
215
+
#### --db-disable-seeks-compaction
216
+
*default* `false`
217
+
218
+
Corresponds to LevelDB `DisableSeeksCompaction` (see above)
219
+
220
+
#### --db-open-files-limit
221
+
*default* `200`
222
+
223
+
:::info
224
+
To accomodate less powerful hardware and operating systems, the `open-files-limit` is set deliberately low. We recommend that you try to increase it to nearer `10000` or more if this is possible when using your hardware. *Please let us know how you get on with tweaking these settings on your hardware in the `#swarm-infrastructure` channel on our [Discord server](https://discord.gg/wdghaQsGq5)*
225
+
:::
226
+
227
+
Corresponds to LevelDB `OpenFilesCacheCapacity` (see above)
228
+
229
+
#### --db-write-buffer-size
230
+
*default* `33554432`
231
+
232
+
Corresponds to LevelDB `WriteBuffer` (see above)
233
+
191
234
#### --debug-api-addr
192
235
193
236
*default* `:1635`
@@ -263,23 +306,25 @@ The path to a file that contains password for decrypting keys. The empty string
263
306
264
307
#### --payment-early
265
308
266
-
Amount in BZZ below the peers payment threshold which causes Bee to initiate settlement (default 10000)
309
+
*default* `1000000000000`
310
+
311
+
Amount in BZZ below the peers payment threshold which causes Bee to initiate settlement.
267
312
268
313
#### --payment-threshold
269
314
270
-
*default* `100000`
315
+
*default* `10000000000000`
271
316
272
317
The threshold in BZZ where you expect to get paid from your peers.
273
318
274
319
#### --payment-tolerance
275
320
276
-
*default* `10000`
321
+
*default* `50000000000000`
277
322
278
323
The excess debt above payment threshold in BZZ where you disconnect from your peer.
Copy file name to clipboardExpand all lines: docs/installation/connectivity.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
@@ -96,7 +96,7 @@ Bee's solution to these problems come in two flavours, automatic and manual.
96
96
UPNP is a protocol designed to simplify the administration of NAT and port forwarding by the end user by providing an API which software running within the network can use to ask the router for the external IP and to request for ports to be forwarded to the internal IP of the computer running the software.
97
97
98
98
:::danger UPNP is a security risk!
99
-
UPNP is a security risk as it allows any host or process inside (sometimes also outside) your network to open arbitrary ports which may be used to transfer malicious traffic, for example a [RAT](https://en.wikipedia.org/wiki/Remote_desktop_software#RAT). We urge you to disable UPNP on your router and use manual port forwarding as described below.
99
+
UPNP is a security risk as it allows any host or process inside (sometimes also outside) your network to open arbitrary ports which may be used to transfer malicious traffic, for example a [RAT](https://en.wikipedia.org/wiki/Remote_desktop_software#RAT). UPNP can also be used to determine your IP, and in the case of using Tor or a VPN, your *real* public IP. be We urge you to disable UPNP on your router and use manual port forwarding as described below.
100
100
:::
101
101
102
102
Bee will use UPNP to determine your public IP, which is required for various internal processes.
Next, create a `.env` file using the example file provided. This file will be responsible for storing configuration and secrets for our Bee and Bee Clef applications.
There are some important configuration parameters which must be set in order for our projects to work. To affect configuration in the `.env` file, we first remove the `#` at the beginning of the line and then change the value after `=` to our desired config.
Copy file name to clipboardExpand all lines: docs/installation/quick-start.md
+51-11Lines changed: 51 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,9 @@ title: Quick Start
3
3
id: quick-start
4
4
---
5
5
6
+
import Tabs from '@theme/Tabs';
7
+
import TabItem from '@theme/TabItem';
8
+
6
9
Bee is packaged for MacOS and Ubuntu, Raspbian, Debian and CentOS based Linux distributions.
7
10
8
11
If your system is not supported, please see the [manual installation](/docs/installation/manual) section for information on how to install Bee.
@@ -14,10 +17,14 @@ The overview of the installation process:
14
17
15
18
## Install Bee Clef
16
19
20
+
:::info
21
+
While it is not necessary that node operators make use of Go Ethereum's Clef external signer to manage your Ethereum key pair. Follow these instructions include and integrate Bee-clef alongside Bee to help keep your keys safe!
22
+
:::
23
+
17
24
Before installing Bee, it is recommended that you first [install the Bee clef package](/docs/installation/bee-clef). This will set up a Bee specific instance of the Go-Ethereum Clef signer which will be integrated with your Bee node.
18
25
19
-
:::info
20
-
While it is not necessary that node operators make use of Go Ethereum's Clef external signer to manage your Ethereum key pair. The following instructions include and integrate Bee-clef alongside Bee to help keep your keys safe!
26
+
:::caution
27
+
If choosing to use Bee-clef, you must install this *before* you install Bee.
21
28
:::
22
29
23
30
## Install Bee
@@ -28,12 +35,22 @@ To install Bee itself, simply choose the appropriate command from the ones below
28
35
Follow post install guide in terminal for initial configuration and how to start `bee`.
@@ -91,6 +112,9 @@ To run Bee as a service now and on startup, run:
91
112
brew services start swarm-bee
92
113
```
93
114
115
+
</TabItem>
116
+
</Tabs>
117
+
94
118
## SWAP Blockchain Endpoint
95
119
96
120
Your Bee node must have access to the Ethereum blockchain, so that it
@@ -248,9 +272,25 @@ The Bzzaar is brand new. If you have any issues, please [get in touch](/docs/#co
248
272
249
273
If these messages are missing, check out our comprehensive guide to Bee [connectivity](/docs/installation/connectivity).
250
274
251
-
## Updating Bee
275
+
### Upgrading Bee
276
+
277
+
#### Ubuntu / Debian / Raspbian
278
+
279
+
To upgrade Bee, simply stop the Bee service.
280
+
281
+
```sh
282
+
sudo systemctl stop bee
283
+
```
284
+
285
+
Now follow the steps above to download the new package and install the new version, as usual.
286
+
287
+
You may now start your node again.
288
+
289
+
```sh
290
+
sudo systemctl start bee
291
+
```
252
292
253
-
Your Bee and Bee-clef installations can be updated by repeating the install steps above. Bee sure to [backup](/docs/maintenance/backups) your clef key material and Bee data before applying updates.
293
+
Bee sure to [backup](/docs/maintenance/backups) your clef key material and Bee data before applying updates.
0 commit comments