diff options
Diffstat (limited to 'doc/manual.cli')
| -rw-r--r-- | doc/manual.cli | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/doc/manual.cli b/doc/manual.cli index e5d6cf3..1140db5 100644 --- a/doc/manual.cli +++ b/doc/manual.cli @@ -18,7 +18,7 @@ This document describes \c{buildos}, the \c{build2} operating system. \h1#intro|Introduction| -\c{buildos} is a GNU/Linux(Debian)-based in-memory network-booted operating +\c{buildos} is a Debian GNU/Linux-based in-memory network-booted operating system specialized for autonomous building of software using the \c{build2} toolchain. It's primary purpose is to run the \c{build2} build bot (\c{bbot}), build slave (\c{bslave}), or both. @@ -69,7 +69,8 @@ timeout 50 label buildos menu label buildos kernel /buildos/buildos-image - append initrd=/buildos/buildos-initrd + initrd /buildos/buildos-initrd + append buildos.smtp_relay=example.org buildos.admin_email=admin@example.org EOF \ @@ -125,4 +126,21 @@ instance by examining \c{/etc/network/interfaces}. @@ TODO: private network parameters. +\h2#config-email|Email| + +A \c{buildos} instance sends various notifications (including all messages to +\c{root}) to the admin email address. The admin email is specified with +the \c{buildos.admin_email} kernel command line parameter. + +In order to deliver mail, the \c{postfix} MTA is configured to forward to a +relay. The relay host is specified with the \c{buildos.smtp_relay} kernel +command line parameter. + +Note that no authentication of any kind is configured for relaying. This means +that the relay host should accept emails from build hosts either because of +their network location (for example, because they are on your organization's +local network and you are using your organization's relay) or because the +relay host accepts emails send to the admin address from anyone (which is +normally the case if the relay is the final destination for the admin +address, for example, \c{example.org} and \c{admin@example.org}). " |