1
0
Fork 1
mirror of https://gitlab.postmarketos.org/postmarketOS/pmbootstrap.git synced 2025-07-12 19:09:56 +03:00

docs: add section on ssh-key handling (MR 2251)

Signed-off-by: Robert Eckelmann <longnoserob@postmarketos.org>
This commit is contained in:
Robert Eckelmann 2024-11-01 09:07:34 +09:00 committed by Oliver Smith
parent 26f9d56b20
commit 4ecd45749d
No known key found for this signature in database
GPG key ID: 5AE7F5513E0885CB
2 changed files with 28 additions and 0 deletions

View file

@ -20,6 +20,7 @@ For further information, please check out the `postmarketOS-wiki`_.
usage usage
chroot chroot
debugging debugging
ssh-keys
api/modules api/modules
mirrors mirrors

27
docs/ssh-keys.rst Normal file
View file

@ -0,0 +1,27 @@
################
SSH key handling
################
pmbootstrap can copy SSH keys to the device during the install step.
If the config file option `ssh_keys` is set to `True` (it defaults to `False`),
then all files matching the glob `~/.ssh/*.pub` will be placed in
`~/.ssh/authorized_keys` in the user's home directory in newly-built images.
Sometimes, for example if you have a large number of SSH keys, you may wish to
select a different set of public keys to include in an image. To do this, set
the `ssh_key_glob` configuration parameter in the pmbootstrap config file to a
string containing a glob that is to match the file or files you wish to
include.
For example, a `~/.config/pmbootstrap_v3.cfg` may contain:
.. code-block:: shell
[pmbootstrap]
# ...
ssh_keys = True
ssh_key_glob = ~/.ssh/postmarketos-dev.pub
# ...