summary refs log tree commit diff
diff options
context:
space:
mode:
authorMaxim Cournoyer <maxim.cournoyer@gmail.com>2021-05-30 23:15:27 -0400
committerMaxim Cournoyer <maxim.cournoyer@gmail.com>2021-05-30 23:33:36 -0400
commitb9ac7d9aaaa5849cc3c2acd4b1b41acdd545e66b (patch)
tree9ca241ace74bc503bd86efc7a059835e21dabfb1
parent6086e6ed1a038793e358becddded50d97593f691 (diff)
downloadguix-b9ac7d9aaaa5849cc3c2acd4b1b41acdd545e66b.tar.gz
doc: Add a note about networking requirements for SSH access to VMs.
Fixes <https://issues.guix.gnu.org/48739>.  It may seem silly, but when not
realizing this firsthand, it can be quite surprising and thus not obvious to
troubleshoot.  Thanks to Eric Brown for their insightful comments on the
tracker.

* doc/guix.texi (Running Guix in a VM): Add a note that networking support
must be available in the Guix System operating system declaration used for the
VM.
-rw-r--r--doc/guix.texi7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index dc10e88123..0126099d68 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -33845,6 +33845,13 @@ every time you modify your @command{config.scm} file and the
 @command{-o StrictHostKeyChecking=no} prevents you from having to allow a
 connection to an unknown host every time you connect.
 
+@quotation Note
+If you find the above @samp{hostfwd} example not to be working (e.g.,
+your SSH client hangs attempting to connect to the mapped port of your
+VM), make sure that your Guix System VM has networking support, such as
+by using the @code{dhcp-client-service-type} service type.
+@end quotation
+
 @subsection Using @command{virt-viewer} with Spice
 
 As an alternative to the default @command{qemu} graphical client you can