mirror of
https://github.com/tendermint/tendermint.git
synced 2026-09-19 06:31:57 +00:00
docs: use hyphens instead of snake case (#5802)
This commit is contained in:
@@ -4,4 +4,4 @@ order: false
|
||||
|
||||
# Configuration
|
||||
|
||||
This file has moved to the [node_operators section](../node_operators/configuration.md).
|
||||
This file has moved to the [nodes section](../nodes/configuration.md).
|
||||
|
||||
@@ -4,4 +4,4 @@ order: false
|
||||
|
||||
# Metrics
|
||||
|
||||
This file has moved to the [node_operators section](../node_operators/metrics.md).
|
||||
This file has moved to the [node section](../node/metrics.md).
|
||||
|
||||
@@ -36,14 +36,14 @@ Applications can use [state sync](state-sync.md) to help nodes bootstrap quickly
|
||||
|
||||
## Logging
|
||||
|
||||
Default logging level (`log_level = "main:info,state:info,statesync:info,*:error"`) should suffice for
|
||||
Default logging level (`log-level = "main:info,state:info,statesync:info,*:error"`) should suffice for
|
||||
normal operation mode. Read [this
|
||||
post](https://blog.cosmos.network/one-of-the-exciting-new-features-in-0-10-0-release-is-smart-log-level-flag-e2506b4ab756)
|
||||
for details on how to configure `log_level` config variable. Some of the
|
||||
for details on how to configure `log-level` config variable. Some of the
|
||||
modules can be found [here](./how-to-read-logs.md#list-of-modules). If
|
||||
you're trying to debug Tendermint or asked to provide logs with debug
|
||||
logging level, you can do so by running Tendermint with
|
||||
`--log_level="*:debug"`.
|
||||
`--log-level="*:debug"`.
|
||||
|
||||
## Write Ahead Logs (WAL)
|
||||
|
||||
@@ -73,7 +73,7 @@ polling for them, or using `/broadcast_tx_commit`. In the worst case, txs can be
|
||||
resent from the mempool WAL manually.
|
||||
|
||||
For the above reasons, the `mempool.wal` is disabled by default. To enable, set
|
||||
`mempool.wal_dir` to where you want the WAL to be located (e.g.
|
||||
`mempool.wal-dir` to where you want the WAL to be located (e.g.
|
||||
`data/mempool.wal`).
|
||||
|
||||
## DOS Exposure and Mitigation
|
||||
@@ -296,10 +296,10 @@ Cosmos network.
|
||||
|
||||
## Configuration parameters
|
||||
|
||||
- `p2p.flush_throttle_timeout`
|
||||
- `p2p.max_packet_msg_payload_size`
|
||||
- `p2p.send_rate`
|
||||
- `p2p.recv_rate`
|
||||
- `p2p.flush-throttle-timeout`
|
||||
- `p2p.max-packet-msg-payload-size`
|
||||
- `p2p.send-rate`
|
||||
- `p2p.recv-rate`
|
||||
|
||||
If you are going to use Tendermint in a private domain and you have a
|
||||
private high-speed network among your peers, it makes sense to lower
|
||||
@@ -308,10 +308,10 @@ flush throttle timeout and increase other params.
|
||||
```toml
|
||||
[p2p]
|
||||
|
||||
send_rate=20000000 # 2MB/s
|
||||
recv_rate=20000000 # 2MB/s
|
||||
flush_throttle_timeout=10
|
||||
max_packet_msg_payload_size=10240 # 10KB
|
||||
send-rate=20000000 # 2MB/s
|
||||
recv-rate=20000000 # 2MB/s
|
||||
flush-throttle-timeout=10
|
||||
max-packet-msg-payload-size=10240 # 10KB
|
||||
```
|
||||
|
||||
- `mempool.recheck`
|
||||
@@ -328,26 +328,26 @@ Setting this to false will stop the mempool from relaying transactions
|
||||
to other peers until they are included in a block. It means only the
|
||||
peer you send the tx to will see it until it is included in a block.
|
||||
|
||||
- `consensus.skip_timeout_commit`
|
||||
- `consensus.skip-timeout-commit`
|
||||
|
||||
We want `skip_timeout_commit=false` when there is economics on the line
|
||||
We want `skip-timeout-commit=false` when there is economics on the line
|
||||
because proposers should wait to hear for more votes. But if you don't
|
||||
care about that and want the fastest consensus, you can skip it. It will
|
||||
be kept false by default for public deployments (e.g. [Cosmos
|
||||
Hub](https://cosmos.network/intro/hub)) while for enterprise
|
||||
applications, setting it to true is not a problem.
|
||||
|
||||
- `consensus.peer_gossip_sleep_duration`
|
||||
- `consensus.peer-gossip-sleep-duration`
|
||||
|
||||
You can try to reduce the time your node sleeps before checking if
|
||||
theres something to send its peers.
|
||||
|
||||
- `consensus.timeout_commit`
|
||||
- `consensus.timeout-commit`
|
||||
|
||||
You can also try lowering `timeout_commit` (time we sleep before
|
||||
You can also try lowering `timeout-commit` (time we sleep before
|
||||
proposing the next block).
|
||||
|
||||
- `p2p.addr_book_strict`
|
||||
- `p2p.addr-book-strict`
|
||||
|
||||
By default, Tendermint checks whenever a peer's address is routable before
|
||||
saving it to the address book. The address is considered as routable if the IP
|
||||
@@ -355,10 +355,10 @@ is [valid and within allowed
|
||||
ranges](https://github.com/tendermint/tendermint/blob/27bd1deabe4ba6a2d9b463b8f3e3f1e31b993e61/p2p/netaddress.go#L209).
|
||||
|
||||
This may not be the case for private or local networks, where your IP range is usually
|
||||
strictly limited and private. If that case, you need to set `addr_book_strict`
|
||||
strictly limited and private. If that case, you need to set `addr-book-strict`
|
||||
to `false` (turn it off).
|
||||
|
||||
- `rpc.max_open_connections`
|
||||
- `rpc.max-open-connections`
|
||||
|
||||
By default, the number of simultaneous connections is limited because most OS
|
||||
give you limited number of file descriptors.
|
||||
@@ -392,4 +392,4 @@ echo $((N/8)) > /sys/module/nf_conntrack/parameters/hashsize
|
||||
```
|
||||
|
||||
The similar option exists for limiting the number of gRPC connections -
|
||||
`rpc.grpc_max_open_connections`.
|
||||
`rpc.grpc-max-open-connections`.
|
||||
|
||||
@@ -138,7 +138,7 @@ another window. If you don't, kill Tendermint and run an in-process version of
|
||||
the `kvstore` app:
|
||||
|
||||
```bash
|
||||
tendermint node --proxy_app=kvstore
|
||||
tendermint node --proxy-app=kvstore
|
||||
```
|
||||
|
||||
After a few seconds, you should see blocks start streaming in. Note that blocks
|
||||
@@ -148,11 +148,11 @@ Blocks_, below, to modify this setting.
|
||||
Tendermint supports in-process versions of the `counter`, `kvstore`, and `noop`
|
||||
apps that ship as examples with `abci-cli`. It's easy to compile your app
|
||||
in-process with Tendermint if it's written in Go. If your app is not written in
|
||||
Go, run it in another process, and use the `--proxy_app` flag to specify the
|
||||
Go, run it in another process, and use the `--proxy-app` flag to specify the
|
||||
address of the socket it is listening on, for instance:
|
||||
|
||||
```bash
|
||||
tendermint node --proxy_app=/var/run/abci.sock
|
||||
tendermint node --proxy-app=/var/run/abci.sock
|
||||
```
|
||||
|
||||
You can find out what flags are supported by running `tendermint node --help`.
|
||||
@@ -254,7 +254,7 @@ Tendermint uses a `config.toml` for configuration. For details, see [the
|
||||
config specification](./configuration.md).
|
||||
|
||||
Notable options include the socket address of the application
|
||||
(`proxy_app`), the listening address of the Tendermint peer
|
||||
(`proxy-app`), the listening address of the Tendermint peer
|
||||
(`p2p.laddr`), and the listening address of the RPC server
|
||||
(`rpc.laddr`).
|
||||
|
||||
@@ -441,7 +441,7 @@ have to use a seed node if you have a live persistent peer.
|
||||
To connect to peers on start-up, specify them in the
|
||||
`$TMHOME/config/config.toml` or on the command line. Use `seeds` to
|
||||
specify seed nodes, and
|
||||
`persistent_peers` to specify peers that your node will maintain
|
||||
`persistent-peers` to specify peers that your node will maintain
|
||||
persistent connections with.
|
||||
|
||||
For example,
|
||||
@@ -462,12 +462,12 @@ should not need seeds after the first start.
|
||||
|
||||
If you want Tendermint to connect to specific set of addresses and
|
||||
maintain a persistent connection with each, you can use the
|
||||
`--p2p.persistent_peers` flag or the corresponding setting in the
|
||||
`--p2p.persistent-peers` flag or the corresponding setting in the
|
||||
`config.toml` or the `/dial_peers` RPC endpoint to do it without
|
||||
stopping Tendermint core instance.
|
||||
|
||||
```sh
|
||||
tendermint node --p2p.persistent_peers "429fcf25974313b95673f58d77eacdd434402665@10.11.12.13:26656,96663a3dd0d7b9d17d4c8211b191af259621c693@10.11.12.14:26656"
|
||||
tendermint node --p2p.persistent-peers "429fcf25974313b95673f58d77eacdd434402665@10.11.12.13:26656,96663a3dd0d7b9d17d4c8211b191af259621c693@10.11.12.14:26656"
|
||||
|
||||
curl 'localhost:26657/dial_peers?persistent=true&peers=\["429fcf25974313b95673f58d77eacdd434402665@10.11.12.13:26656","96663a3dd0d7b9d17d4c8211b191af259621c693@10.11.12.14:26656"\]'
|
||||
```
|
||||
@@ -546,7 +546,7 @@ file and the new `priv_validator_key.json` to the `~/.tendermint/config` on
|
||||
a new machine.
|
||||
|
||||
Now run `tendermint node` on both machines, and use either
|
||||
`--p2p.persistent_peers` or the `/dial_peers` to get them to peer up.
|
||||
`--p2p.persistent-peers` or the `/dial_peers` to get them to peer up.
|
||||
They should start making blocks, and will only continue to do so as long
|
||||
as both of them are online.
|
||||
|
||||
|
||||
@@ -4,4 +4,4 @@ order: false
|
||||
|
||||
# Validators
|
||||
|
||||
This file has moved to the [node_operators section](../node_operators/validators.md).
|
||||
This file has moved to the [node section](../node/validators.md).
|
||||
|
||||
Reference in New Issue
Block a user