Revise Running Nethermind section

NethermindEth · Aug 17, 2023 · 6360c66 · 6360c66
1 parent d483ed0
commit 6360c66
Show file tree

Hide file tree

Showing 5 changed files with 108 additions and 183 deletions.
diff --git a/docs/fundamentals/01-running-nethermind/_category_.json b/docs/fundamentals/01-running-nethermind/_category_.json
diff --git a/docs/fundamentals/01-running-nethermind/running-the-client.md b/docs/fundamentals/01-running-nethermind/running-the-client.md
diff --git a/docs/fundamentals/01-running-nethermind/runtime.md b/docs/fundamentals/01-running-nethermind/runtime.md
diff --git a/docs/fundamentals/running-nethermind.md b/docs/fundamentals/running-nethermind.md
@@ -0,0 +1,106 @@
+---
+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).
+:::
+
+## Running directly
+
+For advanced users, running the Nethermind client directly is the best option as it gives complete control over the
+configuration parameters. Nethermind is mainly controlled by command line options (or arguments, flags).
+
+The full list of options can be displayed by running:
+
+<Tabs groupId="os">
+<TabItem value="linux" label="Linux">
+
+```bash
+./nethermind -h
+```
+
+</TabItem>
+<TabItem value="windows" label="Windows">
+
+```powershell
+./nethermind.exe -h
+```
+
+</TabItem>
+<TabItem value="macos" label="macOS">
+
+```bash
+./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" label="Linux">
+
+```bash
+./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>
+<TabItem value="macos" label="macOS">
+
+```bash
+./nethermind -c mainnet -dd path/to/data/dir
+```
+
+</TabItem>
+</Tabs>
+
+For detailed info about the available configuration options, see [Configuration](./04-configuration/README.md).
+
+## Running with the launcher
+
+For rookies, the launcher is the easiest way to begin by just following a few simple steps.
+
+Run the launcher as follows:
+
+<Tabs groupId="os">
+<TabItem value="linux" label="Linux">
+
+```bash
+./nethermind-launcher
+```
+
+</TabItem>
+<TabItem value="windows" label="Windows">
+
+```powershell
+./nethermind-launcher.exe
+```
+
+</TabItem>
+<TabItem value="macos" label="macOS">
+
+```bash
+./nethermind-launcher
+```
+
+</TabItem>
+</Tabs>
+
+1. To run a node, select `Ethereum Node`
+2. Then, select the desired [network](../get-started/networks.md) (Mainnet, Sepolia, Goerli)
+3. Then, select the [sync mode](./03-sync-modes.md) and you're ready to go
+
+If you need just the Nethermind command line interface (CLI), select `CLI` in the first step.
diff --git a/docs/get-started/installing-nethermind.md b/docs/get-started/installing-nethermind.md
@@ -110,7 +110,7 @@ Then, install Nethermind as follows:
 brew install nethermind
 ```
 
-For further instructions, see [Running Nethermind](../fundamentals/01-running-nethermind/running-the-client.md).
+For further instructions, see [Running Nethermind](../fundamentals/running-nethermind.md).
 
 ## Standalone downloads
 
@@ -187,7 +187,7 @@ To monitor the Nethermind output, run:
 journalctl -u nethermind -f
 ```
 
-For further instructions, see [Running Nethermind](../fundamentals/01-running-nethermind/running-the-client.md).
+For further instructions, see [Running Nethermind](../fundamentals/running-nethermind).
 
 ## Docker container