@ -55,6 +55,10 @@ List of node IDs with which this node will not peer. The node ID is the public k
!!!info
This option is only available from v0.8.2.
!!!tip
The singular `--banned-node-id` and plural `--banned-node-ids` are available and are just two
names for the same option.
### bootnodes
```bash tab="Syntax"
@ -82,10 +86,10 @@ Specify bootnodes when connecting to a [private network](../Configuring-Pantheon
Specifying a node is a [bootnode](../Configuring-Pantheon/Testing-Developing-Nodes.md#bootnodes)
must be done on the command line not in a [configuration file](../Configuring-Pantheon/Using-Configuration-File.md).
### config
### config-file
```bash tab="Syntax"
--config=<PATH>
--config-file=<FILE>
```
```bash tab="Example Command Line"
@ -98,18 +102,18 @@ The default is `none`.
!!!note
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#custom-configuration-file) or in a [configuration file](../Configuring-Pantheon/Using-Configuration-File.md).
### datadir
### data-path
```bash tab="Syntax"
--datadir=<PATH>
--data-path=<PATH>
```
```bash tab="Example Command Line"
--datadir=/home/me/me_node
--data-path=/home/me/me_node
```
```bash tab="Example Configuration File"
datadir="/home/me/me_node"
data-path="/home/me/me_node"
```
The path to the Pantheon data directory. The default is the `/build/distributions/pantheon-<version>` directory in the Pantheon installation directory.
@ -120,6 +124,10 @@ The path to the Pantheon data directory. The default is the `/build/distribution
### dev-mode
!!!important
This option is deprecated in favor of the new `--network` option.
It will be completely removed in the 0.9 release.
```bash tab="Syntax"
--dev-mode
```
@ -139,18 +147,18 @@ Default is `false`.
The [`--dev-mode`](#dev-mode) option overrides the [`--genesis`](#genesis) option. If both are specified, the development mode configuration is used.
The path to the genesis file. The default is the embedded genesis file for the Ethereum mainnet.
@ -166,6 +174,10 @@ When using this option, it is recommended to also set the [`--network-id`](#netw
### goerli
!!!important
This option is deprecated in favor of the new `--network` option.
It will be completely removed in the 0.9 release.
```bash tab="Syntax"
--goerli
```
@ -221,6 +233,10 @@ The default is 25.
### max-trailing-peers
!!!important
This option is deprecated in favor of a intelligent default setting and will be removed in 0.9
release.
```bash tab="Syntax"
--max-trailing-peers=<INTEGER>
```
@ -249,22 +265,39 @@ metrics-enabled=true
Set to `true` to enable the [Prometheus](https://prometheus.io/) monitoring service to access [Pantheon metrics](../Using-Pantheon/Debugging.md#monitor-node-performance-using-third-party-clients).
The default is `false`.
### metrics-listen
### metrics-host
```bash tab="Syntax"
--metrics-host=<HOST>
```
```bash tab="Example Command Line"
--metrics-host=127.0.0.1
```
```bash tab="Example Configuration File"
metrics-host="127.0.0.1"
```
Specifies the host on which the [Prometheus](https://prometheus.io/) monitoring service accesses Pantheon
metrics. The default is `127.0.0.1`. The metrics server respects the [`--host-whitelist` option](#host-whitelist).
### metrics-port
```bash tab="Syntax"
--metrics-listen=<HOST:PORT>
--metrics-port=<PORT>
```
```bash tab="Example Command Line"
--metrics-listen=127.0.0.1:6174
--metrics-port=6174
```
```bash tab="Example Configuration File"
metrics-listen="127.0.0.1:6174"
metrics-port="6174"
```
Specifies the host and port on which the [Prometheus](https://prometheus.io/) monitoring service accesses Pantheon
metrics. The default is `127.0.0.1:9545`. The metrics server respects the [`--host-whitelist` option](#host-whitelist).
Specifies the port on which the [Prometheus](https://prometheus.io/) monitoring service accesses Pantheon
metrics. The default is `9545`. The metrics server respects the [`--host-whitelist` option](#host-whitelist).
`<PATH>` is the path of the private key file of the node.
`<FILE>` is the path of the private key file of the node.
The default is the key file in the data directory.
If no key file exists, a key file containing the generated private key is created;
otherwise, the existing key file specifies the node private key.
@ -416,6 +453,10 @@ Not intended for use with mainnet or public testnets.
### ottoman
!!!important
This option is deprecated in favor of the new `--network` option.
It will be completely removed in the 0.9 release.
```bash tab="Syntax"
--ottoman
```
@ -429,29 +470,54 @@ Synchronize against the Ottoman test network. This is only useful if you are usi
!!!note
:construction: IBFT is not currently supported. Support for IBFT is in active development.
### p2p-listen
### p2p-host
```bash tab="Syntax"
--p2p-listen=<HOST:PORT>
--p2p-host=<HOST>
```
```bash tab="Example Command Line"
# to listen on all interfaces on port 1789
--p2p-listen=0.0.0.0:1789
# to listen on all interfaces
--p2p-host=0.0.0.0
```
```bash tab="Example Configuration File"
p2p-listen="0.0.0.0:1789"
p2p-host="0.0.0.0"
```
Specifies the host and port on which P2P peer discovery listens.
The default is 127.0.0.1:30303.
Specifies the host on which P2P peer discovery listens.
The default is 127.0.0.1.
!!!note
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports).
### p2p-port
```bash tab="Syntax"
--p2p-port=<PORT>
```
```bash tab="Example Command Line"
# to listen on port 1789
--p2p-port=1789
```
```bash tab="Example Configuration File"
p2p-port="1789"
```
Specifies the port on which P2P peer discovery listens.
The default is 30303.
!!!note
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports).
### rinkeby
!!!important
This option is deprecated in favor of the new `--network` option.
It will be completely removed in the 0.9 release.
```bash tab="Syntax"
--rinkeby
```
@ -466,6 +532,10 @@ Default is `false`.
### ropsten
!!!important
This option is deprecated in favor of the new `--network` option.
It will be completely removed in the 0.9 release.
```bash tab="Syntax"
--ropsten
```
@ -480,82 +550,107 @@ Default is `false`.
!!!note
This option is only available only from v0.8.2. For v0.8.1, refer to [Starting Pantheon](../Getting-Started/Starting-Pantheon.md#run-a-node-on-ropsten-testnet).
### rpc-enabled
### rpc-http-enabled
```bash tab="Syntax"
--rpc-enabled
--rpc-http-enabled
```
```bash tab="Example Configuration File"
rpc-enabled=true
rpc-http-enabled=true
```
Set to `true` to enable the JSON-RPC service (RPC over HTTP).
Set to `true` to enable the HTTP JSON-RPC service.
The default is `false`.
### rpc-listen
### rpc-http-host
```bash tab="Syntax"
--rpc-http-host=<HOST>
```
```bash tab="Example Command Line"
# to listen on all interfaces
--rpc-http-host=0.0.0.0
```
```bash tab="Example Configuration File"
rpc-http-host="0.0.0.0"
```
Specifies the host on which HTTP JSON-RPC listens.
The default is 127.0.0.1.
!!!note
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports).
### rpc-http-port
```bash tab="Syntax"
--rpc-listen=<HOST:PORT>
--rpc-http-port=<PORT>
```
```bash tab="Example Command Line"
# to listen on all interfaces on port 3435
--rpc-listen=0.0.0.0:3435
# to listen on port 3435
--rpc-http-port=3435
```
```bash tab="Example Configuration File"
rpc-listen="0.0.0.0:3435"
rpc-http-port="3435"
```
Specifies the host and port on which JSON-RPC listens.
The default is 127.0.0.1:8545.
Specifies the port on which HTTP JSON-RPC listens.
The default is 8545.
!!!note
This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports).
### rpc-api
### rpc-http-api
```bash tab="Syntax"
--rpc-api=<apiname>[,<apiname>...]...
--rpc-http-api=<apiname>[,<apiname>...]...
```
```bash tab="Example Command Line"
--rpc-api=ETH,NET,WEB3
--rpc-http-api=ETH,NET,WEB3
```
```bash tab="Example Configuration File"
rpc-api=["ETH","NET","WEB3"]
rpc-http-api=["ETH","NET","WEB3"]
```
Comma-separated APIs to enable on the JSON-RPC channel.
When you use this option, the `--rpc-enabled` option must also be specified.
Comma-separated APIs to enable on the HTTP JSON-RPC channel.
When you use this option, the `--rpc-http-enabled` option must also be specified.
The available API options are: `ADMIN`, `ETH`, `NET`, `WEB3`, `CLIQUE`, `IBFT`, `DEBUG`, and `MINER`.
The default is: `ETH`, `NET`, `WEB3`, `CLIQUE`, `IBFT`.
!!!note
:construction: IBFT is not currently supported. Support for IBFT is in active development.
### rpc-cors-origins
!!!tip
The singular `--rpc-http-api` and plural `--rpc-http-apis` are available and are just two
names for the same option.
### rpc-http-cors-origins
```bash tab="Syntax"
--rpc-cors-origins=<rpcCorsAllowedOrigins> or all
--rpc-http-cors-origins=<url>[,<url>...]... or all or *
```
```bash tab="Example Command Line"
# You can whitelist one or more domains with a comma-separated list.