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 Commit-Boost options #301

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from 2 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
122 changes: 122 additions & 0 deletions docs/reference/cli/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,46 @@ WEB3SIGNER_CONFIG_FILE=/home/me/me_node/config.yaml
</TabItem>
</Tabs>

### `commit-boost-api-enabled`

<Tabs>
<TabItem value="Syntax" label="Syntax" default>

```bash
--commit-boost-api-enabled[=<BOOLEAN>]
```

</TabItem>
<TabItem value="Example" label="Example">

```bash
--commit-boost-api-enabled=true
```

</TabItem>
<TabItem value="Environment variable" label="Environment variable">

```bash
TEKU_COMMIT_BOOST_API_ENABLED=true
```

</TabItem>
<TabItem value="Configuration file" label="Configuration file">

```bash
commit-boost-api-enabled: true
```

</TabItem>
</Tabs>

Enables or disables the [Commit-Boost API](https://commit-boost.github.io/commit-boost-client/api).
The default is `false`.

You can specify proxy keystores for Commit-Boost using
[`--proxy-keystores-path`](#proxy-keystores-path) and
[`--proxy-keystores-password-file`](#proxy-keystores-password-file).

### `data-path`

<Tabs>
Expand Down Expand Up @@ -785,6 +825,88 @@ metrics-push-prometheus-job="my-custom-job"

The job name when in `push` mode. The default is `web3signer-job`.

### `proxy-keystores-password-file`

<Tabs>
<TabItem value="Syntax" label="Syntax" default>

```bash
--proxy-keystores-password-file=<FILE>
```

</TabItem>
<TabItem value="Example" label="Example">

```bash
--proxy-keystores-password-file=password.txt
```

</TabItem>
<TabItem value="Environment variable" label="Environment variable">

```bash
TEKU_PROXY_KEYSTORES_PASSWORD_FILE=password.txt
```

</TabItem>
<TabItem value="Configuration file" label="Configuration file">

```bash
proxy-keystores-password-file: "password.txt"
```

</TabItem>
</Tabs>

The path to the password file used to encrypt or decrypt the proxy keystores
specified by [`--proxy-keystores-path`](#proxy-keystores-path),
when using the [Commit-Boost API](https://commit-boost.github.io/commit-boost-client/api).

[`--commit-boost-api-enabled`](#commit-boost-api-enabled) must be set
to `true`.

### `proxy-keystores-path`

<Tabs>
<TabItem value="Syntax" label="Syntax" default>

```bash
--proxy-keystores-path=<PATH>
```

</TabItem>
<TabItem value="Example" label="Example">

```bash
--proxy-keystores-path=/home/me/proxy-keystores
```

</TabItem>
<TabItem value="Environment variable" label="Environment variable">

```bash
TEKU_PROXY_KEYSTORES_PATH=/home/me/proxy-keystores
```

</TabItem>
<TabItem value="Configuration file" label="Configuration file">

```bash
proxy-keystores-path: "/home/me/proxy-keystores"
```

</TabItem>
</Tabs>

The path to a writeable directory to store v3 and v4 proxy keystores
when using the [Commit-Boost API](https://commit-boost.github.io/commit-boost-client/api).

[`--commit-boost-api-enabled`](#commit-boost-api-enabled) must be set
to `true`.

Specify a password file for the proxy keystores using
[`--proxy-keystores-password-file`](#proxy-keystores-password-file).

### `swagger-ui-enabled`

<Tabs>
Expand Down
Loading