Skip to content

Commit

Permalink
Document pruning DB connection CLI option (#145)
Browse files Browse the repository at this point in the history
Signed-off-by: Alexandra Tran <[email protected]>

Signed-off-by: Alexandra Tran <[email protected]>
  • Loading branch information
alexandratran authored Jan 10, 2023
1 parent 273a2e1 commit ac8cd07
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion docs/Reference/CLI/CLI-Subcommands.md
Original file line number Diff line number Diff line change
Expand Up @@ -809,7 +809,7 @@ The password to connect to the slashing protection database.
[HikariCP connection pool configuration file](https://github.com/brettwooldridge/HikariCP#gear-configuration-knobs-baby).

Web3Signer uses HikariCP to manage database connections, and uses the default configuration values. The defaults perform
well in most deployments, but you can be override them with this option.
well in most deployments, but you can override them using this option.

#### `slashing-protection-db-url`

Expand Down Expand Up @@ -934,6 +934,38 @@ is disabled at boot and only takes place at the scheduled [pruning intervals](#s

The default is `true`.

#### `slashing-protection-pruning-db-pool-configuration-file`

=== "Syntax"

```bash
--slashing-protection-pruning-db-pool-configuration-file=<FILE>
```

=== "Example"

```bash
--slashing-protection-pruning-db-pool-configuration-file=/Users/me/config/HikariConfig.properties
```

=== "Environment variable"

```bash
WEB3SIGNER_ETH2_SLASHING_PROTECTION_PRUNING_DB_POOL_CONFIGURATION_FILE=/Users/me/config/HikariConfig.properties
```

=== "Configuration file"

```bash
eth2.slashing-protection-pruning-db-pool-configuration-file: "/Users/me/config/HikariConfig.properties"
```

[HikariCP connection pool configuration file](https://github.com/brettwooldridge/HikariCP#gear-configuration-knobs-baby)
used by the pruning process.

Web3Signer uses HikariCP to manage database connections, and uses the default configuration values.
The defaults perform well in most deployments, but you can override them using this option.

#### `slashing-protection-pruning-enabled`

=== "Syntax"
Expand Down

0 comments on commit ac8cd07

Please sign in to comment.