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

docs: update readme

Browse source
This commit is contained in:
fearlseefe 2024-10-16 18:12:07 +08:00 committed by Chen Kai
parent 60951973dc
commit e5b5bede46
1 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -32,13 +32,29 @@ make shisui-image
After building `shisui`, you can start the client by running After building `shisui`, you can start the client by running
```shell ```shell
# supported options are list below
./build/bin/shisui ./build/bin/shisui
``` ```
Alternatively, you can run the docker image by running Alternatively, you can run the docker image by running
```shell ```shell
docker run -d -p 8545:8545 -p 9009:9009/udp ghcr.io/optimism-java/shisui:latest docker run -d -p 8545:8545 -p 9009:9009/udp -e SHISUI_NAT=stun ghcr.io/optimism-java/shisui:latest
# if you know your exiIp, replace by -e SHISUI_NAT=extip:${your ip}
```
You can use the script below to check if the node has started correctly.
```shell
curl -X POST http://127.0.0.1:8545 \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"method": "discv5_nodeInfo",
"params": [],
"id": 0
}'
``` ```
### supported options ### supported options
@ -54,6 +70,7 @@ docker run -d -p 8545:8545 -p 9009:9009/udp ghcr.io/optimism-java/shisui:latest
* `upnp` uses the Universal Plug and Play protocol * `upnp` uses the Universal Plug and Play protocol
* `pmp` uses NAT-PMP with an auto-detected gateway address * `pmp` uses NAT-PMP with an auto-detected gateway address
* `pmp:192.168.0.1` uses NAT-PMP with the given gateway address * `pmp:192.168.0.1` uses NAT-PMP with the given gateway address
* `stun` uses stun server to find extip
* `--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