validator-client
, vc
Run a validator client that connects to a remote beacon node.
beacon-node-api-endpoint
, beacon-node-api-endpoints
- Syntax
- Example
- Environment variable
- Configuration file
teku vc --beacon-node-api-endpoint=<ENDPOINT>[,<ENDPOINT>...]...
teku vc --beacon-node-api-endpoint=http://192.138.10.12:5051,http://192.140.11.44:5051
TEKU_BEACON_NODE_API_ENDPOINT=http://192.138.10.12,http://192.140.11.44:5051
beacon-node-api-endpoint: ["http://192.138.10.12","http://192.140.11.44:5051"]
Endpoint of the beacon node's REST API. You can configure multiple beacon nodes by providing a comma-separated list of beacon node API endpoints.
If multiple beacon node endpoints are configured, the first one is used as primary and others as failovers.
This option cannot be used with the sentry beacon nodes early access feature.
The default is http://127.0.0.1:5051
.
beacon-node-ssz-blocks-enabled
- Syntax
- Example
- Environment variable
- Configuration file
teku vc --beacon-node-ssz-blocks-enabled=<BOOLEAN>
teku vc --beacon-node-ssz-blocks-enabled=false
TEKU_BEACON_NODE_SSZ_BLOCKS_ENABLED=false
beacon-node-ssz-blocks-enabled: false
Enable or disable the use of SSZ encoding for API requests to the beacon node to create blocks. The default is true
.
config-file
- Syntax
- Example
- Environment variable
teku vc --config-file=<FILE>
teku vc --config-file=/home/me/me_node/config.yaml
TEKU_CONFIG_FILE=/home/me/me_node/config.yaml
Path to the YAML configuration file. The default is none
.
data-base-path
, data-path
- Syntax
- Example
- Environment variable
- Configuration file
teku vc --data-base-path=<PATH>
teku vc --data-base-path=/home/me/me_node
TEKU_DATA_BASE_PATH=/home/me/me_node
data-base-path: "/home/me/me_node"
Path to the Teku base directory for storage. The default directory is OS-dependent:
- macOS:
~/Library/teku
- Unix/Linux:
$XDG_DATA_HOME/teku
if$XDG_DATA_HOME
is set; otherwise~/.local/share/teku
- Windows:
%localappdata%\teku
.
The default Docker image location is /root/.local/share/teku
.
data-validator-path
- Syntax
- Example
- Environment variable
- Configuration file
teku vc --data-validator-path=<PATH>
teku vc --data-validator-path=/home/me/me_validator
TEKU_DATA_VALIDATOR_PATH=/home/me/me_validator
data-validator-path: "/home/me/me_validator"
Path to the validator client data. The default is <data-base-path>/validator
where <data-base-path>
is specified using --data-base-path
.
log-color-enabled
- Syntax
- Example
- Environment variable
- Configuration file
teku vc --log-color-enabled[=<BOOLEAN>]
teku vc --log-color-enabled=false
TEKU_LOG_COLOR_ENABLED=false
log-color-enabled: false
Specify whether status and event log messages include a console color display code. The default is true
.
log-destination
- Syntax
- Example
- Environment variable
- Configuration file
teku vc --log-destination=<LOG_DESTINATION>
teku vc --log-destination=CONSOLE
TEKU_LOG_DESTINATION=CONSOLE
log-destination: "CONSOLE"
Specify where to output log information. Valid options are:
BOTH
CONSOLE
DEFAULT_BOTH
FILE
The default is DEFAULT_BOTH
. When using BOTH
or DEFAULT_BOTH
, system updates such as blockchain events are displayed on the console, and errors and other information are logged to a file. Specify the log file with the --log-file
command-line option.
For production systems we recommend using the CONSOLE
or FILE
options to ensure all log information is available in one place.
Use DEFAULT_BOTH
when using a custom Log4J2 configuration file. Any other option applies the custom logging changes on top of its default settings.
log-file
- Syntax
- Example
- Environment variable
- Configuration file
teku vc --log-file=<FILENAME>
teku vc --log-file=teku_2020-01-01.log
TEKU_LOG_FILE=teku_2020-01-01.log
log-file: "teku_2020-01-01.log"
Relative or absolute location, and filename of the log file.
The default directory is OS-dependent:
- macOS:
~/Library/teku/logs
- Unix/Linux:
$XDG_DATA_HOME/teku/logs
if$XDG_DATA_HOME
is set; otherwise~/.local/share/teku/logs
- Windows:
%localappdata%\teku\logs
The default Docker image location is /root/.local/share/teku/logs
.
log-file-name-pattern
- Syntax
- Example
- Environment variable
- Configuration file
teku vc --log-file-name-pattern=<REGEX>
teku vc --log-file-name-pattern=tekuL_%d{yyyy-MM-dd}.log
TEKU_LOG_FILE_NAME_PATTERN=tekuL_%d{yyyy-MM-dd}.log
log-file-name-pattern: "tekuL_%d{yyyy-MM-dd}.log"
Filename pattern to apply when creating log files. The default pattern is teku_%d{yyyy-MM-dd}.log
log-include-events-enabled
- Syntax
- Example
- Environment variable
- Configuration file
teku vc --log-include-events-enabled[=<BOOLEAN>]
teku vc --log-include-events-enabled=false
TEKU_LOG_INCLUDE_EVENTS_ENABLED=false
log-include-events-enabled: false
Specify whether to log frequent update events. For example every slot event with validators and attestations. The default is true
.