Skip to content

Commit

Permalink
fixing broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuafernandes committed Nov 29, 2023
1 parent 711d8e2 commit 34c0291
Show file tree
Hide file tree
Showing 26 changed files with 391 additions and 408 deletions.
11 changes: 0 additions & 11 deletions .prettierrc

This file was deleted.

4 changes: 2 additions & 2 deletions docs/concepts/slashing-protection.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A slashing protection database records each block and attestation signed by a va

Slashing protection is enabled by default, and you are responsible for [creating and maintaining]
the required PostgreSQL database, or you can disable slashing protection by setting
[`--slashing-protection-enabled`](../reference/cli/subcommands.mdx#slashing-protection-enabled) to `false`.
[`--slashing-protection-enabled`](../reference/cli/subcommands.md#slashing-protection-enabled) to `false`.

:::info
Web3Signer only supports PostgreSQL for creating the slashing protection database.
Expand All @@ -26,4 +26,4 @@ instance actually signs.

<!--links-->

[creating and maintaining]: ../how-to/configure-slashing-protection.mdx
[creating and maintaining]: ../how-to/configure-slashing-protection.md
2 changes: 1 addition & 1 deletion docs/concepts/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ The server (in this example, [Hyperledger Besu](https://besu.hyperledger.org/))
to accept TLS connections.

Use the command line options to configure TLS on [HTTP JSON-RPC requests](../how-to/configure-tls.md)
and [HashiCorp Vault](../how-to/store-keys-vaults/hashicorp.mdx).
and [HashiCorp Vault](../how-to/store-keys-vaults/hashicorp.md).
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ bin/web3signer --help
```

</TabItem>
<TabItem value="Windows" label="Windows" default>
<TabItem value="Windows" label="Windows">

```bat
bin\web3signer --help
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ web3signer --key-store-path=/Users/me/keyFiles/ eth2 --slashing-protection-db-ur
```

</TabItem>
<TabItem value="Execution layer client" label="Execution layer client" default>
<TabItem value="Execution layer client" label="Execution layer client" >

```bash
web3signer --key-store-path=/Users/me/keyFiles/ eth1
```

</TabItem>
<TabItem value="Filecoin" label="Filecoin" default>
<TabItem value="Filecoin" label="Filecoin" >

```bash
web3signer --key-store-path=/Users/me/keyFiles/ filecoin
Expand All @@ -48,7 +48,7 @@ web3signer --key-store-path=/Users/me/keyFiles/ filecoin

In the command line:

- Use the [`--key-store-path`](../reference/cli/options.mdx#key-store-path) option to specify the
- Use the [`--key-store-path`](../reference/cli/options.md#key-store-path) option to specify the
location of the signing key configuration files.
- Specify the [subcommand] to indicate which signing mode to use.
Valid subcommands are `eth2`, `eth1`, and `filecoin`.
Expand All @@ -58,7 +58,7 @@ In the command line:

Consensus layer [slashing protection] is enabled by default, and you must specify the details the
[slashing protection database], or disable slashing protection using the
[`--slashing-protection-db-enabled`](../reference/cli/subcommands.mdx#slashing-protection-enabled)
[`--slashing-protection-db-enabled`](../reference/cli/subcommands.md#slashing-protection-enabled)
command line option.

:::note
Expand All @@ -69,7 +69,7 @@ Start the client, for example [Teku] by specifying the Web3Signer details.

:::important
If Teku connects to a network other than `mainnet`, then the
[`--network`](../reference/cli/subcommands.mdx#network) option must be specified, and it must match
[`--network`](../reference/cli/subcommands.md#network) option must be specified, and it must match
the network used by the Teku client.
:::

Expand All @@ -86,7 +86,7 @@ following example.
web3signer --key-store-path=/Users/me/keyFiles/ eth2 --network=goerli --slashing-protection-db-url="jdbc:postgresql://localhost/web3signer" --slashing-protection-db-username=postgres --slashing-protection-db-password=password
```

See the [`--network` documentation](../reference/cli/subcommands.mdx#network) for more information
See the [`--network` documentation](../reference/cli/subcommands.md#network) for more information
about this option and the supported networks.

## Confirm Web3Signer is running
Expand All @@ -102,7 +102,7 @@ curl -X GET http://localhost:9000/upcheck
```

</TabItem>
<TabItem value="Result" label="Result" default>
<TabItem value="Result" label="Result" >

```json
200 OK
Expand All @@ -111,14 +111,14 @@ curl -X GET http://localhost:9000/upcheck
</TabItem>
</Tabs>

Web3Signer by default also performs a health check on the [slashing protection
database](../how-to/configure-slashing-protection)
Web3Signer by default also performs a health check on the
[slashing protection database](../how-to/configure-slashing-protection.md)

<!-- Links -->

[Signing key configuration files]: ../how-to/use-signing-keys.mdx
[Signing key configuration files]: ../how-to/use-signing-keys.md
[Teku]: https://docs.teku.consensys.net/how-to/use-external-signer/use-web3signer
[subcommand]: ../reference/cli/subcommands.mdx
[bulk load signing keys]: ../how-to/use-signing-keys#bulk-load-keys
[subcommand]: ../reference/cli/subcommands.md
[bulk load signing keys]: ../how-to/use-signing-keys.md#bulk-load-keys
[slashing protection]: ../concepts/slashing-protection.md
[slashing protection database]: ../how-to/configure-slashing-protection
[slashing protection database]: ../how-to/configure-slashing-protection.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Web3Signer instances.
:::note
Consensus layer [slashing protection] is enabled by default.
You therefore must configure a slashing protection database, or disable slashing protection using
the [`--slashing-protection-enabled`](../reference/cli/subcommands.mdx#slashing-protection-enabled)
the [`--slashing-protection-enabled`](../reference/cli/subcommands.md#slashing-protection-enabled)
command line option.
:::

Expand Down Expand Up @@ -50,7 +50,7 @@ This allows you to [connect to the database] using the `jdbc:postgresql://localh
:::tip
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 the
[`slashing-protection-db-pool-configuration-file`](../reference/cli/subcommands.mdx#slashing-protection-db-pool-configuration-file)
[`slashing-protection-db-pool-configuration-file`](../reference/cli/subcommands.md#slashing-protection-db-pool-configuration-file)
option.
:::

Expand All @@ -77,7 +77,7 @@ Use the [Flyway] migration tool to automatically load them in order.
flyway migrate -url="jdbc:postgresql://localhost/web3signer" -locations="filesystem:/Users/me/web3signer-0.2.1-SNAPSHOT/migrations/postgresql"
```
</TabItem>
<TabItem value="Postgres command line" label="Postgres command line" default>
<TabItem value="Postgres command line" label="Postgres command line" >

```bash
psql --echo-all --host=localhost --port=5432 --dbname=web3signer --username=postgres -f /Users/me/web3signer-0.2.1-SNAPSHOT/migrations/postgresql/postgresql/V1__initial.sql
Expand All @@ -104,7 +104,7 @@ the database URL].
:::

Including
[`--slashing-protection-pruning-enabled=true`](../reference/cli/subcommands.mdx#slashing-protection-pruning-enabled)
[`--slashing-protection-pruning-enabled=true`](../reference/cli/subcommands.md#slashing-protection-pruning-enabled)
enables [slashing protection database pruning].

Start the client, for example [Teku] by specifying the Web3Signer details.
Expand All @@ -115,8 +115,8 @@ You can import or export the slashing protection database.
When importing, additional entries are added to the existing database.

Web3Signer supports importing or exporting using the [validator client interchange format].
Use the [`eth2 import`](../reference/cli/subcommands.mdx#eth2-import) and
[`eth2 export`](../reference/cli/subcommands.mdx#eth2-export) to import or export files.
Use the [`eth2 import`](../reference/cli/subcommands.md#eth2-import) and
[`eth2 export`](../reference/cli/subcommands.md#eth2-export) to import or export files.

To import a slashing protection database file into the Postgres database, run:

Expand All @@ -138,12 +138,12 @@ protection database.
You can enable periodic pruning of the slashing protection database to manage its size.

Enable pruning by setting
[`--slashing-protection-pruning-enabled`](../reference/cli/subcommands.mdx#slashing-protection-pruning-enabled)
[`--slashing-protection-pruning-enabled`](../reference/cli/subcommands.md#slashing-protection-pruning-enabled)
to `true`.

Web3Signer can prune the database on startup, and then after each pruning interval.
By default, this feature is disabled. You can enable pruning at startup and start pruning after the pruning interval by setting
[`--slashing-protection-pruning-at-boot-enabled`](../reference/cli/subcommands.mdx#slashing-protection-pruning-at-boot-enabled)
[`--slashing-protection-pruning-at-boot-enabled`](../reference/cli/subcommands.md#slashing-protection-pruning-at-boot-enabled)
to `true`.

You can include additional optional pruning configuration options.
Expand All @@ -162,13 +162,13 @@ database](#import-or-export-a-slashing-protection-database).

By default, Web3Signer performs a health check on the slashing protection database every 30000 milliseconds.
To change the default value, configure the
[`--slashing-protection-db-health-check-interval-milliseconds`](../reference/cli/subcommands.mdx#slashing-protection-db-health-check-interval-milliseconds)
[`--slashing-protection-db-health-check-interval-milliseconds`](../reference/cli/subcommands.md#slashing-protection-db-health-check-interval-milliseconds)
command line option.

The service responds with a `200` message if healthy, and `503` if unhealthy.

You can also configure the health check timeout with the
[`--slashing-protection-db-health-check-timeout-milliseconds`](../reference/cli/subcommands.mdx#slashing-protection-db-health-check-timeout-milliseconds)
[`--slashing-protection-db-health-check-timeout-milliseconds`](../reference/cli/subcommands.md#slashing-protection-db-health-check-timeout-milliseconds)
command line option.
The default timeout is 3000 milliseconds.

Expand Down
32 changes: 16 additions & 16 deletions docs/how-to/configure-tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,22 +70,22 @@ web3signer --key-store-path=/Users/me/keyFiles/ \
The command line:

- Specifies the location of the signing key configuration files using the
[`--key-store-path`](../reference/cli/options.mdx#key-store-path) option.
[`--key-store-path`](../reference/cli/options.md#key-store-path) option.
- Specifies the Web3Signer keystore using the
[`--tls-keystore-file`](../reference/cli/options.mdx#tls-keystore-file) option.
[`--tls-keystore-file`](../reference/cli/options.md#tls-keystore-file) option.
- Specifies the file that contains the password to decrypt the keystore using the
[`--tls-keystore-password-file`](../reference/cli/options.mdx#tls-keystore-password-file) option.
[`--tls-keystore-password-file`](../reference/cli/options.md#tls-keystore-password-file) option.
- [Specifies the clients](#create-the-known-clients-file) that are trusted to connect to Web3Signer
using the [`tls-known-clients-file`](../reference/cli/options.mdx#tls-known-clients-file) option.
using the [`tls-known-clients-file`](../reference/cli/options.md#tls-known-clients-file) option.

:::note
Use the [`--tls-allow-any-client`](../reference/cli/options.mdx#tls-allow-any-client) option to allow
access to any client, or [`--tls-allow-ca-clients`](../reference/cli/options.mdx#tls-allow-ca-clients)
Use the [`--tls-allow-any-client`](../reference/cli/options.md#tls-allow-any-client) option to allow
access to any client, or [`--tls-allow-ca-clients`](../reference/cli/options.md#tls-allow-ca-clients)
to allow access to any client with a trusted CA certificate.

You can't use [`--tls-allow-any-client`](../reference/cli/options.mdx#tls-allow-any-client) with
[`tls-known-clients-file`](../reference/cli/options.mdx#tls-known-clients-file) or
[`--tls-allow-ca-clients`](../reference/cli/options.mdx#tls-allow-ca-clients).
You can't use [`--tls-allow-any-client`](../reference/cli/options.md#tls-allow-any-client) with
[`tls-known-clients-file`](../reference/cli/options.md#tls-known-clients-file) or
[`--tls-allow-ca-clients`](../reference/cli/options.md#tls-allow-ca-clients).
:::

## Server TLS connection
Expand Down Expand Up @@ -128,22 +128,22 @@ web3signer eth1 --downstream-http-tls-enabled --downstream-http-tls-keystore-fil
The command line:

- Enables TLS using the
[`--downstream-http-tls-enabled`](../reference/cli/subcommands.mdx#downstream-http-tls-enabled) option.
[`--downstream-http-tls-enabled`](../reference/cli/subcommands.md#downstream-http-tls-enabled) option.
- Specifies the keystore to present during authentication using the
[`--downstream-http-tls-keystore-file`](../reference/cli/subcommands.mdx#downstream-http-tls-keystore-file) option.
[`--downstream-http-tls-keystore-file`](../reference/cli/subcommands.md#downstream-http-tls-keystore-file) option.
- Specifies the file that contains the password to decrypt the keystore using the
[`--downstream-http-tls-keystore-password-file`](../reference/cli/subcommands.mdx#downstream-http-tls-keystore-password-file) option.
[`--downstream-http-tls-keystore-password-file`](../reference/cli/subcommands.md#downstream-http-tls-keystore-password-file) option.
- [Specifies the servers](#create-the-known-servers-file) to connect to using the
[`--downstream-http-tls-known-servers-file`](../reference/cli/subcommands.mdx#downstream-http-tls-known-servers-file) option.
[`--downstream-http-tls-known-servers-file`](../reference/cli/subcommands.md#downstream-http-tls-known-servers-file) option.

:::note
The [`--downstream-http-tls-ca-auth-enabled`](../reference/cli/subcommands.mdx#downstream-http-tls-ca-auth-enabled)
The [`--downstream-http-tls-ca-auth-enabled`](../reference/cli/subcommands.md#downstream-http-tls-ca-auth-enabled)
option is `true` by default and allows connections to servers with trusted root CAs.
:::

<!-- links -->

[Allow all clients with trusted CA certificates to connect]: ../reference/cli/options.mdx#tls-allow-ca-clients
[Allow any client to connect]: ../reference/cli/options.mdx#tls-allow-any-client
[Allow all clients with trusted CA certificates to connect]: ../reference/cli/options.md#tls-allow-ca-clients
[Allow any client to connect]: ../reference/cli/options.md#tls-allow-any-client
[Teku]: https://docs.teku.consensys.net/
[Teku tutorial]: https://docs.teku.consensys.net/tutorials/configure-external-signer-tls
4 changes: 2 additions & 2 deletions docs/how-to/monitor/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Web3Signer provides two methods to configure logging:

## Basic log level setting

Use the [`--logging`](../../reference/cli/options.mdx#logging) command line option to specify logging verbosity.
The [`--logging`](../../reference/cli/options.mdx#logging) option changes the volume of events
Use the [`--logging`](../../reference/cli/options.md#logging) command line option to specify logging verbosity.
The [`--logging`](../../reference/cli/options.md#logging) option changes the volume of events
displayed in the log.
Valid log levels are `OFF`, `FATAL`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`, `ALL`.
The default level is `INFO`.
Expand Down
8 changes: 4 additions & 4 deletions docs/how-to/monitor/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 1
# Use metrics to monitor performance

Enable the [Prometheus](https://prometheus.io/) monitoring and alerting service for Web3Signer
metrics using the [`--metrics-enabled`](../../reference/cli/options.mdx#metrics-enabled) option.
metrics using the [`--metrics-enabled`](../../reference/cli/options.md#metrics-enabled) option.

Web3Signer provides metrics for secp256k1 and BLS12-381 key types.

Expand Down Expand Up @@ -44,14 +44,14 @@ To configure Prometheus and run with Web3Signer:
2. [Start Teku] by specifying the Web3Signer details.
3. Start Web3Signer with the [`--metrics-enabled`](../../reference/cli/options.mdx#metrics-enabled) option.
3. Start Web3Signer with the [`--metrics-enabled`](../../reference/cli/options.md#metrics-enabled) option.

```bash
web3signer --key-store-path=/Users/me/keyFiles/ --metrics-enabled
```

The `HTTP`, `SIGNING`, `JVM`, and `PROCESS` metrics categories are enabled by default.
Use the [`--metrics-category`](../../reference/cli/options.mdx#metrics-category) command line
Use the [`--metrics-category`](../../reference/cli/options.md#metrics-category) command line
option to update the available categories.

4. In another terminal, run Prometheus specifying the `prometheus.yml` file:
Expand Down Expand Up @@ -115,5 +115,5 @@ dashboard](https://grafana.com/grafana/dashboards/13687).
<!-- Links -->

[Start Teku]: https://docs.teku.consensys.net/how-to/use-external-signer/use-web3signer
[BLS signing keys]: ../use-signing-keys.mdx
[BLS signing keys]: ../use-signing-keys.md
[Grafana]: https://grafana.com/docs/grafana/latest/guides/getting_started/
4 changes: 2 additions & 2 deletions docs/how-to/store-keys-hsm/usb-armory.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,5 @@ Alternatively you can manually create the file and add the certificate details i

[USB Armory Mk II device]: https://www.f-secure.com/en/consulting/foundry/usb-armory
[Interlock application]: https://github.com/f-secure-foundry/interlock/blob/master/README.md
[Configure a signing key configuration file]: ../use-signing-keys.mdx
[key configuration file]: ../../reference/key-config-file-params#usb-armory-mk-ii
[Configure a signing key configuration file]: ../use-signing-keys.md
[key configuration file]: ../../reference/key-config-file-params.md#usb-armory-mk-ii
4 changes: 2 additions & 2 deletions docs/how-to/store-keys-hsm/yubihsm2.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ password must be specified in the [key configuration files] for a given device.
[Store private keys in the device]: https://developers.yubico.com/YubiHSM2/Commands/Put_Opaque.html
[YubiHSM 2 SDK]: https://developers.yubico.com/YubiHSM2/Releases/
[Opaque Data algorithm]: https://developers.yubico.com/YubiHSM2/Concepts/Algorithms.html
[Configure a signing key configuration file]: ../use-signing-keys.mdx
[Configure a signing key configuration file]: ../use-signing-keys.md
[YubiHSM connector]: https://developers.yubico.com/yubihsm-connector/
[PKCS#11 module]: https://developers.yubico.com/YubiHSM2/Component_Reference/PKCS_11/
[key configuration files]: ../../reference/key-config-file-params#yubihsm-2
[key configuration files]: ../../reference/key-config-file-params.md#yubihsm-2
7 changes: 3 additions & 4 deletions docs/how-to/store-keys-vaults/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ secretsManagerClient.createSecret(secretRequest);
```

You can also store multiple BLS private keys under same secret name when using
[AWS bulk loading mode](../use-signing-keys#aws-secrets-manager).
[AWS bulk loading mode](../use-signing-keys.md#aws-secrets-manager).

The keys must be separated with a line terminating character such as `\n`.
This saves cost when dealing with a large number of keys. Up to 200 keys can be stored under same
Expand All @@ -59,8 +59,7 @@ final CreateSecretRequest secretRequest =
secretsManagerClient.createSecret(secretRequest);
```

Specify the following when [configuring the signing key configuration
file](../use-signing-keys#use-key-configuration-files):
Specify the following when [configuring the signing key configuration file](../use-signing-keys.md#use-key-configuration-files):

- Authentication mode.
Valid options are `ENVIRONMENT` and `SPECIFIED`.
Expand All @@ -75,6 +74,6 @@ When loading multiple keys from AWS Secrets Manager, the AWS client is created e
You can improve performance by caching and reusing the same AWS Secrets Manager for each key that
uses the same access key ID and region.

Set the [`eth2 --aws-connection-cache-size`](../../reference/cli/subcommands.mdx#aws-connection-cache-size)
Set the [`eth2 --aws-connection-cache-size`](../../reference/cli/subcommands.md#aws-connection-cache-size)
option to the maximum number of AWS Secrets Manager connections to cache.
The default is 1.
4 changes: 2 additions & 2 deletions docs/how-to/store-keys-vaults/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ Depending on the authentication mode, not all client credentials are available.

<!-- links -->

[configuring the signing key configuration file]: ../use-signing-keys#azure-key-vault
[bulk loading signing keys]: ../use-signing-keys#bulk-load-keys
[configuring the signing key configuration file]: ../use-signing-keys.md#azure-key-vault
[bulk loading signing keys]: ../use-signing-keys.md#bulk-load-keys
[Register Web3Signer as an application]: https://docs.microsoft.com/en-us/azure/key-vault/general/authentication
[add a signing key in Azure Key Vault]: https://docs.microsoft.com/en-us/azure/key-vault/secrets/quick-create-portal#add-a-secret-to-key-vault
[Client secret]: https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets
Expand Down
Loading

0 comments on commit 34c0291

Please sign in to comment.