Skip to content

Commit

Permalink
Make some instructions OS-agnostic
Browse files Browse the repository at this point in the history
  • Loading branch information
rubo committed Oct 25, 2023
1 parent bbf2d74 commit d9ee07e
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 52 deletions.
18 changes: 1 addition & 17 deletions docs/fundamentals/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ sidebar_position: 1
toc_max_heading_level: 4
---

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

Nethermind is highly configurable. There are 3 ways of configuring it, listed by priority:

- [Command line options](#command-line-options) (aka arguments or flags)
Expand All @@ -21,23 +18,10 @@ Given the above priority list, an option defined in a more priority way override

The full list of command line options can be displayed by running:

<Tabs groupId="os">
<TabItem value="linux-macos" label="Linux / macOS">

```bash
./nethermind -h
```

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

```powershell
./nethermind.exe -h
nethermind -h
```

</TabItem>
</Tabs>

Below is the list of the basic options followed by an exhaustive list of options by namespace.

:::caution
Expand Down
33 changes: 2 additions & 31 deletions docs/fundamentals/running-nethermind.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: Running Nethermind
sidebar_position: 0
---

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

:::info
To get the latest Nethermind version, see [Installing Nethermind](../get-started/installing-nethermind.md).
:::
Expand All @@ -14,42 +11,16 @@ Nethermind is mainly controlled by command line options (aka arguments or flags)

The full list of options can be displayed by running:

<Tabs groupId="os">
<TabItem value="linux-macos" label="Linux / macOS">

```bash
./nethermind -h
```

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

```powershell
./nethermind.exe -h
nethermind -h
```

</TabItem>
</Tabs>

For instance, to launch the client with the default configuration for the Mainnet and custom data directory, run:

<Tabs groupId="os">
<TabItem value="linux-macos" label="Linux / macOS">

```bash
./nethermind -c mainnet -dd path/to/data/dir
nethermind -c mainnet -dd path/to/data/dir
```

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

```powershell
./nethermind.exe -c mainnet -dd path/to/data/dir
```

</TabItem>
</Tabs>

For detailed info about the available configuration options, see [Configuration](./configuration.md).

## Supported networks
Expand Down
8 changes: 4 additions & 4 deletions docs/get-started/consensus-clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ As syncing from the scratch can take a very long time on some networks (up to se
### Running Lighthouse

```bash
./lighthouse bn \
lighthouse bn \
--network mainnet \
--execution-endpoint http://localhost:8551 \
--execution-jwt path/to/jwt.hex \
Expand All @@ -61,7 +61,7 @@ The command above runs Lighthouse on Mainnet. For other networks, set the `--net
### Running Lodestar

```bash
./lodestar beacon \
lodestar beacon \
--network mainnet \
--jwt-secret path/to/jwt.hex \
--checkpointSyncUrl https://beaconstate-mainnet.chainsafe.io
Expand Down Expand Up @@ -95,7 +95,7 @@ The command above runs Prysm on Mainnet. For other networks, replace the `--main
### Running Teku

```bash
./teku \
teku \
--network=mainnet \
--ee-endpoint=http://localhost:8551 \
--ee-jwt-secret-file=path/to/jwt.hex \
Expand All @@ -113,7 +113,7 @@ The consensus client must be running before you start Nethermind.
:::

```bash
./nethermind \
nethermind \
-c mainnet \
--JsonRpc.JwtSecretFile path/to/jwt.hex
```
Expand Down

0 comments on commit d9ee07e

Please sign in to comment.