Skip to content

Commit a84caad

Browse files
committed
updated config default terminal output examples
1 parent 279a161 commit a84caad

File tree

1 file changed

+49
-22
lines changed

1 file changed

+49
-22
lines changed

docs/bee/working-with-bee/configuration.md

Lines changed: 49 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,29 @@ However when Bee is started as a service with tools like `systemctl` or `brew se
2727
Run `bee start --help` in your terminal to list the available command-line arguments:
2828

2929
```bash
30+
Ethereum Swarm Bee
31+
32+
Usage:
33+
bee [command]
34+
35+
Available Commands:
36+
start Start a Swarm node
37+
dev Start a Swarm node in development mode
38+
init Initialise a Swarm node
39+
deploy Deploy and fund the chequebook contract
40+
version Print version number
41+
db Perform basic DB related operations
42+
split Split a file into chunks
43+
printconfig Print default or provided configuration in yaml format
44+
help Help about any command
45+
completion Generate the autocompletion script for the specified shell
46+
47+
Flags:
48+
--config string config file (default is $HOME/.bee.yaml)
49+
-h, --help help for bee
50+
51+
Use "bee [command] --help" for more information about a command.
52+
root@noah-bee:~# docker exec bee-1 bee start --help
3053
Start a Swarm node
3154

3255
Usage:
@@ -35,15 +58,15 @@ Usage:
3558
Flags:
3659
--allow-private-cidrs allow to advertise private CIDRs to the public network
3760
--api-addr string HTTP API listen address (default "127.0.0.1:1633")
38-
--block-time uint chain block time (default 15)
61+
--block-time uint chain block time (default 5)
3962
--blockchain-rpc-endpoint string rpc blockchain endpoint
40-
--bootnode strings initial nodes to connect to
63+
--bootnode strings initial nodes to connect to (default [/dnsaddr/mainnet.ethswarm.org])
4164
--bootnode-mode cause the node to always accept incoming connections
4265
--cache-capacity uint cache capacity in chunks, multiply by 4096 to get approximate capacity in bytes (default 1000000)
4366
--cache-retrieval enable forwarded content caching (default true)
4467
--chequebook-enable enable chequebook (default true)
4568
--cors-allowed-origins strings origins with CORS headers enabled
46-
--data-dir string data directory (default "/home/noah/.bee")
69+
--data-dir string data directory (default "/home/bee/.bee")
4770
--db-block-cache-capacity uint size of block cache of the database in bytes (default 33554432)
4871
--db-disable-seeks-compaction disables db compactions triggered by seeks (default true)
4972
--db-open-files-limit uint number of open files allowed by database (default 200)
@@ -71,13 +94,12 @@ Flags:
7194
--reserve-capacity-doubling int reserve capacity doubling
7295
--resolver-options strings ENS compatible API endpoint for a TLD and with contract address, can be repeated, format [tld:][contract-addr@]url
7396
--resync forces the node to resync postage contract data
97+
--skip-postage-snapshot skip postage snapshot
7498
--staking-address string staking contract address
7599
--statestore-cache-capacity uint lru memory caching capacity in number of statestore entries (default 100000)
76100
--static-nodes strings protect nodes from getting kicked out on bootnode
77101
--storage-incentives-enable enable storage incentives feature (default true)
78-
--swap-deployment-gas-price string gas price in wei to use for deployment and funding
79102
--swap-enable enable swap
80-
--swap-endpoint string swap blockchain endpoint
81103
--swap-factory-address string swap factory addresses
82104
--swap-initial-deposit string initial deposit if deploying a new chequebook (default "0")
83105
--target-neighborhood string neighborhood to target in binary format (ex: 111111001) for mining the initial overlay
@@ -89,7 +111,7 @@ Flags:
89111
--transaction-debug-mode skips the gas estimate step for contract transactions
90112
--use-postage-snapshot bootstrap node using postage snapshot from the network
91113
--verbosity string log verbosity level 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=trace (default "info")
92-
--warmup-time duration time to warmup the node before some major protocols can be kicked off (default 5m0s)
114+
--warmup-time duration maximum node warmup duration; proceeds when stable or after this time (default 5m0s)
93115
--welcome-message string send a welcome message string during handshakes
94116
--withdrawal-addresses-whitelist strings withdrawal target addresses
95117

