Added links to running from Docker image (#1079)

Signed-off-by: Adrian Sutton <adrian.sutton@consensys.net>
pull/2/head
MadelineMurray 6 years ago committed by GitHub
parent 75d0565641
commit fc3383eb5d
  1. 6
      docs/Configuring-Pantheon/Bootnodes.md
  2. 2
      docs/Configuring-Pantheon/Networking.md
  3. 5
      docs/Configuring-Pantheon/Node-Keys.md
  4. 6
      docs/Configuring-Pantheon/Using-Configuration-File.md
  5. 4
      docs/Consensus-Protocols/Clique.md
  6. 4
      docs/Consensus-Protocols/IBFT.md
  7. 6
      docs/JSON-RPC-API/Authentication.md
  8. 2
      docs/JSON-RPC-API/Using-JSON-RPC-API.md
  9. 5
      docs/Permissions/Permissioning.md
  10. 9
      docs/Tutorials/Create-IBFT-Network.md
  11. 9
      docs/Tutorials/Create-Permissioned-Network.md
  12. 9
      docs/Tutorials/Create-Private-Clique-Network.md
  13. 6
      docs/Tutorials/Create-Private-Network.md

@ -28,6 +28,12 @@ To start a bootnode for a private network:
The node public key is exported to the `bootnode` file.
!!!note
The [`--data-path`](../Reference/Pantheon-CLI-Syntax.md#data-path) and [`--genesis-file`](../Reference/Pantheon-CLI-Syntax.md#genesis-file)
options are not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md).
Use a bind mount to [specify a configuration file with Docker](../Getting-Started/Run-Docker-Image.md#custom-genesis-file)
and volume to [specify the data directory](../Getting-Started/Run-Docker-Image.md#data-directory).
2. Start the bootnode, specifying:
* Genesis file and data directory as in the previous step.

@ -11,6 +11,8 @@ Ports must be exposed appropriately to enable communication. An example port con
![Port Configuration](../images/PortConfiguration.png)
When running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md), [expose ports](../Getting-Started/Run-Docker-Image.md#exposing-ports).
### P2P Networking
To enable peer discovery, the P2P UDP port must be open for inbound connections.

@ -44,6 +44,11 @@ Specified by the [`--p2p-host`](../Reference/Pantheon-CLI-Syntax.md#p2p-host) an
Use the [`--node-private-key-file`](../Reference/Pantheon-CLI-Syntax.md#node-private-key-file) option to specify a custom `key` file in any location.
!!!note
The [`--node-private-key-file`](../Reference/Pantheon-CLI-Syntax.md#node-private-key-file) option is
not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md). When running
from the Docker image, Pantheon always uses the key file in the [data directory](../Getting-Started/Run-Docker-Image.md#data-directory).
If the `key` file exists, the node is started with the private key in the custom `key` file. If the custom `key` file does not exist,
a node private key is generated and written to the custom `key` file.

@ -3,7 +3,11 @@
To specify command line options in a file, use a TOML configuration file.
The configuration file can be saved and reused across node startups. To specify the configuration file,
use the [`--config-file` option](../Reference/Pantheon-CLI-Syntax.md#config).
use the [`--config-file`](../Reference/Pantheon-CLI-Syntax.md#config-file) option.
!!!note
The [`--config-file`](../Reference/Pantheon-CLI-Syntax.md#config-file) option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md).
Use a bind mount to [specify a configuration file with Docker](../Getting-Started/Run-Docker-Image.md#custom-configuration-file).
To override an option specified in the configuration file, specify the same option on the command line.
When an option is specified in both places, Pantheon is started with the command line value.

@ -78,6 +78,10 @@ To connect to the Rinkeby testnet, start Pantheon with the [`--network=rinkeby`]
command line option. To start a node on a Clique private network, use the
[`--genesis-file`](../Reference/Pantheon-CLI-Syntax.md#genesis-file) option to specify the custom genesis file.
!!!note
The [`--genesis-file`](../Reference/Pantheon-CLI-Syntax.md#genesis-file) option is not used when running
Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md). Use a bind mount to [specify a configuration file with Docker](../Getting-Started/Run-Docker-Image.md#custom-genesis-file).
## Adding and Removing Signers
To propose adding or removing signers using the JSON-RPC methods, enable the HTTP interface

@ -53,6 +53,10 @@ Properties that have specific values in IBFT 2.0 genesis files are:
To start a node on an IBFT 2.0 private network, use the [`--genesis-file`](../Reference/Pantheon-CLI-Syntax.md#genesis-file`) option to specify the custom genesis file.
!!!note
The [`--genesis-file`](../Reference/Pantheon-CLI-Syntax.md#genesis-file) option is not used when running
Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md). Use a bind mount to [specify a configuration file with Docker](../Getting-Started/Run-Docker-Image.md#custom-genesis-file).
### Extra Data
The `extraData` property is RLP encoded. RLP encoding is a space efficient object serialization scheme

@ -57,6 +57,12 @@ Use the [`--rpc-http-authentication-credentials-file`](../Reference/Pantheon-CLI
and [`--rpc-ws-authentication-credentials-file`](../Reference/Pantheon-CLI-Syntax.md#rpc-ws-authentication-credentials-file)
options to specify the [credentials file](#credentials-file).
!!!note
The [`--rpc-http-authentication-credentials-file`](../Reference/Pantheon-CLI-Syntax.md#rpc-http-authentication-credentials-file)
and [`--rpc-ws-authentication-credentials-file`](../Reference/Pantheon-CLI-Syntax.md#rpc-ws-authentication-credentials-file)
options are not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md).
Use a bind mount to [specify a credentials file with Docker](../Getting-Started/Run-Docker-Image.md#credentials-files).
## Obtaining an Authentication Token
To obtain an authentication token, make a request to the `/login` endpoint with your username and password.

@ -33,6 +33,8 @@ options to specify the port on which the JSON-RPC listens. The default ports are
* 8545 for HTTP
* 8546 for WebSockets
Ports must be [exposed appropriately](../Configuring-Pantheon/Networking.md#port-configuration).
## Host Whitelist
To prevent DNS rebinding, incoming HTTP requests and WebSockets connections are only accepted from hostnames

@ -143,6 +143,11 @@ must be in the [data directory](../Reference/Pantheon-CLI-Syntax.md#data-path) f
Use the [`--permissions-config-file`](../Reference/Pantheon-CLI-Syntax.md#permissions-config-file) option to specify a permissions configuration file
in any location.
!!!note
The [`--permissions-config-file`](../Reference/Pantheon-CLI-Syntax.md#permissions-config-file) option is
not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md).
Use a bind mount to [specify a permissions configuration file with Docker](../Getting-Started/Run-Docker-Image.md#permissions-configuration-file).
!!! example "Example Permissions Configuration File"
```toml

@ -61,6 +61,10 @@ pantheon --data-path=data public-key export --to=data/publicKey
pantheon --data-path=path public-key export --to=data\publicKey
```
!!!note
The [`--data-path`](../Reference/Pantheon-CLI-Syntax.md#data-path) option is not used when running Pantheon
from the [Docker image](../Getting-Started/Run-Docker-Image.md). Use a volume to [specify the data directory](../Getting-Started/Run-Docker-Image.md#data-directory).
Your node 1 directory now contains:
```bash
├── Node-1
@ -208,6 +212,11 @@ pantheon --data-path=data --genesis-file=../ibftGenesis.json --rpc-http-enabled
pantheon --data-path=data --genesis-file=..\ibftGenesis.json --rpc-http-enabled --rpc-http-api=ETH,NET,IBFT --host-whitelist=* --rpc-http-cors-origins="all"
```
!!!note
The [`--genesis-file`](../Reference/Pantheon-CLI-Syntax.md#genesis-file) option is not used when running
Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md). Use a bind mount to
[specify a configuration file with Docker](../Getting-Started/Run-Docker-Image.md#custom-genesis-file).
The command line specifies:
* Data directory for Node-1 using the [`--data-path`](../Reference/Pantheon-CLI-Syntax.md#data-path) option.

@ -63,6 +63,10 @@ pantheon --data-path=Node-1-data-path public-key export --to=Node-1-data-path/pu
pantheon --data-path=Node-1-data-path public-key export --to=Node-1-data-path\publicKeyNode1
```
!!!note
The [`--data-path`](../Reference/Pantheon-CLI-Syntax.md#data-path) option is not used when running Pantheon
from the [Docker image](../Getting-Started/Run-Docker-Image.md). Use a volume to [specify the data directory](../Getting-Started/Run-Docker-Image.md#data-directory).
Your node 1 directory now contains:
```bash
├── Node-1
@ -216,6 +220,11 @@ pantheon --data-path=Node-1-data-path --genesis-file=../cliqueGenesis.json --per
pantheon --data-path=Node-1-data-path --genesis-file=..\cliqueGenesis.json --permissions-nodes-enabled --permissions-accounts-enabled --rpc-http-enabled --rpc-http-api=ADMIN,ETH,NET,PERM,CLIQUE --host-whitelist=* --rpc-http-cors-origins=*
```
!!!note
The [`--genesis-file`](../Reference/Pantheon-CLI-Syntax.md#genesis-file) option is not used when running
Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md). Use a bind mount to
[specify a configuration file with Docker](../Getting-Started/Run-Docker-Image.md#custom-genesis-file).
The command line specifies:
* Nodes and accounts permissions are enabled using the [`--permissions-nodes-enabled`](../Reference/Pantheon-CLI-Syntax.md#permissions-nodes-enabled)

@ -58,6 +58,10 @@ pantheon --data-path=Node-1-data-path public-key export --to=Node-1-data-path/pu
```bash tab="Windows"
pantheon --data-path=Node-1-data-path public-key export --to=Node-1-data-path\publicKeyNode1
```
!!!note
The [`--data-path`](../Reference/Pantheon-CLI-Syntax.md#data-path) option is not used when running
Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md). Use a volume to
[specify the data directory](../Getting-Started/Run-Docker-Image.md#data-directory).
Your node 1 directory now contains:
```bash
@ -170,6 +174,11 @@ pantheon --data-path=Node-1-data-path --genesis-file=../cliqueGenesis.json --boo
pantheon --data-path=Node-1-data-path --genesis-file=..\cliqueGenesis.json --bootnodes --network-id 123 --rpc-http-enabled --rpc-http-api=ETH,NET,CLIQUE --host-whitelist=* --rpc-http-cors-origins="all"
```
!!!note
The [`--genesis-file`](../Reference/Pantheon-CLI-Syntax.md#genesis-file) option is not used when running
Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md). Use a bind mount to
[specify a configuration file with Docker](../Getting-Started/Run-Docker-Image.md#custom-genesis-file).
The command line specifies:
* No arguments for the [`--bootnodes`](../Reference/Pantheon-CLI-Syntax.md#bootnodes) option because this is your bootnode

@ -101,6 +101,12 @@ pantheon --data-path=Node-1-data-path --genesis-file=../privateNetworkGenesis.js
pantheon --data-path=Node-1-data-path --genesis-file=..\privateNetworkGenesis.json public-key export --to=Node-1-data-path\publicKeyNode1
```
!!!note
The [`--data-path`](../Reference/Pantheon-CLI-Syntax.md#data-path) and [`--genesis-file`](../Reference/Pantheon-CLI-Syntax.md#genesis-file)
options are not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md).
Use a bind mount to [specify a configuration file with Docker](../Getting-Started/Run-Docker-Image.md#custom-genesis-file)
and volume to [specify the data directory](../Getting-Started/Run-Docker-Image.md#data-directory).
Your node 1 directory now contains:
```bash
├── Node-1

Loading…
Cancel
Save