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 timeout. To enable
  24 this run:
  25
  26     systemctl --user enable novaboot-delayed-power-off
  27
  28 as the created user (e.g. via shell subcommand). To enable delayed
  29 power-off for all novaboot-shell account, run the follwing as root:
  30
  31     systemctl --global enable novaboot-delayed-power-off
  32
  33 Individual accounts may disable this global configuration by running:
  34
  35     systemctl --user mask novaboot-delayed-power-off
  36
  37 The power-off timeout is hardcoded in the B<novaboot-power-off@.timer>
  38 unit. To override the timeout, run C<systemctl edit
  39 novaboot-power-off@TARGET.timer> for your B<TARGET> and insert the
  40 following to the spawned editor:
  41
  42     [Timer]
  43     OnActiveSec=30min
  44
  45 =head1 OPTIONS
  46
  47 =over 8
  48
  49 =item --key KEY
  50
  51 Mandatory argument specifying administrator's public SSH key (e.g.
  52 F<~/.ssh/id_rsa.pub>). The key will be copied to the created account's
  53 F<~/.ssh/authorized_keys> and marked with administrator flag.
  54
  55 =item --admin-id NAME
  56
  57 User name associated with the key. This user name is shown to
  58 connecting users when the target is occupied by the administrator.
  59 When omitted, I<admin> is used as the user name.
  60
  61 =back
  62
  63 =head1 AUTHORS
  64
  65 Michal Sojka <sojkam1@fel.cvut.cz>
  66
  67 Latest version can be found at
  68 L<https://github.com/wentasah/novaboot>.
  69
  70 =cut