docs: update bee configs (#4911)

ethersphere · Dec 9, 2024 · fc11edd · fc11edd
1 parent 1d3b3d6
commit fc11edd
Show file tree

Hide file tree

Showing 6 changed files with 227 additions and 11 deletions.
diff --git a/packaging/bee.yaml b/packaging/bee.yaml
@@ -66,8 +66,6 @@ password-file: "/var/lib/bee/password"
 # tracing-endpoint: "127.0.0.1:6831"
 ## service name identifier for tracing (default "bee")
 # tracing-service-name: "bee"
-## proof-of-identity transaction hash
-# transaction: ""
 ## log verbosity level 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=trace (default "info")
 # verbosity: "info"
 ## send a welcome message string during handshakes
@@ -78,3 +76,47 @@ password-file: "/var/lib/bee/password"
 # minimum-storage-radius: 0
 ## reserve capacity doubling (default 0, maximum 1)
 reserve-capacity-doubling: 0
+## allow to advertise private CIDRs to the public network
+# allow-private-cidrs: false
+## enable forwarded content caching
+# cache-retrieval: true
+## enable chequebook
+# chequebook-enable: true
+## help for printconfig
+# help: false
+## suggester for target neighborhood
+# neighborhood-suggester: https://api.swarmscan.io/v1/network/neighborhoods/suggestion
+## postage stamp contract start block number
+# postage-stamp-start-block: "0"
+## enable pprof mutex profile
+# pprof-mutex: false
+## enable pprof block profile
+# pprof-profile: false
+## price oracle contract address
+# price-oracle-address: ""
+## redistribution contract address
+# redistribution-address: ""
+## forces the node to resync postage contract data
+# resync: false
+## staking contract address
+# staking-address: ""
+## lru memory caching capacity in number of statestore entries
+# statestore-cache-capacity: "100000"
+## protect nodes from getting kicked out on bootnode
+# static-nodes: []
+## enable storage incentives feature
+# storage-incentives-enable: true
+## neighborhood to target in binary format (ex: 111111001) for mining the initial overlay
+# target-neighborhood: ""
+## host to send tracing data
+# tracing-host: ""
+## port to send tracing data
+# tracing-port: ""
+## skips the gas estimate step for contract transactions
+# transaction-debug-mode: false
+## bootstrap node using postage snapshot from the network
+# use-postage-snapshot: false
+## time to warmup the node before some major protocols can be kicked off
+# warmup-time: 30s
+## withdrawal target addresses
+# withdrawal-addresses-whitelist: []
diff --git a/packaging/docker/env b/packaging/docker/env
@@ -71,11 +71,59 @@
 # BEE_TRACING_ENDPOINT=127.0.0.1:6831
 ## service name identifier for tracing (default bee)
 # BEE_TRACING_SERVICE_NAME=bee
-## proof-of-identity transaction hash
-# BEE_TRANSACTION=
 ## log verbosity level 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=trace (default info)
 # BEE_VERBOSITY=info
 ## send a welcome message string during handshakes
 # BEE_WELCOME_MESSAGE=
 ## triggers connection to main network
 # BEE_MAINNET=
+## minimum radius storage threshold
+# BEE_MINIMUM_STORAGE_RADIUS=
+## reserve capacity doubling (default 0, maximum 1)
+# BEE_RESERVE-CAPACITY-DOUBLING=0
+## allow to advertise private CIDRs to the public network
+# BEE_ALLOW_PRIVATE_CIDRS=false
+## enable forwarded content caching
+# BEE_CACHE_RETRIEVAL=false
+## enable chequebook
+# BEE_CHEQUEBOOK_ENABLE=true
+## help for printconfig
+# BEE_HELP=false
+## suggester for target neighborhood
+# BEE_NEIGHBORHOOD_SUGGESTER=https://api.swarmscan.io/v1/network/neighborhoods/suggestion
+## postage stamp contract start block number
+# BEE_POSTAGE_STAMP_START_BLOCK="0"
+## enable pprof mutex profile
+# BEE_PPROF_MUTEX=false
+## enable pprof block profile
+# BEE_PPROF_PROFILE=false
+## price oracle contract address
+# BEE_PRICE_ORACLE_ADDRESS=
+## redistribution contract address
+# BEE_REDISTRIBUTION_ADDRESS=
+## forces the node to resync postage contract data
+# BEE_RESYNC=false
+## staking contract address
+# BEE_STAKING_ADDRESS=
+## lru memory caching capacity in number of statestore entries
+# BEE_STATESTORE_CACHE_CAPACITY="100000"
+## protect nodes from getting kicked out on bootnode
+# BEE_STATIC_NODES=
+## enable storage incentives feature
+# BEE_STORAGE_INCENTIVES_ENABLE=true
+## neighborhood to target in binary format (ex: 111111001) for mining the initial overlay
+# BEE_TARGET_NEIGHBORHOOD=
+## host to send tracing data
+# BEE_TRACING_HOST=
+## port to send tracing data
+# BEE_TRACING_PORT=
+## service name identifier for tracing
+# BEE_TRACING_SERVICE_NAME=
+## skips the gas estimate step for contract transactions
+# BEE_TRANSACTION_DEBUG_MODE=false
+## bootstrap node using postage snapshot from the network
+# BEE_USE_POSTAGE_SNAPSHOT=false
+## time to warmup the node before some major protocols can be kicked off
+# BEE_WARMUP_TIME=
+## withdrawal target addresses
+# BEE_WITHDRAWAL_ADDRESSES_WHITELIST=
diff --git a/packaging/homebrew-amd64/bee.yaml b/packaging/homebrew-amd64/bee.yaml
@@ -66,8 +66,6 @@ password-file: "/usr/local/var/lib/swarm-bee/password"
 # tracing-endpoint: "127.0.0.1:6831"
 ## service name identifier for tracing (default "bee")
 # tracing-service-name: "bee"
-## proof-of-identity transaction hash
-# transaction: ""
 ## log verbosity level 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=trace (default "info")
 # verbosity: "info"
 ## send a welcome message string during handshakes
@@ -78,3 +76,47 @@ password-file: "/usr/local/var/lib/swarm-bee/password"
 # minimum-storage-radius: 0
 ## reserve capacity doubling (default 0, maximum 1)
 reserve-capacity-doubling: 0
+## allow to advertise private CIDRs to the public network
+# allow-private-cidrs: false
+## enable forwarded content caching
+# cache-retrieval: true
+## enable chequebook
+# chequebook-enable: true
+## help for printconfig
+# help: false
+## suggester for target neighborhood
+# neighborhood-suggester: https://api.swarmscan.io/v1/network/neighborhoods/suggestion
+## postage stamp contract start block number
+# postage-stamp-start-block: "0"
+## enable pprof mutex profile
+# pprof-mutex: false
+## enable pprof block profile
+# pprof-profile: false
+## price oracle contract address
+# price-oracle-address: ""
+## redistribution contract address
+# redistribution-address: ""
+## forces the node to resync postage contract data
+# resync: false
+## staking contract address
+# staking-address: ""
+## lru memory caching capacity in number of statestore entries
+# statestore-cache-capacity: "100000"
+## protect nodes from getting kicked out on bootnode
+# static-nodes: []
+## enable storage incentives feature
+# storage-incentives-enable: true
+## neighborhood to target in binary format (ex: 111111001) for mining the initial overlay
+# target-neighborhood: ""
+## host to send tracing data
+# tracing-host: ""
+## port to send tracing data
+# tracing-port: ""
+## skips the gas estimate step for contract transactions
+# transaction-debug-mode: false
+## bootstrap node using postage snapshot from the network
+# use-postage-snapshot: false
+## time to warmup the node before some major protocols can be kicked off
+# warmup-time: 30s
+## withdrawal target addresses
+# withdrawal-addresses-whitelist: []
diff --git a/packaging/homebrew-arm64/bee.yaml b/packaging/homebrew-arm64/bee.yaml
@@ -66,8 +66,6 @@ password-file: "/opt/homebrew/var/lib/swarm-bee/password"
 # tracing-endpoint: "127.0.0.1:6831"
 ## service name identifier for tracing (default "bee")
 # tracing-service-name: "bee"
-## proof-of-identity transaction hash
-# transaction: ""
 ## log verbosity level 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=trace (default "info")
 # verbosity: "info"
 ## send a welcome message string during handshakes
@@ -78,3 +76,47 @@ password-file: "/opt/homebrew/var/lib/swarm-bee/password"
 # minimum-storage-radius: 0
 ## reserve capacity doubling (default 0, maximum 1)
 reserve-capacity-doubling: 0
+## allow to advertise private CIDRs to the public network
+# allow-private-cidrs: false
+## enable forwarded content caching
+# cache-retrieval: true
+## enable chequebook
+# chequebook-enable: true
+## help for printconfig
+# help: false
+## suggester for target neighborhood
+# neighborhood-suggester: https://api.swarmscan.io/v1/network/neighborhoods/suggestion
+## postage stamp contract start block number
+# postage-stamp-start-block: "0"
+## enable pprof mutex profile
+# pprof-mutex: false
+## enable pprof block profile
+# pprof-profile: false
+## price oracle contract address
+# price-oracle-address: ""
+## redistribution contract address
+# redistribution-address: ""
+## forces the node to resync postage contract data
+# resync: false
+## staking contract address
+# staking-address: ""
+## lru memory caching capacity in number of statestore entries
+# statestore-cache-capacity: "100000"
+## protect nodes from getting kicked out on bootnode
+# static-nodes: []
+## enable storage incentives feature
+# storage-incentives-enable: true
+## neighborhood to target in binary format (ex: 111111001) for mining the initial overlay
+# target-neighborhood: ""
+## host to send tracing data
+# tracing-host: ""
+## port to send tracing data
+# tracing-port: ""
+## skips the gas estimate step for contract transactions
+# transaction-debug-mode: false
+## bootstrap node using postage snapshot from the network
+# use-postage-snapshot: false
+## time to warmup the node before some major protocols can be kicked off
+# warmup-time: 30s
+## withdrawal target addresses
+# withdrawal-addresses-whitelist: []
diff --git a/packaging/scoop/bee.yaml b/packaging/scoop/bee.yaml
@@ -56,8 +56,6 @@ password-file: "./password"
 # tracing-endpoint: "127.0.0.1:6831"
 ## service name identifier for tracing (default "bee")
 # tracing-service-name: "bee"
-## proof-of-identity transaction hash
-# transaction: ""
 ## log verbosity level 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=trace (default "info")
 # verbosity: "info"
 ## send a welcome message string during handshakes
@@ -68,3 +66,47 @@ password-file: "./password"
 # minimum-storage-radius: 0
 ## reserve capacity doubling (default 0, maximum 1)
 reserve-capacity-doubling: 0
+## allow to advertise private CIDRs to the public network
+# allow-private-cidrs: false
+## enable forwarded content caching
+# cache-retrieval: true
+## enable chequebook
+# chequebook-enable: true
+## help for printconfig
+# help: false
+## suggester for target neighborhood
+# neighborhood-suggester: https://api.swarmscan.io/v1/network/neighborhoods/suggestion
+## postage stamp contract start block number
+# postage-stamp-start-block: "0"
+## enable pprof mutex profile
+# pprof-mutex: false
+## enable pprof block profile
+# pprof-profile: false
+## price oracle contract address
+# price-oracle-address: ""
+## redistribution contract address
+# redistribution-address: ""
+## forces the node to resync postage contract data
+# resync: false
+## staking contract address
+# staking-address: ""
+## lru memory caching capacity in number of statestore entries
+# statestore-cache-capacity: "100000"
+## protect nodes from getting kicked out on bootnode
+# static-nodes: []
+## enable storage incentives feature
+# storage-incentives-enable: true
+## neighborhood to target in binary format (ex: 111111001) for mining the initial overlay
+# target-neighborhood: ""
+## host to send tracing data
+# tracing-host: ""
+## port to send tracing data
+# tracing-port: ""
+## skips the gas estimate step for contract transactions
+# transaction-debug-mode: false
+## bootstrap node using postage snapshot from the network
+# use-postage-snapshot: false
+## time to warmup the node before some major protocols can be kicked off
+# warmup-time: 30s
+## withdrawal target addresses
+# withdrawal-addresses-whitelist: []
diff --git a/pkg/api/bytes.go b/pkg/api/bytes.go
@@ -111,7 +111,7 @@ func (s *Service) bytesUploadHandler(w http.ResponseWriter, r *http.Request) {
 		logger.Error(nil, "split write all failed")
 		switch {
 		case errors.Is(err, postage.ErrBucketFull):
-			jsonhttp.PaymentRequired(ow, "batch is overissued")
+			jsonhttp.PaymentRequired(ow, "batch is over issued")
 		default:
 			jsonhttp.InternalServerError(ow, "split write all failed")
 		}