Skip to content

Commit

Permalink
update archive mode docs for 23.x
Browse files Browse the repository at this point in the history
  • Loading branch information
ptrus committed Jan 23, 2024
1 parent 762e21f commit 97ee31a
Showing 1 changed file with 13 additions and 16 deletions.
29 changes: 13 additions & 16 deletions docs/node/run-your-node/archive-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,6 @@ description: This page describes how to run an archive node on the Oasis Network

# Archive Node

:::info

Archive node support is currently only available in the [21.3.14](
https://github.com/oasisprotocol/oasis-core/releases/tag/v21.3.14) release for
use with the Cobalt (pre Damask upgrade) archived state.

:::

This guide will cover setting up an archive node for the Oasis Network. Node
started in archive mode only serves existing consensus and runtime states.
The node has all unneeded consensus and P2P functionality disabled, therefore
Expand All @@ -24,19 +16,17 @@ Archive node requires a pre-existing oasis-node state.

## Configuration

Archive mode can be enabled by using the `consensus.tendermint.mode` setting.
Archive mode can be enabled by using the `mode` setting.

:::info

This will configure the given node to act as a consensus archive node.
This will configure the given node to act as an archive node.

:::

```yaml
# other settings omitted ...
consensus:
tendermint:
mode: archive
mode: archive
```
:::info
Expand All @@ -57,6 +47,13 @@ oasis-node --config /node/etc/config.yml

### Archive node status

:::info

The mode field is currently unavailable in the control status output. It will
be included in an upcoming release.

:::

To ensure the node is running in archive mode, run the following command:

```bash
Expand All @@ -68,9 +65,9 @@ Output should report `archive` consensus mode status:
```json
{
// other fields omitted ...
"consensus": {
"mode": "archive",
// ...
"mode": "archive",
// ...
}
```

## See also
Expand Down

0 comments on commit 97ee31a

Please sign in to comment.