Update install instructions and known issues

NethermindEth · Sep 20, 2023 · b8092e5 · b8092e5
1 parent 45fe274
commit b8092e5
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 14 deletions.
diff --git a/docs/get-started/installing-nethermind.md b/docs/get-started/installing-nethermind.md
@@ -15,12 +15,12 @@ Nethermind can be installed in several ways:
 
 ## Prerequisites
 
-Before installing Nethermind, the following prerequisites must be met for your specific platform.
-
 :::info
 Does not apply to Docker distributions.
 :::
 
+Before installing Nethermind, your specific platform might need the following prerequisites.
+
 <Tabs groupId="os">
 <TabItem value="linux" label="Linux">
 
@@ -61,7 +61,8 @@ winget install Microsoft.VCRedist.2015+.x64
 
 Package managers are the easiest and fastest way of installing Nethermind.
 
-### Ubuntu
+<Tabs groupId="os">
+<TabItem value="linux" label="Linux">
 
 On Ubuntu and other Linux distros supporting PPA, Nethermind can be installed via Launchpad PPA.
 
@@ -86,15 +87,17 @@ sudo apt-get update
 sudo apt-get install nethermind
 ```
 
-### Windows
+</TabItem>
+<TabItem value="windows" label="Windows">
 
 On Windows, Nethermind can be installed via Windows Package Manager as follows:
 
 ```powershell
 winget install nethermind
 ```
 
-### macOS
+</TabItem>
+<TabItem value="macos" label="macOS">
 
 On macOS, Nethermind can be installed via Homebrew.
 
@@ -110,6 +113,9 @@ Then, install Nethermind as follows:
 brew install nethermind
 ```
 
+</TabItem>
+</Tabs>
+
 For further instructions, see [Running Nethermind](../fundamentals/running-nethermind.md).
 
 ## Standalone downloads
@@ -135,8 +141,8 @@ For instance, if you want to run Nethermind as a different user, change the `Use
   sudo useradd -m -s /bin/bash nethermind
 
   # Increase the maximum number of open files
-  sudo bash -c 'echo "nethermind soft nofile 1000000" > /etc/security/limits.d/nethermind.conf'
-  sudo bash -c 'echo "nethermind hard nofile 1000000" >> /etc/security/limits.d/nethermind.conf'
+  sudo bash -c 'echo "nethermind soft nofile 100000" > /etc/security/limits.d/nethermind.conf'
+  sudo bash -c 'echo "nethermind hard nofile 100000" >> /etc/security/limits.d/nethermind.conf'
 
   # Switch to the nethermind user
   sudo su -l nethermind

diff --git a/docs/resources/_category_.json b/docs/resources/_category_.json
@@ -1,8 +1,4 @@
 {
   "position": 8,
-  "label": "Resources",
-  "collapsible": true,
-  "link": {
-    "type": "generated-index"
-  }
+  "label": "Resources"
 }
diff --git a/docs/resources/know-issues.md → docs/resources/known-issues.md b/docs/resources/know-issues.md → docs/resources/known-issues.md
@@ -1,9 +1,40 @@
 ---
-description: There are several known issues with the current version of Nethermind
+title: Known issues
 sidebar_position: 3
 ---
 
-# Known Issues
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+
+## File descriptor limits
+
+In some cases, file descriptor limits may cause issues like "Too many open files". To solve that, see the instructions for your platform below.
+
+<Tabs groupId="os">
+<TabItem value="linux" label="Linux">
+
+To increase the limits for the user running Nethermind (e.g., `nethermind`), run:
+
+```bash
+sudo echo "nethermind soft nofile 100000" > /etc/security/limits.d/nethermind.conf
+sudo echo "nethermind hard nofile 100000" >> /etc/security/limits.d/nethermind.conf
+```
+
+</TabItem>
+<TabItem value="macos" label="macOS">
+
+To increase the limits, run:
+
+```bash
+ulimit -n 10000
+```
+
+If you run into issues with the above command, see the [workaround](https://developer.apple.com/forums/thread/735798?answerId=762679022#762679022).
+
+Note that the changes above are temporary and will be reset after the system reboot. To make them permanent, you can add them to your `~/.bashrc` or `~/.bash_profile` shell configuration file.
+
+</TabItem>
+</Tabs>
 
 ## RocksDB checksum issue