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 --version-compatibility-protection #1526

Merged
Merged
Show file tree
Hide file tree
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
9 changes: 8 additions & 1 deletion docs/private-networks/how-to/backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:

# Backup and restore Besu

In a decentralized blockchain, data replicates between nodes so it's not lost. But backing up configuration and data ensures a smoother recovery from corrupted data or other failures.
In a decentralized blockchain, data replicates between nodes so it is not lost. But backing up configuration and data ensures a smoother recovery from corrupted data or other failures.

## Genesis file

Expand Down Expand Up @@ -42,6 +42,13 @@ If log messages signify a corrupt database, the cleanest way to recover is:
1. Restore the data from a [previous backup](#data-backups).
1. Restart the node.

## Prevent accidental downgrade

When restarting Besu, accidentally using an earlier version of Besu might risk corrupting your database.
To protect against incompatibility between versions, set the
[`--version-compatibility-protection`](../../public-networks/reference/cli/options.md#version-compatibility-protection)
option to `true`.

## Find peers after restarting

The process for finding peers after restarting is the same as for [finding peers after upgrading and restarting].
Expand Down
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 @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem';

# Private network API methods

:::warning
:::caution Important

- This reference contains API methods that apply to only private networks. For API methods that apply to both private and public networks, see the [public network API reference](../../../public-networks/reference/api/index.md).
- All JSON-RPC HTTP examples use the default host and port endpoint `http://127.0.0.1:8545`. If using the [--rpc-http-host](../../../public-networks/reference/cli/options.md#rpc-http-host) or [--rpc-http-port](../../../public-networks/reference/cli/options.md#rpc-http-port) options, update the endpoint.
Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/reference/api/objects.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:

The following objects are parameters for or returned by Besu private network API methods.

:::warning
:::caution Important

This reference contains API objects that apply to only private networks. For API objects that apply to both private and public networks, see the [public network API objects reference](../../../public-networks/reference/api/objects.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/reference/cli/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem';

This reference describes the syntax of the Hyperledger Besu private network command line interface (CLI) options.

:::danger
:::caution Important

This reference contains options that apply to only private networks. For options that apply to both private and public networks, see the [public network options reference](../../../public-networks/reference/cli/options.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/reference/cli/subcommands.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem';

This reference describes the syntax of the Hyperledger Besu private network command line interface (CLI) subcommands.

:::danger
:::caution Important

This reference contains subcommands that apply to only private networks. For subcommands that apply to both private and public networks, see the [public network subcommands reference](../../../public-networks/reference/cli/subcommands.md).

Expand Down
58 changes: 49 additions & 9 deletions docs/public-networks/reference/cli/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -5426,43 +5426,83 @@ content if the save and restore functionality is enabled using
The file is created on shutdown and reloaded during startup.
The default file name is `txpool.dump` in the [data directory](#data-path).

### `Xhelp`
### `version`

<Tabs>

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

```bash
-X, --Xhelp
-V, --version
```

</TabItem>

</Tabs>

Displays the early access options and their descriptions, and exit.
Prints version information and exits.

:::caution
### `version-compatibility-protection`

The displayed options are unstable and may change between releases.
<Tabs>
<TabItem value="Syntax">

:::
```bash
--version-compatibility-protection[=<true|false>]
```

### `version`
</TabItem>
<TabItem value="Example">

```bash
--version-compatibility-protection=true
```

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

```bash
BESU_VERSION_COMPATIBILITY_PROTECTION=true
```

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

```bash
version-compatibility-protection=true
```

</TabItem>
</Tabs>

Enables or disables performing version compatibility checks when starting Besu.
If set to `true`, it checks that the version of Besu being started is the same
or later than the version of Besu that previously started with the same data directory.

The default is `false` for named networks, such as Mainnet or Goerli, and `true`
for non-named networks.

### `Xhelp`

<Tabs>

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

```bash
-V, --version
-X, --Xhelp
```

</TabItem>

</Tabs>

Prints version information and exit.
Displays the early access options and their descriptions, and exits.

:::caution

The displayed options are unstable and may change between releases.

:::

<!-- Links -->

Expand Down
Loading