Update README.md (#641)

Make it more clear that -mesh.peer flag should be
repeated for each peer.
This commit is contained in:
stuart nelson 2017-03-02 12:35:04 +01:00 committed by GitHub
parent 24a9a64bdf
commit 412d33336d
1 changed files with 9 additions and 6 deletions

View File

@ -177,13 +177,16 @@ be configured to communicate with each other. This is configured using the
- `-mesh.peer-id` string: mesh peer ID (default "<hardware-mac-address>")
- `-mesh.listen-address` string: mesh listen address (default "0.0.0.0:6783")
- `-mesh.nickname` string: mesh peer nickname (default "<machine-hostname>")
- `-mesh.peer` value: initial peers (may be repeated)
- `-mesh.peer` value: initial peers (repeat flag for each additional peer)
The `mesh.peer-id` flag is used as a unique ID among the peers. It
defaults to the MAC address, therefore the default value should typically be a
good option. The same applies to the default of the `mesh.nickname` flag, as it
defaults to the hostname. The chosen port in the `mesh.listen-address` flag is
the port that needs to be specified in the `mesh.peer` flag of the other peers.
The `mesh.peer-id` flag is used as a unique ID among the peers. It defaults to
the MAC address, therefore the default value should typically be a good option.
The same applies to the default of the `mesh.nickname` flag, as it defaults to
the hostname.
The chosen port in the `mesh.listen-address` flag is the port that needs to be
specified in the `mesh.peer` flag of the other peers.
To start a cluster of three peers on your local machine use `goreman` and the
Procfile within this repository.