From 04f90f3ae6b56c2b0265a1370e4ebeff28d24d3c Mon Sep 17 00:00:00 2001 From: joaniefromtheblock <153745173+joaniefromtheblock@users.noreply.github.com> Date: Mon, 18 Dec 2023 17:35:55 +0000 Subject: [PATCH] additional reorder --- docs/reference/cli/index.md | 232 ++++++++++++++++++------------------ 1 file changed, 117 insertions(+), 115 deletions(-) diff --git a/docs/reference/cli/index.md b/docs/reference/cli/index.md index 79565fd40..45a423692 100644 --- a/docs/reference/cli/index.md +++ b/docs/reference/cli/index.md @@ -918,94 +918,94 @@ If overriding the genesis state in a custom network, you must supply the genesis Show the help message and exit. -### initial-state +### ignore-weak-subjectivity-period-enabled ```bash ---initial-state= +--ignore-weak-subjectivity-period-enabled[=] ``` ```bash ---initial-state=/home/me/genesis.ssz +--ignore-weak-subjectivity-period-enabled=true ``` ```bash -TEKU_INITIAL_STATE=/home/me/genesis.ssz +TEKU_IGNORE_WEAK_SUBJECTIVITY_PERIOD_ENABLED=true ``` ```bash -initial-state: "/home/me/genesis.ssz" +ignore-weak-subjectivity-period-enabled: true ``` -Path or URL to an SSZ-encoded state file. The state file can be used to specify the genesis state, or a [recent finalized checkpoint state from which to sync]. - -This option does not need to be specified if the genesis state is provided by the network specified using the [`--network`](#network) option. - -:::note - -If overriding the initial state in a custom network, you must supply the initial state file at each restart. - -::: - -:::tip - -See [this community-maintained list of checkpoint state endpoints](https://eth-clients.github.io/checkpoint-sync-endpoints/). +Ignores the [weak subjectivity](../../concepts/weak-subjectivity.md) period verification that Teku +performs at startup. +The default is `false`. +:::caution +Syncing from outside the weak subjectivity period is considered unsafe. ::: -### ignore-weak-subjectivity-period-enabled +### initial-state ```bash ---ignore-weak-subjectivity-period-enabled[=] +--initial-state= ``` ```bash ---ignore-weak-subjectivity-period-enabled=true +--initial-state=/home/me/genesis.ssz ``` ```bash -TEKU_IGNORE_WEAK_SUBJECTIVITY_PERIOD_ENABLED=true +TEKU_INITIAL_STATE=/home/me/genesis.ssz ``` ```bash -ignore-weak-subjectivity-period-enabled: true +initial-state: "/home/me/genesis.ssz" ``` -Ignores the [weak subjectivity](../../concepts/weak-subjectivity.md) period verification that Teku -performs at startup. -The default is `false`. +Path or URL to an SSZ-encoded state file. The state file can be used to specify the genesis state, or a [recent finalized checkpoint state from which to sync]. + +This option does not need to be specified if the genesis state is provided by the network specified using the [`--network`](#network) option. + +:::note + +If overriding the initial state in a custom network, you must supply the initial state file at each restart. + +::: + +:::tip + +See [this community-maintained list of checkpoint state endpoints](https://eth-clients.github.io/checkpoint-sync-endpoints/). -:::caution -Syncing from outside the weak subjectivity period is considered unsafe. ::: ### log-color-enabled @@ -1730,122 +1730,123 @@ p2p-advertised-udp-port: 1789 The advertised UDP port to external peers. The default is the port specified in [`--p2p-advertised-port`](#p2p-advertised-port) if it is set. Otherwise, the default is the port specified in [`--p2p-port`](#p2p-port). - -### p2p-discovery-enabled +### p2p-discovery-bootnodes ```bash ---p2p-discovery-enabled[=] +--p2p-discovery-bootnodes=[,...]... ``` ```bash ---p2p-discovery-enabled=false +--p2p-discovery-bootnodes=enr:-Iu4QG...wgiMo,enr:-Iu4QL...wgiMo ``` ```bash -TEKU_P2P_DISCOVERY_ENABLED=false +TEKU_P2P_DISCOVERY_BOOTNODES=enr:-Iu4QG...wgiMo,enr:-Iu4QL...wgiMo ``` ```bash -p2p-discovery-enabled: false +p2p-discovery-bootnodes: ["enr:-Iu4QG...wgiMo", + "enr:-Iu4QL...wgiMo"] ``` -Enables or disables P2P peer discovery. If disabled, [`p2p-static-peers`](#p2p-static-peers) defines the peer connections. The default is `true`. +List of comma-separated Ethereum Node Records (ENRs) for P2P discovery bootstrap. + -### p2p-discovery-site-local-addresses-enabled + +### p2p-discovery-enabled ```bash ---p2p-discovery-site-local-addresses-enabled[=] +--p2p-discovery-enabled[=] ``` ```bash ---p2p-discovery-site-local-addresses-enabled +--p2p-discovery-enabled=false ``` ```bash -TEKU_P2P_DISCOVERY_SITE_LOCAL_ADDRESSES_ENABLED=true +TEKU_P2P_DISCOVERY_ENABLED=false ``` ```bash -p2p-discovery-site-local-addresses-enabled: true +p2p-discovery-enabled: false ``` -Enables or disables discovery of the following local network (RFC1918) addresses. The default is `false`. - -```text -10.0.0.0 - 10.255.255.255 (10/8 prefix) -172.16.0.0 - 172.31.255.255 (172.16/12 prefix) -192.168.0.0 - 192.168.255.255 (192.168/16 prefix) -``` - -Normal Teku operation shouldn't send traffic to these local network addresses. - -In test or private networks, operators might need to enable discovery of local addresses. For example, when you run multiple consensus layer nodes in one local network, these nodes are not discovered on the public internet and are advertised with local (RFC1918) addresses. +Enables or disables P2P peer discovery. If disabled, [`p2p-static-peers`](#p2p-static-peers) defines the peer connections. The default is `true`. -### p2p-discovery-bootnodes +### p2p-discovery-site-local-addresses-enabled ```bash ---p2p-discovery-bootnodes=[,...]... +--p2p-discovery-site-local-addresses-enabled[=] ``` ```bash ---p2p-discovery-bootnodes=enr:-Iu4QG...wgiMo,enr:-Iu4QL...wgiMo +--p2p-discovery-site-local-addresses-enabled ``` ```bash -TEKU_P2P_DISCOVERY_BOOTNODES=enr:-Iu4QG...wgiMo,enr:-Iu4QL...wgiMo +TEKU_P2P_DISCOVERY_SITE_LOCAL_ADDRESSES_ENABLED=true ``` ```bash -p2p-discovery-bootnodes: ["enr:-Iu4QG...wgiMo", - "enr:-Iu4QL...wgiMo"] +p2p-discovery-site-local-addresses-enabled: true ``` -List of comma-separated Ethereum Node Records (ENRs) for P2P discovery bootstrap. +Enables or disables discovery of the following local network (RFC1918) addresses. The default is `false`. + +```text +10.0.0.0 - 10.255.255.255 (10/8 prefix) +172.16.0.0 - 172.31.255.255 (172.16/12 prefix) +192.168.0.0 - 192.168.255.255 (192.168/16 prefix) +``` + +Normal Teku operation shouldn't send traffic to these local network addresses. + +In test or private networks, operators might need to enable discovery of local addresses. For example, when you run multiple consensus layer nodes in one local network, these nodes are not discovered on the public internet and are advertised with local (RFC1918) addresses. ### p2p-enabled @@ -2845,63 +2846,6 @@ validator-api-port: 5052 The [validator REST API](../rest.md#enable-the-validator-client-api) listening port (HTTP). The default is 5052. -### validator-keys - - - - -```bash ---validator-keys=: | :[,: | :...]... -``` - - - - -```bash ---validator-keys=/home/validator/keys:home/validator/passwords -``` - - - - -```bash ---validator-keys=/home/validator/keys/validator_217179e.json:/home/validator/passwords/validator_217179e.txt -``` - - - - -```bash -TEKU_VALIDATOR_KEYS=/home/validator/keys:home/validator/passwords -``` - - - - -```bash -validator-keys: "/home/validator/keys:home/validator/passwords" -``` - - - - -Directory or file to load the encrypted keystore file(s) and associated password file(s) from. Keystore files must use the `.json` file extension, and password files must use the `.txt` file extension. - -When specifying directories, Teku expects to find identically named keystore and password files. For example `validator_217179e.json` and `validator_217179e.txt`. - -:::tip - -You can [load new validators without restarting Teku] if you specify a directory from which to load the keystore files. - -::: - -When specifying file names, Teku expects that the files exist. - -:::note - -The path separator is operating system dependent, and should be `;` in Windows rather than `:`. - -::: ### validators-builder-registration-default-enabled @@ -3371,6 +3315,64 @@ You can overwrite the file while Teku is running to update the graffiti. This option takes precedence over [`--validators-graffiti`](#validators-graffiti). +### validator-keys + + + + +```bash +--validator-keys=: | :[,: | :...]... +``` + + + + +```bash +--validator-keys=/home/validator/keys:home/validator/passwords +``` + + + + +```bash +--validator-keys=/home/validator/keys/validator_217179e.json:/home/validator/passwords/validator_217179e.txt +``` + + + + +```bash +TEKU_VALIDATOR_KEYS=/home/validator/keys:home/validator/passwords +``` + + + + +```bash +validator-keys: "/home/validator/keys:home/validator/passwords" +``` + + + + +Directory or file to load the encrypted keystore file(s) and associated password file(s) from. Keystore files must use the `.json` file extension, and password files must use the `.txt` file extension. + +When specifying directories, Teku expects to find identically named keystore and password files. For example `validator_217179e.json` and `validator_217179e.txt`. + +:::tip + +You can [load new validators without restarting Teku] if you specify a directory from which to load the keystore files. + +::: + +When specifying file names, Teku expects that the files exist. + +:::note + +The path separator is operating system dependent, and should be `;` in Windows rather than `:`. + +::: + ### validators-keystore-locking-enabled