server/adduser-novaboot.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 adduser-novaboot - create user account for use with novaboot's --ssh option
   6
   7 =head1 SYNOPSIS
   8
   9 B<adduser-novaboot> --key KEY [--admin-id NAME] [adduser options] user
  10
  11 =head1 DESCRIPTION
  12
  13 B<adduser-novaboot> is a wrapper of L<adduser(8)> command that
  14 simplifies creation of user accounts for I<novaboot>'s --ssh option.
  15 The created account has its shell set to L<novaboot-shell(1)>. The
  16 command also creates a template of the configuration file, sets up
  17 administrator's SSH key in L<authorized_keys(5)> prepares directories
  18 and symlinks that for integration with TFTP server.
  19
  20 =head2 Automatic power-off
  21
  22 When your system uses L<systemd(1)>, you can configure a systemd
  23 service to automatically power-off the target after a timeout. See
  24 C<novaboot-delayed-power-off> in L<novaboot-shell(1)>.
  25
  26 =head1 OPTIONS
  27
  28 =over 8
  29
  30 =item --key KEY
  31
  32 Mandatory argument specifying administrator's public SSH key (e.g.
  33 F<~/.ssh/id_rsa.pub>). The key will be copied to the created account's
  34 F<~/.ssh/authorized_keys> and marked with administrator flag.
  35
  36 =item --admin-id NAME
  37
  38 User name associated with the key. This user name is shown to
  39 connecting users when the target is occupied by the administrator.
  40 When omitted, I<admin> is used as the user name.
  41
  42 =back
  43
  44 =head1 AUTHORS
  45
  46 Michal Sojka <sojkam1@fel.cvut.cz>
  47
  48 Latest version can be found at
  49 L<https://github.com/wentasah/novaboot>.
  50
  51 =cut