Skip to content

Auto-update docs #329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
core-repository-dispatch-app wants to merge 1 commit into from
Closed

Auto-update docs #329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 142 additions & 4 deletions docs/fundamentals/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1522,7 +1522,7 @@ The configuration options are case-sensitive and can be defined only once unless
</TabItem>
</Tabs>

An escaped JSON paylod to be sent to the web hook on failure.
An escaped JSON payload to be sent to the web hook on failure.
Defaults to:

```json
Expand Down Expand Up @@ -1574,7 +1574,7 @@ The configuration options are case-sensitive and can be defined only once unless
</TabItem>
</Tabs>

An escaped JSON paylod to be sent to the web hook on recovery.
An escaped JSON payload to be sent to the web hook on recovery.
Defaults to:

```json
Expand Down Expand Up @@ -4295,6 +4295,33 @@ The configuration options are case-sensitive and can be defined only once unless

Whether to publish metrics using .NET diagnostics that can be collected with dotnet-counters. Allowed values: `true` `false`. Defaults to `false`.

- #### `Metrics.DbMetricIntervalSeconds` \{#metrics-dbmetricintervalseconds\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--metrics-dbmetricintervalseconds <value>
--Metrics.DbMetricIntervalSeconds <value>
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_METRICSCONFIG_DBMETRICINTERVALSECONDS=<value>
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"Metrics": {
"DbMetricIntervalSeconds": <value>
}
}
```
</TabItem>
</Tabs>

The frequency of updating db metrics, in seconds. Defaults to `60`.

- #### `Metrics.EnableDbSizeMetrics` \{#metrics-enabledbsizemetrics\}

<Tabs groupId="usage">
Expand Down Expand Up @@ -4538,6 +4565,33 @@ The configuration options are case-sensitive and can be defined only once unless

The name to display on the Grafana dashboard. Defaults to `Nethermind`.

- #### `Metrics.PauseDbMetricDuringBlockProcessing` \{#metrics-pausedbmetricduringblockprocessing\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--metrics-pausedbmetricduringblockprocessing [true|false]
--Metrics.PauseDbMetricDuringBlockProcessing [true|false]
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_METRICSCONFIG_PAUSEDBMETRICDURINGBLOCKPROCESSING=true|false
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"Metrics": {
"PauseDbMetricDuringBlockProcessing": true|false
}
}
```
</TabItem>
</Tabs>

Pause db metric collection during block processing to prevent overhead. Allowed values: `true` `false`. Defaults to `true`.

- #### `Metrics.PushGatewayUrl` \{#metrics-pushgatewayurl\}

<Tabs groupId="usage">
Expand Down Expand Up @@ -5115,7 +5169,7 @@ The configuration options are case-sensitive and can be defined only once unless
</TabItem>
</Tabs>

The in-memory cache size, in MB. Bigger size tend to improve performance. Defaults to `1280`.
The in-memory cache size, in MB. Bigger size tend to improve performance. Defaults to `1792`.

- #### `Pruning.DirtyCacheMb` \{#pruning-dirtycachemb\}

Expand All @@ -5142,7 +5196,7 @@ The configuration options are case-sensitive and can be defined only once unless
</TabItem>
</Tabs>

The in-memory cache size for dirty nodes, in MB. Increasing this reduces pruning interval but cause increased pruning time. Defaults to `1024`.
The in-memory cache size for dirty nodes, in MB. Increasing this reduces pruning interval but cause increased pruning time. Defaults to `1536`.

- #### `Pruning.DirtyNodeShardBit` \{#pruning-dirtynodeshardbit\}

Expand Down Expand Up @@ -6627,6 +6681,90 @@ The configuration options are case-sensitive and can be defined only once unless

The address of the TaikoInbox contract. Defaults to `null`.

- #### `Surge.TdxEnabled` \{#surge-tdxenabled\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--surge-tdxenabled [true|false]
--Surge.TdxEnabled [true|false]
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_SURGECONFIG_TDXENABLED=true|false
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"Surge": {
"TdxEnabled": true|false
}
}
```
</TabItem>
</Tabs>

Enable TDX attestation support. Allowed values: `true` `false`. Defaults to `false`.


### SurgeTdx

- #### `SurgeTdx.ConfigPath` \{#surgetdx-configpath\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--surgetdx-configpath <value>
--SurgeTdx.ConfigPath <value>
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_SURGETDXCONFIG_CONFIGPATH=<value>
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"SurgeTdx": {
"ConfigPath": <value>
}
}
```
</TabItem>
</Tabs>

Path to store TDX bootstrap data and keys. Defaults to `~/.config/nethermind/tdx`.

- #### `SurgeTdx.SocketPath` \{#surgetdx-socketpath\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--surgetdx-socketpath <value>
--SurgeTdx.SocketPath <value>
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_SURGETDXCONFIG_SOCKETPATH=<value>
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"SurgeTdx": {
"SocketPath": <value>
}
}
```
</TabItem>
</Tabs>

Path to the tdxs Unix socket. Defaults to `/var/tdxs.sock`.


### Sync

Expand Down
Loading