Skip to content

Commit 1bf0f0c

Browse files
committed
fix(packaging): pass BEE_NODE_MODE through docker compose and refresh defaults
Add BEE_NODE_MODE to the docker-compose environment passthrough and the env template, mark BEE_FULL_NODE deprecated, and correct the stale true defaults documented for BEE_CHEQUEBOOK_ENABLE and BEE_STORAGE_INCENTIVES_ENABLE. Document in the bee.yaml variants that full mode implies the swap, chequebook and incentives options and that an unset node-mode falls back to deprecated inference.
1 parent 5ef43da commit 1bf0f0c

7 files changed

Lines changed: 37 additions & 22 deletions

File tree

packaging/bee.yaml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22

33
## ── Node mode ────────────────────────────────────────────────────────────────
44
## Selects the operational mode of this node.
5-
## full - participates in storage and incentives; requires swap-enable and blockchain-rpc
5+
## full - participates in storage and incentives; requires blockchain-rpc;
6+
## implies swap-enable, chequebook-enable and storage-incentives-enable
67
## light - uploads and downloads only; requires blockchain-rpc
7-
## ultra-light - free-tier downloads only; no blockchain connection needed (default)
8+
## ultra-light - free-tier downloads only; no blockchain connection needed
9+
## When unset, the mode is inferred from the deprecated full-node option and
10+
## blockchain-rpc presence (deprecated, removed in v2.11.0).
811
# node-mode: ultra-light
912

1013
## ── Blockchain / RPC (required for full and light nodes) ─────────────────────
@@ -23,7 +26,7 @@
2326
## ── Swap / chequebook (full and light nodes only) ────────────────────────────
2427
## enable swap
2528
# swap-enable: false
26-
## enable chequebook
29+
## enable chequebook (requires swap-enable; implied by node-mode: full)
2730
# chequebook-enable: false
2831
## reject full-node hive/handshake records that carry no chequebook address
2932
# chequebook-verification: false
@@ -33,7 +36,7 @@
3336
# swap-initial-deposit: "0"
3437

3538
## ── Full node only ────────────────────────────────────────────────────────────
36-
## enable storage incentives feature
39+
## enable storage incentives feature (implied by node-mode: full)
3740
# storage-incentives-enable: false
3841
## reserve capacity doubling
3942
# reserve-capacity-doubling: 0

packaging/docker/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ wget -q https://raw.githubusercontent.com/ethersphere/bee/master/packaging/docke
1111

1212
Set all configuration variables inside `.env`
1313

14-
If you want to run node in full mode, set `BEE_FULL_NODE=true`
14+
Select the node mode with `BEE_NODE_MODE` (`full`, `light`, or `ultra-light`). A full node needs `BEE_BLOCKCHAIN_RPC_ENDPOINT` and implies swap, chequebook and storage incentives.
1515

1616
Bee requires an Ethereum endpoint to function. Obtain a free Infura account and set:
1717

packaging/docker/docker-compose.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ services:
3939
- BEE_NAT_WSS_ADDR
4040
- BEE_NEIGHBORHOOD_SUGGESTER
4141
- BEE_NETWORK_ID
42+
- BEE_NODE_MODE
4243
- BEE_P2P_ADDR
4344
- BEE_P2P_WS_ENABLE
4445
- BEE_P2P_WSS_ADDR

packaging/docker/env

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@
3737
# BEE_CACHE_CAPACITY=1000000
3838
## enable forwarded content caching (default true)
3939
# BEE_CACHE_RETRIEVAL=true
40-
## enable chequebook (default true)
41-
# BEE_CHEQUEBOOK_ENABLE=true
40+
## enable chequebook; requires swap; implied by BEE_NODE_MODE=full (default false)
41+
# BEE_CHEQUEBOOK_ENABLE=false
4242
## reject full-node hive/handshake records that carry no chequebook address
4343
# BEE_CHEQUEBOOK_VERIFICATION=false
4444
## origins with CORS headers enabled (default [])
@@ -53,7 +53,7 @@
5353
# BEE_DB_OPEN_FILES_LIMIT=200
5454
## size of the database write buffer in bytes (default 33554432)
5555
# BEE_DB_WRITE_BUFFER_SIZE=33554432
56-
## cause the node to start in full mode (default false)
56+
## cause the node to start in full mode (deprecated: use BEE_NODE_MODE=full) (default false)
5757
# BEE_FULL_NODE=false
5858
## gas limit fallback when estimation fails for contract transactions (default 500000)
5959
# BEE_GAS_LIMIT_FALLBACK=500000
@@ -71,6 +71,8 @@
7171
# BEE_NEIGHBORHOOD_SUGGESTER=https://api.swarmscan.io/v1/network/neighborhoods/suggestion
7272
## ID of the Swarm network (default mainnet id from bee)
7373
# BEE_NETWORK_ID=1
74+
## node operational mode: full, light, or ultra-light; unset infers the mode from BEE_FULL_NODE and BEE_BLOCKCHAIN_RPC_ENDPOINT (deprecated)
75+
# BEE_NODE_MODE=ultra-light
7476
## P2P listen address (default :1634)
7577
# BEE_P2P_ADDR=:1634
7678
## enable P2P WebSocket transport (default false)
@@ -115,8 +117,8 @@
115117
# BEE_STATIC_NODES=[]
116118
## lru memory caching capacity in number of statestore entries (default 100000)
117119
# BEE_STATESTORE_CACHE_CAPACITY=100000
118-
## enable storage incentives feature (default true)
119-
# BEE_STORAGE_INCENTIVES_ENABLE=true
120+
## enable storage incentives feature; full node only; implied by BEE_NODE_MODE=full (default false)
121+
# BEE_STORAGE_INCENTIVES_ENABLE=false
120122
## enable swap (default false)
121123
# BEE_SWAP_ENABLE=false
122124
## swap factory addresses (default empty)

