Skip to content

Commit

Permalink
docs: add rpc_bind_ip config to docs (#332)
Browse files Browse the repository at this point in the history
* chore: add rpc_bind_ip config to docs

* chore: revert formatting

* fix: revert pointers
  • Loading branch information
ShaunLWM authored May 15, 2024
1 parent 1572a24 commit c787b86
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ Helios is still experimental software. While we hope you try it out, we do not s

`--rpc-port` or `-p` sets the port that the local RPC should run on. The default value is `8545`.

`--rpc-bind-ip` or `-b` sets the ip that binds to the JSON-RPC server. Be default, Helios will use `127.0.0.1`. Use `0.0.0.0` to allow remote access.

`--data-dir` or `-d` sets the directory that Helios should use to store cached weak subjectivity checkpoints in. Each network only stores the latest checkpoint, which is just 32 bytes.

`--fallback` or `-f` sets the checkpoint fallback url (a string). This is only used if the checkpoint provided by the `--checkpoint` flag is too outdated for Helios to use to sync.
Expand Down
6 changes: 6 additions & 0 deletions config.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ consensus_rpc = "https://www.lightclientdata.org"
execution_rpc = "https://eth-mainnet.g.alchemy.com/v2/XXXXX"
# The port to run the JSON-RPC server on. By default, Helios will use port 8545.
rpc_port = 8545
# The ip that binds to the JSON-RPC server. Be default, Helios will use 127.0.0.1. Use 0.0.0.0 to allow access from remote.
rpc_bind_ip = "127.0.0.1"
# The latest checkpoint. This should be a trusted checkpoint that is no greater than ~2 weeks old.
# If you are unsure what checkpoint to use, you can skip this option and set either `load_external_fallback` or `fallback` values (described below) to fetch a checkpoint. Though this is not recommended and less secure.
checkpoint = "0x85e6151a246e8fdba36db27a0c7678a575346272fe978c9281e13a8b26cdfa68"
Expand All @@ -34,6 +36,8 @@ consensus_rpc = "http://testing.prater.beacon-api.nimbus.team"
execution_rpc = "https://eth-goerli.g.alchemy.com/v2/XXXXX"
# The port to run the JSON-RPC server on. By default, Helios will use port 8545.
rpc_port = 8545
# The ip that binds to the JSON-RPC server. Be default, Helios will use 127.0.0.1. Use 0.0.0.0 to allow access from remote.
rpc_bind_ip = "127.0.0.1"
# The latest checkpoint. This should be a trusted checkpoint that is no greater than ~2 weeks old.
# If you are unsure what checkpoint to use, you can skip this option and set either `load_external_fallback` or `fallback` values (described below) to fetch a checkpoint. Though this is not recommended and less secure.
checkpoint = "0xb5c375696913865d7c0e166d87bc7c772b6210dc9edf149f4c7ddc6da0dd4495"
Expand Down Expand Up @@ -62,6 +66,8 @@ All configuration options below are available on a per-network level, where netw

- `rpc_port` - The port to run the JSON-RPC server on. By default, Helios will use port 8545.

- `rpc_bind_ip` - The ip that binds to the JSON-RPC server. Be default, Helios will use 127.0.0.1. Use 0.0.0.0 to allow access from remote.

- `checkpoint` - The latest checkpoint. This should be a trusted checkpoint that is no greater than ~2 weeks old. If you are unsure what checkpoint to use, you can skip this option and set either `load_external_fallback` or `fallback` values (described below) to fetch a checkpoint. Though this is not recommended and less secure.

- `data_dir` - The directory to store the checkpoint database in. If not provided, Helios will use "~/.helios/data/<NETWORK>", where `<NETWORK>` is the network. It is recommended to set this directory to a persistent location mapped to a fast storage device.
Expand Down

0 comments on commit c787b86

Please sign in to comment.