@@ -126,13 +148,14 @@ bee printconfig
126148
# allow to advertise private CIDRs to the public network
127149
allow-private-cidrs: false
128150
# HTTP API listen address
129-
api-addr: 127.0.0.1:1633
151+
api-addr: :1633
130152
# chain block time
131-
block-time: "15"
153+
block-time: "5"
132154
# rpc blockchain endpoint
133-
blockchain-rpc-endpoint: ""
155+
blockchain-rpc-endpoint: https://xdai.fairdatasociety.org
134156
# initial nodes to connect to
135-
bootnode: []
157+
bootnode:
158+
- /dnsaddr/mainnet.ethswarm.org
136159
# cause the node to always accept incoming connections
137160
bootnode-mode: false
138161
# cache capacity in chunks, multiply by 4096 to get approximate capacity in bytes
@@ -142,11 +165,11 @@ cache-retrieval: true
142165
# enable chequebook
143166
chequebook-enable: true
144167
# config file (default is $HOME/.bee.yaml)
145-
config: /root/.bee.yaml
168+
config: /home/bee/.bee.yaml
146169
# origins with CORS headers enabled
147170
cors-allowed-origins: []
148171
# data directory
149-
data-dir: /root/.bee
172+
data-dir: /home/bee/.bee
150173
# size of block cache of the database in bytes
151174
db-block-cache-capacity: "33554432"
152175
# disables db compactions triggered by seeks
@@ -156,11 +179,13 @@ db-open-files-limit: "200"
156179
# size of the database write buffer in bytes
157180
db-write-buffer-size: "33554432"
158181
# cause the node to start in full mode
159-
full-node: false
182+
full-node: "true"
160183
# help for printconfig
161184
help: false
162185
# triggers connect to main net bootnodes.
163-
mainnet: true
186+
mainnet: "true"
187+
# minimum radius storage threshold
188+
minimum-storage-radius: "0"
164189
# NAT exposed address
165190
nat-addr: ""
166191
# suggester for target neighborhood
@@ -172,7 +197,7 @@ p2p-addr: :1634
172197
# enable P2P WebSocket transport
173198
p2p-ws-enable: false
174199
# password for decrypting keys
175-
password: ""
200+
password: 427067e9514e93613b861fef5561c6
176201
# path to a file that contains password for decrypting keys
177202
password-file: ""
178203
# percentage below the peers payment threshold when we initiate settlement
@@ -193,10 +218,14 @@ pprof-profile: false
193218
price-oracle-address: ""
194219
# redistribution contract address
195220
redistribution-address: ""
221+
# reserve capacity doubling
222+
reserve-capacity-doubling: "1"
196223
# ENS compatible API endpoint for a TLD and with contract address, can be repeated, format [tld:][contract-addr@]url
197224
resolver-options: []
198225
# forces the node to resync postage contract data
199226
resync: false
227+
# skip postage snapshot
228+
skip-postage-snapshot: false
200229
# staking contract address
201230
staking-address: ""
202231
# lru memory caching capacity in number of statestore entries
@@ -205,12 +234,8 @@ statestore-cache-capacity: "100000"
205234
static-nodes: []
206235
# enable storage incentives feature
207236
storage-incentives-enable: true
208-
# gas price in wei to use for deployment and funding
209-
swap-deployment-gas-price: ""
210237
# enable swap
211-
swap-enable: false
212-
# swap blockchain endpoint
213-
swap-endpoint: ""
238+
swap-enable: "true"
214239
# swap factory addresses
215240
swap-factory-address: ""
216241
# initial deposit if deploying a new chequebook
@@ -227,11 +252,13 @@ tracing-host: ""
227252
tracing-port: ""
228253
# service name identifier for tracing
229254
tracing-service-name: bee
255+
# skips the gas estimate step for contract transactions
256+
transaction-debug-mode: false
230257
# bootstrap node using postage snapshot from the network
231258
use-postage-snapshot: false
232259
# log verbosity level 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=trace
233-
verbosity: info
234-
# time to warmup the node before some major protocols can be kicked off
260+
verbosity: "4"
261+
# maximum node warmup duration; proceeds when stable or after this time
235262
warmup-time: 5m0s
236263
# send a welcome message string during handshakes
237264
welcome-message: ""

0 commit comments

Comments
 (0)