packaging/homebrew-amd64/bee.yaml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22

33
## ── Node mode ────────────────────────────────────────────────────────────────
44
## Selects the operational mode of this node.
5-
## full - participates in storage and incentives; requires swap-enable and blockchain-rpc
5+
## full - participates in storage and incentives; requires blockchain-rpc;
6+
## implies swap-enable, chequebook-enable and storage-incentives-enable
67
## light - uploads and downloads only; requires blockchain-rpc
7-
## ultra-light - free-tier downloads only; no blockchain connection needed (default)
8+
## ultra-light - free-tier downloads only; no blockchain connection needed
9+
## When unset, the mode is inferred from the deprecated full-node option and
10+
## blockchain-rpc presence (deprecated, removed in v2.11.0).
811
# node-mode: ultra-light
912

1013
## ── Blockchain / RPC (required for full and light nodes) ─────────────────────
@@ -23,7 +26,7 @@
2326
## ── Swap / chequebook (full and light nodes only) ────────────────────────────
2427
## enable swap
2528
# swap-enable: false
26-
## enable chequebook
29+
## enable chequebook (requires swap-enable; implied by node-mode: full)
2730
# chequebook-enable: false
2831
## reject full-node hive/handshake records that carry no chequebook address
2932
# chequebook-verification: false
@@ -33,7 +36,7 @@
3336
# swap-initial-deposit: "0"
3437

3538
## ── Full node only ────────────────────────────────────────────────────────────
36-
## enable storage incentives feature
39+
## enable storage incentives feature (implied by node-mode: full)
3740
# storage-incentives-enable: false
3841
## reserve capacity doubling
3942
# reserve-capacity-doubling: 0

packaging/homebrew-arm64/bee.yaml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22

33
## ── Node mode ────────────────────────────────────────────────────────────────
44
## Selects the operational mode of this node.
5-
## full - participates in storage and incentives; requires swap-enable and blockchain-rpc
5+
## full - participates in storage and incentives; requires blockchain-rpc;
6+
## implies swap-enable, chequebook-enable and storage-incentives-enable
67
## light - uploads and downloads only; requires blockchain-rpc
7-
## ultra-light - free-tier downloads only; no blockchain connection needed (default)
8+
## ultra-light - free-tier downloads only; no blockchain connection needed
9+
## When unset, the mode is inferred from the deprecated full-node option and
10+
## blockchain-rpc presence (deprecated, removed in v2.11.0).
811
# node-mode: ultra-light
912

1013
## ── Blockchain / RPC (required for full and light nodes) ─────────────────────
@@ -23,7 +26,7 @@
2326
## ── Swap / chequebook (full and light nodes only) ────────────────────────────
2427
## enable swap
2528
# swap-enable: false
26-
## enable chequebook
29+
## enable chequebook (requires swap-enable; implied by node-mode: full)
2730
# chequebook-enable: false
2831
## reject full-node hive/handshake records that carry no chequebook address
2932
# chequebook-verification: false
@@ -33,7 +36,7 @@
3336
# swap-initial-deposit: "0"
3437

3538
## ── Full node only ────────────────────────────────────────────────────────────
36-
## enable storage incentives feature
39+
## enable storage incentives feature (implied by node-mode: full)
3740
# storage-incentives-enable: false
3841
## reserve capacity doubling
3942
# reserve-capacity-doubling: 0

packaging/scoop/bee.yaml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22

33
## ── Node mode ────────────────────────────────────────────────────────────────
44
## Selects the operational mode of this node.
5-
## full - participates in storage and incentives; requires swap-enable and blockchain-rpc
5+
## full - participates in storage and incentives; requires blockchain-rpc;
6+
## implies swap-enable, chequebook-enable and storage-incentives-enable
67
## light - uploads and downloads only; requires blockchain-rpc
7-
## ultra-light - free-tier downloads only; no blockchain connection needed (default)
8+
## ultra-light - free-tier downloads only; no blockchain connection needed
9+
## When unset, the mode is inferred from the deprecated full-node option and
10+
## blockchain-rpc presence (deprecated, removed in v2.11.0).
811
# node-mode: ultra-light
912

1013
## ── Blockchain / RPC (required for full and light nodes) ─────────────────────
@@ -23,7 +26,7 @@
2326
## ── Swap / chequebook (full and light nodes only) ────────────────────────────
2427
## enable swap
2528
# swap-enable: false
26-
## enable chequebook
29+
## enable chequebook (requires swap-enable; implied by node-mode: full)
2730
# chequebook-enable: false
2831
## reject full-node hive/handshake records that carry no chequebook address
2932
# chequebook-verification: false
@@ -33,7 +36,7 @@
3336
# swap-initial-deposit: "0"
3437

3538
## ── Full node only ────────────────────────────────────────────────────────────
36-
## enable storage incentives feature
39+
## enable storage incentives feature (implied by node-mode: full)
3740
# storage-incentives-enable: false
3841
## reserve capacity doubling
3942
# reserve-capacity-doubling: 0

0 commit comments

Comments
 (0)