Updated doc to specify bootnodes using --bootnodes with no arguments (#560)

* Updated for --bootnodes option to take no arguments


Signed-off-by: Adrian Sutton <adrian.sutton@consensys.net>
pull/2/head
MadelineMurray 6 years ago committed by GitHub
parent aa9f4a0231
commit 4a48df1df7
  1. 4
      docs/Configuring-Pantheon/Testing-Developing-Nodes.md
  2. 7
      docs/Getting-Started/Starting-Pantheon.md
  3. 10
      docs/Reference/Pantheon-CLI-Syntax.md
  4. 6
      docs/Tutorials/Create-Private-Network.md

@ -30,13 +30,13 @@ To start a bootnode for a private network:
2. Start the bootnode, specifying: 2. Start the bootnode, specifying:
* Empty string for the [`--bootnodes`](../Reference/Pantheon-CLI-Syntax.md#bootnodes) option because this is the bootnode. * No arguments for the [`--bootnodes` option](../Reference/Pantheon-CLI-Syntax.md#bootnodes) because this is the bootnode.
* Network ID for your private network. * Network ID for your private network.
* Genesis file and data directory as in the previous step. * Genesis file and data directory as in the previous step.
!!! example !!! example
``` ```
pantheon --bootnodes="" --genesis=privateNetworkGenesis.json --datadir=nodeDataDir --network-id 123 pantheon --bootnodes --genesis=privateNetworkGenesis.json --datadir=nodeDataDir --network-id 123
``` ```
To specify this bootnode for another node, the enode URL for the `--bootnodes` option is `enode://<id>@<host:port>` where: To specify this bootnode for another node, the enode URL for the `--bootnodes` option is `enode://<id>@<host:port>` where:

@ -67,14 +67,13 @@ call [JSON-RPC API methods](../Reference/JSON-RPC-API-Methods.md) to confirm the
To run a node that mines blocks at a rate suitable for testing purposes: To run a node that mines blocks at a rate suitable for testing purposes:
```bash ```bash
pantheon --dev-mode --network-id="2018" --bootnodes= --miner-enabled --miner-coinbase=0xfe3b557e8fb62b89f4916b721be55ceb828dbd73 --rpc-cors-origins="all" --ws-enabled --rpc-enabled --datadir=/tmp/tmpDatdir pantheon --dev-mode --network-id="2018" --bootnodes --miner-enabled --miner-coinbase=0xfe3b557e8fb62b89f4916b721be55ceb828dbd73 --rpc-cors-origins="all" --ws-enabled --rpc-enabled --datadir=/tmp/tmpDatdir
``` ```
Alternatively, use the following [configuration file](../Configuring-Pantheon/) to start a node with the same options as the above command line: Alternatively, use the following [configuration file](../Configuring-Pantheon/Using-Configuration-File.md) and `--bootnodes` on the command line to start a node with the same options as above:
```toml ```toml
dev-mode=true dev-mode=true
network-id="2018" network-id="2018"
bootnodes=[]
miner-enabled=true miner-enabled=true
miner-coinbase="0xfe3b557e8fb62b89f4916b721be55ceb828dbd73" miner-coinbase="0xfe3b557e8fb62b89f4916b721be55ceb828dbd73"
rpc-cors-origins="all" rpc-cors-origins="all"
@ -137,4 +136,4 @@ To run a node on mainnet with the HTTP JSON-RPC service enabled:
```bash ```bash
pantheon --rpc-enabled pantheon --rpc-enabled
``` ```

@ -58,7 +58,7 @@ List of node IDs with which this node will not peer. The node ID is the public k
### bootnodes ### bootnodes
```bash tab="Syntax" ```bash tab="Syntax"
--bootnodes=<enode://id@host:port>[,<enode://id@host:port>...]... --bootnodes[=<enode://id@host:port>[,<enode://id@host:port>...]...]
``` ```
```bash tab="Example Command Line" ```bash tab="Example Command Line"
@ -69,11 +69,19 @@ List of node IDs with which this node will not peer. The node ID is the public k
bootnodes=["enode://c35c3...d615f@1.2.3.4:30303","enode://f42c13...fc456@1.2.3.5:30303"] bootnodes=["enode://c35c3...d615f@1.2.3.4:30303","enode://f42c13...fc456@1.2.3.5:30303"]
``` ```
```bash tab="Example Node Acting as Bootnode"
--bootnodes
```
List of comma-separated enode URLs for P2P discovery bootstrap. List of comma-separated enode URLs for P2P discovery bootstrap.
When connecting to mainnet or public testnets, the default is a predefined list of enode URLs. When connecting to mainnet or public testnets, the default is a predefined list of enode URLs.
Specify bootnodes when connecting to a [private network](../Configuring-Pantheon/Testing-Developing-Nodes.md#bootnodes). Specify bootnodes when connecting to a [private network](../Configuring-Pantheon/Testing-Developing-Nodes.md#bootnodes).
!!! note
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
```bash tab="Syntax" ```bash tab="Syntax"

@ -132,17 +132,17 @@ The `database` directory is created when the node is started and contains the bl
Restart Node-1 specifying: Restart Node-1 specifying:
* An empty string for the [`--bootnodes` option](../Reference/Pantheon-CLI-Syntax.md#bootnodes) because this is your bootnode. * No arguments for the [`--bootnodes` option](../Reference/Pantheon-CLI-Syntax.md#bootnodes) because this is your bootnode.
* Mining is enabled and the account to which mining rewards are paid using the [`--miner-enabled`](../Reference/Pantheon-CLI-Syntax.md#miner-enabled) * Mining is enabled and the account to which mining rewards are paid using the [`--miner-enabled`](../Reference/Pantheon-CLI-Syntax.md#miner-enabled)
and [`--miner-coinbase` options](../Reference/Pantheon-CLI-Syntax.md#miner-coinbase). and [`--miner-coinbase` options](../Reference/Pantheon-CLI-Syntax.md#miner-coinbase).
* JSON-RPC API is enabled using the [`--rpc-enabled` option](../Reference/Pantheon-CLI-Syntax.md#rpc-enabled). * JSON-RPC API is enabled using the [`--rpc-enabled` option](../Reference/Pantheon-CLI-Syntax.md#rpc-enabled).
```bash tab="MacOS" ```bash tab="MacOS"
pantheon --datadir=Node-1-Datadir --genesis=../privateNetworkGenesis.json --bootnodes="" --network-id 123 --miner-enabled --miner-coinbase fe3b557e8fb62b89f4916b721be55ceb828dbd73 --rpc-enabled pantheon --datadir=Node-1-Datadir --genesis=../privateNetworkGenesis.json --bootnodes --network-id 123 --miner-enabled --miner-coinbase fe3b557e8fb62b89f4916b721be55ceb828dbd73 --rpc-enabled
``` ```
```bash tab="Windows" ```bash tab="Windows"
pantheon --datadir=Node-1-Datadir --genesis=..\privateNetworkGenesis.json --bootnodes="" --network-id 123 --miner-enabled --miner-coinbase fe3b557e8fb62b89f4916b721be55ceb828dbd73 --rpc-enabled pantheon --datadir=Node-1-Datadir --genesis=..\privateNetworkGenesis.json --bootnodes --network-id 123 --miner-enabled --miner-coinbase fe3b557e8fb62b89f4916b721be55ceb828dbd73 --rpc-enabled
``` ```
!!! info !!! info

Loading…
Cancel
Save