forks/go-ethereum
1
0
Fork 1
mirror of https://github.com/ethereum/go-ethereum.git synced 2026-07-28 07:36:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
go-ethereum/docs/README.md
Pratik Patil 4d06349d95
added a toml configuration file with comments describing each flag (#607) 
* added a toml configuration file with comments describing each flag

* internal/cli/server: update flag description

* docs/cli: update example config and description of flags

* docs: update new-cli docs

Co-authored-by: Manav Darji <manavdarji.india@gmail.com>
2022-12-01 09:20:17 +05:30

968 B
Raw Blame History

Documentation

Additional notes

  • The new entrypoint to run the Bor client is server.

    $ bor server <flags>

  • The bor dumpconfig sub-command prints the default configurations, in the TOML format, on the terminal. One can pipe (>) this to a file (say config.toml) and use it to start bor.

  • A toml file now can be used instead of flags and can contain all configuration for the node to run. To simply run bor with a configuration file, the following command can be used.

    $ bor server --config <path_to_config.toml>

  • You can find an example config file here to know more about what each flag is used for, what are the defaults and recommended values for different networks.

  • Toml files used earlier (with --config flag) to configure additional fields (like static and trusted nodes) are being deprecated and have been converted to flags.