Skip to content

Commit

Permalink
OCTODSO-588: Update tabs in docs of version of 23.7.3
Browse files Browse the repository at this point in the history
Signed-off-by: Vijay <taraka.prabhu@consensys.net>
  • Loading branch information
Vijay committed Dec 20, 2023
1 parent 8909620 commit fcab7c5
Show file tree
Hide file tree
Showing 44 changed files with 4,789 additions and 3,543 deletions.
2 changes: 1 addition & 1 deletion docs/private-networks/reference/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2407,4 +2407,4 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"qbft_proposeValidatorVote","para
[permissions configuration file]: ../../how-to/use-permissioning/local.md#permissions-configuration-file
[group of sender and recipients]: ../../concepts/privacy/privacy-groups.md#enterprise-ethereum-alliance-privacy
\*[EEA]: Enterprise Ethereum Alliance
\*[EEA]: Enterprise Ethereum Alliance
2 changes: 1 addition & 1 deletion docs/private-networks/tutorials/ibft/validators.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,4 +136,4 @@ The list of validators contains 5 addresses now.

## Remove a validator

The process for removing a validator is similar to [adding a validator](#add-a-validator) starting from step 2, except you specify `false` as the second parameter of [`ibft_proposeValidatorVote`](../../../public-networks/reference/api/index.md#ibft_proposevalidatorvote).
The process for removing a validator is similar to [adding a validator](#add-a-validator) starting from step 2, except you specify `false` as the second parameter of [`ibft_proposeValidatorVote`](../../../public-networks/reference/api/index.md#ibft_proposevalidatorvote).
2 changes: 1 addition & 1 deletion docs/private-networks/tutorials/permissioning/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -531,4 +531,4 @@ To restart the permissioned network in the future, start from [step 7](#7-start-
<!-- Links -->

[IBFT 2.0 proof of authority consensus protocol]: ../../how-to/configure/consensus/ibft.md
[Private network example tutorial]: ../quickstart.md#create-a-transaction-using-metamask
[Private network example tutorial]: ../quickstart.md#create-a-transaction-using-metamask
2 changes: 1 addition & 1 deletion docs/public-networks/how-to/use-besu-api/authenticate.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,4 +300,4 @@ curl -X POST -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJw
</TabItem>
</Tabs>
</Tabs>
1 change: 0 additions & 1 deletion docs/public-networks/reference/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6969,4 +6969,3 @@ Your node must be an archive node (that is, synchronized without pruning or fast
#### Returns
`result`: _array_ of _objects_ - list of [calls to other contracts](../trace-types.md#trace) containing one object per call, in transaction execution order
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ tags:
- private networks
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Block proposal permissioning

:::info
Expand Down Expand Up @@ -56,235 +59,289 @@ In the command line:

### `Xpki-block-creation-crl-file`

<!--tabs-->
<Tabs>

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

```bash
--Xpki-block-creation-crl-file=<FILE>
```

# Example
</TabItem>

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

```bash
--Xpki-block-creation-crl-file=/home/cert/cert.crl.pem
```

# Environment variable
</TabItem>

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

```bash
BESU_XPKI_BLOCK_CREATION_CRL_FILE=/home/cert/cert.crl.pem
```

<!--/tabs-->
</TabItem>

</Tabs>

Path to the optional certificate revocation list (CRL) file.

### `Xpki-block-creation-enabled`

<!--tabs-->
<Tabs>

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

```bash
--Xpki-block-creation-enabled[=<true|false>]
```

# Example
</TabItem>

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

```bash
--Xpki-block-creation-enabled=true
```

# Environment variable
</TabItem>

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

```bash
BESU_XPKI_BLOCK_CREATION_ENABLED=true
```

<!--/tabs-->
</TabItem>

</Tabs>

Enable PKI integration. The default is `false`.

### `Xpki-block-creation-keystore-certificate-alias`

<!--tabs-->
<Tabs>

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

```bash
--Xpki-block-creation-keystore-certificate-alias=<NAME>
```

# Example
</TabItem>

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

```bash
--Xpki-block-creation-keystore-certificate-alias=validatorA
```

# Environment variable
</TabItem>

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

```bash
BESU_XPKI_BLOCK_CREATION_KEYSTORE_CERTIFICATE_ALIAS=validatorA
```

<!--/tabs-->
</TabItem>

</Tabs>

Alias of the certificate to be included in the blocks proposed by this validator. The default is `validator`.

### `Xpki-block-creation-keystore-file`

<!--tabs-->
<Tabs>

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

```bash
--Xpki-block-creation-keystore-file=<FILE>
```

# Example
</TabItem>

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

```bash
--Xpki-block-creation-keystore-file=/home/cert/keystore.jks
```

# Environment variable
</TabItem>

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

```bash
BESU_XPKI_BLOCK_CREATION_KEYSTORE_FILE=/home/cert/keystore.jks
```

<!--/tabs-->
</TabItem>

</Tabs>

Keystore file containing the key and certificate for PKI block creation.

### `Xpki-block-creation-keystore-password-file`

<!--tabs-->
<Tabs>

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

```bash
--Xpki-block-creation-keystore-password-file=<FILE>
```

# Example
</TabItem>

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

```bash
--Xpki-block-creation-keystore-password-file=/home/cert/password.txt
```

# Environment variable
</TabItem>

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

```bash
BESU_XPKI_BLOCK_CREATION_KEYSTORE_PASSWORD-FILE=/home/cert/password.txt
```

<!--/tabs-->
</TabItem>

</Tabs>

Text file containing the password to unlock the keystore file.

### `Xpki-block-creation-keystore-type`

<!--tabs-->
<Tabs>

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

```bash
--Xpki-block-creation-keystore-type=<TYPE>
```

# Example
</TabItem>

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

```bash
--Xpki-block-creation-keystore-type=JKS
```

# Environment variable
</TabItem>

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

```bash
BESU_XPKI_BLOCK_CREATION_KEYSTORE_TYPE=JKS
```

<!--/tabs-->
</TabItem>

</Tabs>

PKI keystore type. Valid options are `JKS` and `PKCS12`. The default is `JKS`.

### `Xpki-block-creation-truststore-file`

<!--tabs-->
<Tabs>

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

```bash
--Xpki-block-creation-truststore-file=<FILE>
```

# Example
</TabItem>

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

```bash
--Xpki-block-creation-truststore-file=/home/cert/truststore.jks
```

# Environment variable
</TabItem>

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

```bash
BESU_XPKI_BLOCK_CREATION_TRUSTSTORE_FILE=/home/cert/truststore.jks
```

<!--/tabs-->
</TabItem>

</Tabs>

Truststore containing the trusted certificates for PKI block creation.

### `Xpki-block-creation-truststore-password-file`

<!--tabs-->
<Tabs>

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

```bash
--Xpki-block-creation-truststore-password-file=<FILE>
```

# Example
</TabItem>

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

```bash
--Xpki-block-creation-truststore-password-file=/home/cert/password.txt
```

# Environment variable
</TabItem>

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

```bash
BESU_XPKI_BLOCK_CREATION_TRUSTSTORE_PASSWORD_FILE=/home/cert/password.txt
```

<!--/tabs-->
</TabItem>

</Tabs>

Text file containing the password to unlock the truststore file.

### `Xpki-block-creation-truststore-type`

<!--tabs-->
<Tabs>

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

```bash
--Xpki-block-creation-truststore-type=<TYPE>
```

# Example
</TabItem>

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

```bash
--Xpki-block-creation-truststore-type=JKS
```

# Environment variable
</TabItem>

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

```bash
BESU_XPKI_BLOCK_CREATION_TRUSTSTORE_TYPE=JKS
```

<!--/tabs-->
</TabItem>

</Tabs>

PKI truststore type. Valid options are `JKS` and `PKCS12`. The default is `JKS`.

Expand Down
Loading

0 comments on commit fcab7c5

Please sign in to comment.