forks/go-ethereum
1
0
Fork 1
mirror of https://github.com/ethereum/go-ethereum.git synced 2026-07-27 23:26:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

feat: change document

Browse source
This commit is contained in:
fearlessfe 2024-06-11 23:40:41 +08:00 committed by Chen Kai
parent 703e97781a
commit 42e6f336a4
2 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -45,13 +45,25 @@ docker run -d -p 8545:8545 -p 9009:9009/udp ghcr.io/optimism-java/shisui:latest
* `--rpc.port` HTTP-RPC server listening port(default: `8545`) * `--rpc.port` HTTP-RPC server listening port(default: `8545`)
* `--data.dir` data dir of where the data file located(default: `./`) * `--data.dir` data dir of where the data file located(default: `./`)
* `--data.capacity` the capacity of the data stored, the unit is MB(default: `10GB`) * `--data.capacity` the capacity of the data stored, the unit is MB(default: `10GB`)
* `--udp.addr` protocol UDP server listening interface(default: local ip) * `--nat` p2p address(default `none`)
* `none`, find local address
* `any` uses the first auto-detected mechanism
* `extip:77.12.33.4` will assume the local machine is reachable on the given IP
* `upnp` uses the Universal Plug and Play protocol
* `pmp` uses NAT-PMP with an auto-detected gateway address
* `pmp:192.168.0.1` uses NAT-PMP with the given gateway address
* `--udp.addr` protocol UDP server listening port(default: `9009`) * `--udp.addr` protocol UDP server listening port(default: `9009`)
* `--loglevel` loglevel of portal network, `1` to `5`, from `error` to `trace`(default: `1`) * `--loglevel` loglevel of portal network, `1` to `5`, from `error` to `trace`(default: `1`)
* `--private.key` private key of p2p node, hex format without `0x` prifix * `--private.key` private key of p2p node, hex format without `0x` prifix
* `--bootnodes` bootnode of p2p network with ENR format * `--bootnodes` bootnode of p2p network with ENR format
* `--networks` portal sub networks: history, beacon, state * `--networks` portal sub networks: history, beacon, state
all the options above can be set with envs.
the env is prefixed with `SHISUI` and change the `.` to `_`.
eg `--rpc.add` can be replaced with env `SHISUI_RPC_ADDR`
### Hardware Requirements ### Hardware Requirements
Minimum: Minimum:

2
cmd/utils/flags.go
View file

@ -1027,7 +1027,7 @@ Please note that --` + MetricsHTTPFlag.Name + ` must be set to start the server.
Name: "networks", Name: "networks",
Usage: "portal sub networks: history, beacon, state", Usage: "portal sub networks: history, beacon, state",
Category: flags.PortalNetworkCategory, Category: flags.PortalNetworkCategory,
Value: cli.NewStringSlice(portalwire.HistoryNetworkName, portalwire.BeaconNetworkName, portalwire.StateNetworkName), Value: cli.NewStringSlice(portalwire.HistoryNetworkName),
} }
) )