Skip to content

Commit

Permalink
Revise Running Nethermind instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
rubo committed Oct 31, 2023
1 parent 03d9e69 commit 1525303
Show file tree
Hide file tree
Showing 7 changed files with 46 additions and 51 deletions.
2 changes: 1 addition & 1 deletion docs/developers/building-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ configuration only.
The build artifacts can be found in the `bin/release/net7.0` directory. By default, the logs and database directories
are located here as well.

For more info, see [Running Nethermind](../fundamentals/running-nethermind.md).
For more info about launching Nethermind, see the [Launching](../get-started/installing-nethermind.md#launching) section.

#### Testing

Expand Down
2 changes: 1 addition & 1 deletion docs/fundamentals/private-networks.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Private networks
description: Use Kurtosis to deploy a private Ethereum devnet with Nethermind and any consensus client at any scale you need, wherever you need it.
sidebar_position: 8
sidebar_position: 7
---

This guide will walk you through using [Kurtosis `ethereum-package`](https://github.com/kurtosis-tech/ethereum-package) to spin up a private, proof-of-stake (PoS) Ethereum devnet with three full Ethereum nodes locally over Docker. At the end of the guide, you will learn how to scale up your testnet on Kubernetes as well as enable optional services for your local testnet, such as network observability tools (e.g., Grafana, Prometheus) and Flashbot's `mev-boost` infrastructure to simulate MEV workflows.
Expand Down
2 changes: 1 addition & 1 deletion docs/fundamentals/pruning.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Pruning
sidebar_position: 5
sidebar_position: 6
---

## Overview
Expand Down
38 changes: 0 additions & 38 deletions docs/fundamentals/running-nethermind.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/get-started/consensus-clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ nethermind \
--JsonRpc.JwtSecretFile path/to/jwt.hex
```

The command above runs Nethermind on Mainnet. For other networks, set the `-c` option accordingly. For more info, see [Running Nethermind](../fundamentals/running-nethermind.md).
The command above runs Nethermind on Mainnet. For other networks, set the `-c` option accordingly. For more info, see [Running Nethermind](../get-started/installing-nethermind.md#running).

[checkpoint-sync-endpoints]: https://eth-clients.github.io/checkpoint-sync-endpoints
[lighthouse]: https://lighthouse-book.sigmaprime.io
Expand Down
45 changes: 39 additions & 6 deletions docs/get-started/installing-nethermind.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ brew install nethermind
</TabItem>
</Tabs>

For further instructions, see [Running Nethermind](../fundamentals/running-nethermind.md).
For further instructions, see [Running Nethermind](#running).

## Standalone downloads

Expand Down Expand Up @@ -193,7 +193,7 @@ To monitor the Nethermind output, run:
journalctl -u nethermind -f
```
For further instructions, see [Running Nethermind](../fundamentals/running-nethermind).
For further instructions, see [Running Nethermind](#running).
## Docker container
Expand Down Expand Up @@ -250,9 +250,42 @@ docker run -it \
nethermind/nethermind -dd /nethermind/data_dir
```
Note that any Nethermind-specific configuration option can be specified at the end. For instance, the `-dd` option in this case.
Note that any Nethermind-specific configuration option can be specified at the end. For instance, the `-dd` option in this case. For further instructions, see [Running Nethermind](#running).
#### See also
To build the Docker image yourself, see [Building Docker image](../developers/building-from-source.md#bulding-docker-image).
- [Configuration options](../fundamentals/configuration.md)
- [Building Docker image](../developers/building-from-source.md#bulding-docker-image)
## Running Nethermind {#running}
:::caution Important
A [consensus client](consensus-clients.md) of your choice must be running before you start Nethermind.
:::
Nethermind is mainly controlled by command line options (aka arguments or flags).
The full list of options can be displayed by running:
```bash
nethermind -h
```
For instance, to launch the client with the default configuration for the Mainnet and custom data directory, run:
```bash
nethermind -c mainnet -dd path/to/data/dir
```
For detailed info about the available configuration options, see [Configuration](./configuration.md).
### Supported networks
To run Nethermind on a specific network, use the [`-c, --config`](./configuration.md#basic-options) command line option. Currently, the following networks are supported out of the box:
- **Chiado** (testnet)
- **Energy Web**
- **Exosama**
- **Goerli** (testnet)
- **Gnosis**
- **Holesky** (testnet)
- **Mainnet**
- **Sepolia** (testnet)
- **Volta** (testnet)
6 changes: 3 additions & 3 deletions docs/validators/aura-validator.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 1

This article will lead you through docker-compose setup of **Nethermind Aura Validator** (xDai chain in this example).
Same result can be obtained
by [Downloading](../get-started/installing-nethermind.md) & [Running Nethermind](../fundamentals/running-nethermind.md)
by [Downloading](../get-started/installing-nethermind.md) & [Running Nethermind](../get-started/installing-nethermind.md#running)
package or by [Building Nethermind](../developers/building-from-source.md) from the source code.&#x20;

If you chose not to use docker-compose, you can skip docker-compose related sections and read
Expand Down Expand Up @@ -105,8 +105,8 @@ container (`xdai.cfg` file in above example).
Make sure that `nethermind_db`, `keystore`(`logs` - optional ) are mapped, otherwise you might lose database or keys
:::

[`NLog.config`](../fundamentals/running-nethermind.md) file is optional.\
[`static-nodes.json`](../fundamentals/running-nethermind.md) can be filled with an
[`NLog.config`](../get-started/installing-nethermind.md#running) file is optional.\
[`static-nodes.json`](../get-started/installing-nethermind.md#running) can be filled with an
array
of enodes, this is also optional.

Expand Down

0 comments on commit 1525303

Please sign in to comment.