docs: update iperf documentation

simonwjackson · Oct 8, 2024 · a544ef4 · a544ef4
1 parent 9055481
commit a544ef4
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/packages/moonbeaming/src/content/docs/getting-started/starting-a-stream.mdx b/packages/moonbeaming/src/content/docs/getting-started/starting-a-stream.mdx
@@ -7,6 +7,10 @@ sidebar:
 
 import { Steps } from '@astrojs/starlight/components';
 
+:::note
+For bandwidth detection, you must run [`iperf3`](/troubleshooting/understanding-network-speed-tests/#speed-test-failures) on the host. Otherwise, you'll need to add [`--max-bandwidth <kbps>`](/core-settings/bitrate) to the command. 
+:::
+
 To start streaming a game or application with Moonbeam, follow these steps:
 
 <Steps>

diff --git a/...nbeaming/src/content/docs/troubleshooting/understanding-network-speed-tests.mdx b/...nbeaming/src/content/docs/troubleshooting/understanding-network-speed-tests.mdx
@@ -96,7 +96,7 @@ If Moonbeam fails to perform a speed test, it will:
 1. Check if `iperf3` is running on your host machine:
 
    ```bash
-   pgrep -f "iperf3 -s -p 31347"
+   pgrep -f "iperf3"
    ```
 
 2. If it's not running, start it manually:
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,6 +7,10 @@ sidebar: @@
     import { Steps } from '@astrojs/starlight/components';
+    :::note
+    For bandwidth detection, you must run [`iperf3`](/troubleshooting/understanding-network-speed-tests/#speed-test-failures) on the host. Otherwise, you'll need to add [`--max-bandwidth <kbps>`](/core-settings/bitrate) to the command.
+    :::
     To start streaming a game or application with Moonbeam, follow these steps:
     <Steps>
@@ Expand Down @@