Skip to content
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.

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

Document pruning DB connection CLI option #145

Merged
merged 1 commit into from
Jan 10, 2023
Merged
Changes from all commits
Commits
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
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