Merge pull request #1343 from Emantor/doc/mention-ssh

doc/overview: mention SSH requirement
labgrid-project · Mar 26, 2024 · 3da8ec1 · 3da8ec1
2 parents aa08ff2 + 3ea19de
commit 3da8ec1
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/overview.rst b/doc/overview.rst
@@ -319,6 +319,12 @@ published as declared in the configuration file.
 This is useful to register externally configured resources such as network
 power switches or serial port servers with a labgrid coordinator.
 
+.. note::
+  Users will require SSH access to the exporter to access services and command
+  line utilities. You also have to ensure that users can access usb devices for
+  i.e. imx-usb-loader. To test a SSH jump to a device over the exporter outside
+  of labgrid, `ssh -J EXPORTER USER@DEVICE` can be used.
+
 .. _overview-client:
 
 Client