document fork-observer

Author: willcl-ark

docs/quickstart.md

@@ -35,3 +35,13 @@ warnet quickstart
 ```
 
 This will check you have the required dependencies and guide you through setting up and deploying your first network.
+
+## fork-observer
+
+If you enabled [fork-observer](https://github.com/0xB10C/fork-observer), you must forward the port from the cluster to your local machine:
+
+```bash
+kubectl port-forward fork-observer 2323
+```
+
+And then the GUI can be accessed via `localhost:2323` in a web browser.

src/warnet/main.py

@@ -221,6 +221,12 @@ def quickstart():
         click.echo(
             f"\nEdit the network files found in {custom_network_path} before deployment if you want to customise the network."
         )
+        if fork_observer:
+            click.echo(
+                "If you enabled fork-observer you must forward the port from the cluster to your local machine:\n"
+                "`kubectl port-forward fork-observer 2323`\n"
+                "fork-observer will then be available at web address: localhost:2323"
+            )
 
         click.echo("\nWhen you're ready, run the following command to deploy this network:")
         click.echo(f"warnet deploy {custom_network_path}")