Improve dirty reference of monerod p2p options

This commit is contained in:
Piotr Włodarek 2018-09-19 17:25:52 +02:00
parent a1ba2fc042
commit f3938ec120
5 changed files with 25 additions and 14 deletions

View file

@ -19,7 +19,7 @@ This allows you to run `monerod` on a separate computer or in the cloud.
In fact, you can connect to a remote `monerod` instance provided by a semi-trusted 3rd party. Such 3rd party will not be able to steal your funds. This is very handy for learning and experimentation.
However, there are privacy and reliability implications to using remote, untrusted node. For any real business **you should be running your own full node**.
However, there are privacy and reliability implications to using a remote, untrusted node. For any real business **you should be running your own full node**.
## Data directory

View file

@ -48,18 +48,22 @@ The following options will be helpful if you intend to have an always running no
(WORK IN PROGRESS)
The following options define how your node participates in Monero peer-to-peer network. This is for node-to-node communication. It does **not** affect wallet-to-node interface.
The following options define how your node participates in Monero peer-to-peer network.
This is for node-to-node communication. It does **not** affect wallet-to-node interface.
The node and peer words are used interchangeably.
| Option | Description
|------------------------|--------------------------------------------------------------------------------------------------------------------------------------
| `--p2p-bind-ip` | Network interface to bind to for p2p network protocol. Default value `0.0.0.0` binds to all network interfaces. This is typically what you want. You must change this if you want to constrain binding, for example to configure connection through TOR.
| `--p2p-bind-port` | TCP port to listen for p2p network connections. Defaults to `18080` for mainnet, `28080` for testnet, and 38080 for stagenet. You normally wouldn't change that.
| `--p2p-bind-ip` | Network interface to bind to for p2p network protocol. Default value `0.0.0.0` binds to all network interfaces. This is typically what you want. <br /><br />You must change this if you want to constrain binding, for example to configure connection through Tor via torsocks: <br />`DNS_PUBLIC=tcp://1.1.1.1 TORSOCKS_ALLOW_INBOUND=1 torsocks ./monerod --p2p-bind-ip 127.0.0.1--no-igd--hide-my-port`
| `--p2p-bind-port` | TCP port to listen for p2p network connections. Defaults to `18080` for mainnet, `28080` for testnet, and `38080` for stagenet. You normally wouldn't change that. This is helpful to run several nodes on your machine to simulate private Monero p2p network (likely using private Testnet). Example: <br/>`./monerod --p2p-bind-port=48080`
| `--p2p-external-port` | TCP port to listen for p2p network connections on your router. Relevant if you are behind a NAT and still want to accept incoming connections. You must then set this to relevant port on your router. This is to let `monerod` know what to advertise on the network. Default is `0`.
| `--no-igd` | Disable UPnP port mapping. Add this option to improve security if you are **not** behind a NAT (you can bind directly to public IP or you run through Tor).
| `--hide-my-port` | `monerod` will still open and listen on the p2p port. However, it will not announce itself as a peerlist candidate. Technically, it will return port `0` in a response to p2p handshake (`node_data.my_port = 0` in `get_local_node_data` function). In effect nodes you connect to won't spread your IP to other nodes. To sum up, it is not really hiding, it is more like "do not advertise".
| `--add-priority-node` | Specify list of peers to connect to and
| `--add-exclusive-node` | Specify list of peers to connect to options add-priority-node and seed-node
| `--seed-node` | Connect to a node to retrieve peer
| `--p2p-external-port` | External port for p2p network protocol (if port forwarding used with NAT). Default is `0`.
| `--no-igd` | Disable UPnP port mapping.
| `--add-priority-node` | Specify list of peers to connect to and attempt to keep the connection open. <br /><br />To add multiple nodes use the option several times. Example: <br />`./monerod --add-priority-node=178.128.192.138:18081 --add-priority-node=144.76.202.167:18081`
| `--add-exclusive-node` | Specify list of peers to connect to only. If this option is given the options `--add-priority-node` and `--seed-node` are ignored. <br /><br />To add multiple nodes use the option several times. Example: <br />`./monerod --add-exclusive-node=178.128.192.138:18081 --add-exclusive-node=144.76.202.167:18081`
| `--seed-node` | Connect to a node to retrieve peer addresses, and disconnect. If not specified, `monerod` will use hardcoded seed nodes on the first run, and peers cached on disk on subsequent runs.
| `--add-peer` | Manually add peer to local peerlist.
#### Help and Version
@ -68,10 +72,9 @@ The following options define how your node participates in Monero peer-to-peer n
|---------------------|--------------------------------------------------------------------------------------------------------------------------------------
| `--help` | Enlists available options.
| `--version` | Shows `monerod` version to stdout. Example: <br />`Monero 'Lithium Luna' (v0.12.3.0-release)`
| `--os-version` | Shows build timestamp and target operating system. Example output:<br />`OS: Linux #1 SMP PREEMPT Fri Aug 24 12:48:58 UTC 2018 4.18.5-arch1-1-ARCH`.
TO BE CONTINUED
## Reference
* [Reddit answer](https://www.reddit.com/r/Monero/comments/3jhyqc/0mq_help_share_this_exciting_news/)

10
docs/overrides.css Normal file
View file

@ -0,0 +1,10 @@
/* Make reference options non-wrapping */
article .md-typeset__table td:nth-child(1) {
white-space: nowrap;
}
/* Make reference tables occupying full width */
article .md-typeset__table {
width: 100%;
}

File diff suppressed because one or more lines are too long

View file

@ -42,7 +42,7 @@ theme:
# feature:
# tabs: true
extra_css: ['extra.css']
extra_css: ['extra.css', 'overrides.css']
repo_name: 'monerodocs/md'
repo_url: 'https://github.com/monerodocs/md'