Update docs with info about ssh keys

it looks like the key value expects the entire content of
~/.ssh/id_rsa.pub
This commit is contained in:
Alexander Todorov 2018-11-07 14:01:26 +02:00 committed by Alexander Todorov
parent 59d8c91ae5
commit 6631002a81
2 changed files with 12 additions and 2 deletions

View File

@ -192,6 +192,10 @@ Set an existing user's ssh key in the final image::
The key will be added to the user's authorized_keys file. The key will be added to the user's authorized_keys file.
.. warning::
``key`` expects the entire content of ``~/.ssh/id_rsa.pub``
[[customizations.user]] [[customizations.user]]
*********************** ***********************
@ -213,6 +217,10 @@ All fields for this section are optional except for the ``name``, here is a comp
If the password starts with ``$6$``, ``$5$``, or ``$2b$`` it will be stored as If the password starts with ``$6$``, ``$5$``, or ``$2b$`` it will be stored as
an encrypted password. Otherwise it will be treated as a plain text password. an encrypted password. Otherwise it will be treated as a plain text password.
.. warning::
``key`` expects the entire content of ``~/.ssh/id_rsa.pub``
[[customizations.group]] [[customizations.group]]
************************ ************************

View File

@ -301,7 +301,8 @@ key = "PUBLIC SSH KEY"
.UNINDENT .UNINDENT
.UNINDENT .UNINDENT
.sp .sp
The key will be added to the user\(aqs authorized_keys file. The key will be added to the user\(aqs authorized_keys file. Expected value is the content
of ~/.ssh/id_rsa.pub.
.SS [[customizations.user]] .SS [[customizations.user]]
.sp .sp
Add a user to the image, and/or set their ssh key. Add a user to the image, and/or set their ssh key.
@ -327,7 +328,8 @@ gid = 1200
.UNINDENT .UNINDENT
.sp .sp
If the password starts with \fB$6$\fP, \fB$5$\fP, or \fB$2b$\fP it will be stored as If the password starts with \fB$6$\fP, \fB$5$\fP, or \fB$2b$\fP it will be stored as
an encrypted password. Otherwise it will be treated as a plain text password. an encrypted password. Otherwise it will be treated as a plain text password. For
ssh keys the expected value is the content of ~/.ssh/id_rsa.pub.
.SS [[customizations.group]] .SS [[customizations.group]]
.sp .sp
Add a group to the image. \fBname\fP is required and \fBgid\fP is optional: Add a group to the image. \fBname\fP is required and \fBgid\fP is optional: