doc: Add note about private-key during offload.
authorOleg Pykhalov <go.wigust@gmail.com>
Fri, 7 Jul 2017 20:25:40 +0000 (23:25 +0300)
committerLudovic Courtès <ludo@gnu.org>
Sat, 8 Jul 2017 16:29:35 +0000 (18:29 +0200)
* doc/guix.texi (Using the Offload Facility): Add note about private-key.

Co-authored-by: Ludovic Courtès <ludo@gnu.org>
doc/guix.texi

index eab1704..cd694bb 100644 (file)
@@ -943,10 +943,13 @@ A number of optional fields may be specified:
 @item @code{port} (default: @code{22})
 Port number of SSH server on the machine.
 
-@item @code{private-key} (default: @file{~/.ssh/id_rsa})
+@item @code{private-key} (default: @file{~root/.ssh/id_rsa})
 The SSH private key file to use when connecting to the machine, in
 OpenSSH format.
 
+Note that the default value is the private key @emph{of the root
+account}.  Make sure it exists if you use the default.
+
 @item @code{compression} (default: @code{"zlib@@openssh.com,zlib"})
 @itemx @code{compression-level} (default: @code{3})
 The SSH-level compression methods and compression level requested.