SymbX/systemd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

sysinstall: new component

Browse Source
This commit is contained in:
Lennart Poettering
2026-05-05 15:09:47 +02:00
committed by Lennart Poettering
parent ea07d7fec3
commit 5fbc7a7b12
15 changed files with 1911 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/rules/meson.build
+4
View File
@@ -1218,6 +1218,10 @@ manpages = [
'systemd-sysext-sysroot.service',
'systemd-sysext.service'],
'ENABLE_SYSEXT'],
['systemd-sysinstall',
'8',
['systemd-sysinstall.service'],
'ENABLE_SYSINSTALL'],
['systemd-system-update-generator', '8', [], ''],
['systemd-system.conf',
'5',
man/systemd-sysinstall.xml
+292
View File
@@ -0,0 +1,292 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="systemd-sysinstall" conditional='ENABLE_SYSINSTALL'
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>systemd-sysinstall</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>systemd-sysinstall</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-sysinstall</refname>
<refname>systemd-sysinstall.service</refname>
<refpurpose>Simple OS installer</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>systemd-sysinstall</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="opt">BLOCKDEVICE</arg>
</cmdsynopsis>
<para><filename>systemd-sysinstall.service</filename></para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><command>systemd-sysinstall</command> is a simple terminal and command line based operating system
installer tool. Its primary use-case is to act as an automatically started interactive interface when
booting from an installer medium (e.g. a USB stick), in order to install an OS onto a target
disk. However, it may also be invoked directly from a shell. It executes the following steps:</para>
<orderedlist>
<listitem><para>It prompts the user for the target disk to install the OS on. (Unless the block device
is already specified on the command line.)</para></listitem>
<listitem><para>It validates whether the disk is suitable (i.e. large enough, and with enough
free/unpartitioned space) for an OS installation. If it is generally suitable the user is prompted if they
want to erase the disk before installation, or if the OS shall be added to the existing partitions on
the disk (the latter only if enough free/unpartitioned disk space is available).</para></listitem>
<listitem><para>It prompts the user whether to register the newly installed OS with the firmware boot option menu.</para></listitem>
<listitem><para>It requests confirmation from the user, after showing a summary of the planned OS installation.</para></listitem>
<listitem><para>It invokes
<citerefentry><refentrytitle>systemd-creds</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
<command>encrypt</command> command in order to generate encrypted (TPM locked, if available) system
credential files for a few, very basic system settings of the currently booted system (locale, keymap,
timezone), which it will install on the target disk, parameterizing the invoked kernel. (Or in other
words, it prepares that some settings already in effect on the installer system are propagated securely
onto the new installation.)</para></listitem>
<listitem><para>It invokes
<citerefentry><refentrytitle>systemd-repart</refentrytitle><manvolnum>8</manvolnum></citerefentry> with
a definitions directory of <filename>/usr/lib/repart.sysinstall.d/</filename> (only if populated – if
not will use the default of <filename>/usr/lib/repart.d/</filename>). This is supposed to set up the
basic OS partition structure on the target disk and copies in basic OS partitions (most importantly the
<filename>/usr/</filename> hierarchy).</para></listitem>
<listitem><para>It invokes
<citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
<command>link</command> command to install an OS kernel image onto the target disk's ESP/XBOOTLDR,
together with the credential files prepared earlier.</para></listitem>
<listitem><para>It invokes
<citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
<command>install</command> command to install the
<citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry> boot
loader onto the target disk's ESP.</para></listitem>
<listitem><para>After confirmation, it reboots the system.</para></listitem>
</orderedlist>
<para>Note that the prompts/confirmation may be disabled via the command line, enabling fully automatic,
non-interactive installation. See below.</para>
<para>Note this tool does not interactively query the user for a user to create or a root password to be
set on the target system, under the assumption these questions are better prompted from within the newly
installed system's first boot process, for example via the
<citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> or
<filename>systemd-homed-firstboot.service</filename> components. Note that if required such settings
may be propagated explicitly via the <option>--load-credential=</option> switch below.</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>--definitions=</option></term>
<listitem><para>Overrides the directory where <command>systemd-repart</command> shall read its
partition definitions from, in place of the default of
<filename>/usr/lib/repart.sysinstall.d/</filename>.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--welcome=</option></term>
<listitem><para>Takes a boolean argument. Controls whether to show the brief welcome text normally
displayed at the beginning of the installation. Defaults to true.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--chrome=</option></term>
<listitem><para>Takes a boolean argument. Controls whether to show the colored bars at the top and
bottom of the terminal interface. Defaults to true.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--erase=</option></term>
<listitem><para>Takes a boolean argument. Controls whether to erase the current contents of the
target disk. If this switch is not used the user is prompted.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--confirm=</option></term>
<listitem><para>Takes a boolean argument. Controls whether to interactively query the user for
confirmation before initiating the OS installation. Defaults to true.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--reboot=</option></term>
<listitem><para>Takes a boolean argument. Controls whether to reboot the system after completing the
installation. Defaults to false.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--variables=</option></term>
<listitem><para>Takes a boolean argument. Controls whether to register the installed boot loader in
the firmware's boot options database. If not specified the user will be prompted.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--summary=</option></term>
<listitem><para>Takes a boolean argument. Controls whether to show a summary of the choices made
before asking for confirmation to proceed with the OS installation. Defaults to true.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--kernel=</option></term>
<listitem><para>Takes a path to a unified kernel image (UKI). Explicitly selects the kernel image to
install on the target disk. If unspecified the currently booted kernel image is installed on the
target disk.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--set-credential=<replaceable>id</replaceable>:<replaceable>value</replaceable></option></term>
<listitem><para>Accepts an additional system credential to encrypt (with a key generated on the local
TPM, if available, and the null key otherwise) and place next to the installed kernel image in the
ESP. This may be used to parameterize the installed kernel with arbitrary system credentials. Do not
use this switch for sensitive data (such as passwords), use <option>--load-credential=</option>
instead, see below. May be used multiple times to configure multiple credentials.</para>
<para>Note that three system credentials are propagated in similar fashion to the target system:
the locale, keymap and timezone. This may be controlled by the relevant
<option>--copy-locale=</option>, <option>--copy-keymap=</option> and <option>--copy-timezone=</option>
options below.</para>
<para>See
<citerefentry><refentrytitle>systemd.system-credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry>
for a list of well-known system credentials that may be propagated this way. (Note that you may pass
arbitrary additional credentials this way, that can be consumed by any service of your
choice, via the usual system credentials logic.)</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--load-credential=<replaceable>id</replaceable>:<replaceable>path</replaceable></option></term>
<listitem><para>Similar to <option>--set-credential=</option> but reads the credential value from a
file on disk or an <constant>AF_UNIX</constant> socket in the file system. This is generally
preferable for sensitive data, such as passwords.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--copy-locale=</option></term>
<term><option>--copy-keymap=</option></term>
<term><option>--copy-timezone=</option></term>
<listitem><para>These options take boolean parameters. They control whether the indicated system
settings shall be propagated from the currently running system into the new target OS
installation. These options default to true.</para>
<para>Typically, these three settings are the minimal settings that need to be configured during early
boot of an installer medium in order to make the installer tool accessible to the user. The
<citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
tool may be used to query the user interactively when the OS install medium is booted for these
properties. By propagating these settings to the target installation via system credentials they do
not need to be queried again on first boot of the new installation.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--mute-console=</option></term>
<listitem><para>Takes a boolean argument. Controls whether to disable kernel and service manager log
output to the console the installer is invoked on temporarily while running, in order to avoid
interleaved output. Defaults to false.</para>
<xi:include href="version-info.xml" xpointer="v261"/></listitem>
</varlistentry>
<xi:include href="standard-options.xml" xpointer="help" />
<xi:include href="standard-options.xml" xpointer="version" />
</variablelist>
</refsect1>
<refsect1>
<title>Exit status</title>
<para>On success, 0 is returned, and a non-zero failure code otherwise.</para>
</refsect1>
<refsect1>
<title>Example</title>
<example>
<title>Invoke the tool for a fully automatic non-interactive OS installation</title>
<programlisting>systemd-sysinstall \
/dev/disk/by-id/nvme-Micron_MTFDKBA1T0TFH_214532D0CDA5 \
--erase=yes \
--confirm=no \
--variables=yes \
--load-credential=ssh.authorized_keys.root:my-ssh-key
</programlisting>
<para>This installs the OS on the selected disk, erasing any previous contents, without confirmation,
registers it in the firmware, and drops in the SSH key for the root user, read from the
<filename>my-ssh-key</filename> file in the current directory.</para>
</example>
</refsect1>
<refsect1>
<title>See Also</title>
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-creds</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-repart</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd.system-credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
</simplelist></para>
</refsect1>
</refentry>
meson.build
+3
View File
@@ -1582,6 +1582,7 @@ foreach tuple : [
['rfkill'],
['smack'],
['sysext'],
['sysinstall'],
['sysusers'],
['timedated'],
['timesyncd'],
@@ -2144,6 +2145,7 @@ subdir('src/storagetm')
subdir('src/sulogin-shell')
subdir('src/sysctl')
subdir('src/sysext')
subdir('src/sysinstall')
subdir('src/system-update-generator')
subdir('src/systemctl')
subdir('src/sysupdate')
@@ -2928,6 +2930,7 @@ foreach tuple : [
['resolve'],
['rfkill'],
['sysext'],
['sysinstall'],
['systemd-analyze', conf.get('ENABLE_ANALYZE') == 1],
['sysupdate'],
['sysupdated'],
meson_options.txt
+2
View File
@@ -109,6 +109,8 @@ option('sysupdate', type : 'feature', deprecated : { 'true' : 'enabled', 'false'
option('sysupdated', type: 'combo', value : 'auto',
choices : ['auto', 'enabled', 'disabled'],
description : 'install the systemd-sysupdated service')
option('sysinstall', type : 'boolean',
description : 'install the systemd-sysinstall tool')
option('coredump', type : 'boolean',
description : 'install the coredump handler')
shell-completion/bash/meson.build
+1
View File
@@ -54,6 +54,7 @@ foreach item : [
['systemd-resolve', 'ENABLE_RESOLVE'],
['systemd-run', ''],
['systemd-sysext', 'ENABLE_SYSEXT'],
['systemd-sysinstall', 'ENABLE_SYSINSTALL'],
['systemd-vmspawn', 'ENABLE_VMSPAWN'],
['systemd-vpick', ''],
['timedatectl', 'ENABLE_TIMEDATED'],
shell-completion/bash/systemd-sysinstall
+90
View File
@@ -0,0 +1,90 @@
# shellcheck shell=bash
# systemd-sysinstall(8) completion -*- shell-script -*-
# SPDX-License-Identifier: LGPL-2.1-or-later
#
# This file is part of systemd.
#
# systemd is free software; you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation; either version 2.1 of the License, or
# (at your option) any later version.
#
# systemd is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with systemd; If not, see <https://www.gnu.org/licenses/>.
__contains_word() {
local w word=$1; shift
for w in "$@"; do
[[ $w = "$word" ]] && return
done
}
__get_block_devices() {
systemd-repart --list-devices 2>/dev/null
}
_systemd_sysinstall() {
local comps
local cur=${COMP_WORDS[COMP_CWORD]} prev=${COMP_WORDS[COMP_CWORD-1]} words cword
local -A OPTS=(
[STANDALONE]='-h --help --version'
[ARG]='--welcome
--chrome
--erase
--confirm
--summary
--reboot
--variables
--mute-console
--copy-locale
--copy-keymap
--copy-timezone
--definitions
--kernel
--set-credential
--load-credential'
)
_init_completion || return
if __contains_word "$prev" ${OPTS[ARG]}; then
case $prev in
--welcome|--chrome|--confirm|--summary|--reboot|--mute-console|--copy-locale|--copy-keymap|--copy-timezone)
comps='yes no'
;;
--erase|--variables)
comps='yes no auto'
;;
--definitions)
comps=$(compgen -A directory -- "$cur")
compopt -o filenames
;;
--kernel|--load-credential)
comps=$(compgen -A file -- "$cur")
compopt -o filenames
;;
--set-credential)
comps=''
;;
esac
COMPREPLY=( $(compgen -W '$comps' -- "$cur") )
return 0
fi
if [[ "$cur" = -* ]]; then
COMPREPLY=( $(compgen -W '${OPTS[*]}' -- "$cur") )
return 0
fi
comps=$(__get_block_devices)
COMPREPLY=( $(compgen -W '$comps' -- "$cur") )
compopt -o filenames
return 0
}
complete -F _systemd_sysinstall systemd-sysinstall
shell-completion/zsh/_systemd-sysinstall
+29
View File
@@ -0,0 +1,29 @@
#compdef systemd-sysinstall
# SPDX-License-Identifier: LGPL-2.1-or-later
(( $+functions[_systemd-sysinstall_devices] )) ||
_systemd-sysinstall_devices() {
local -a _devices
_devices=( ${(f)"$(systemd-repart --list-devices 2>/dev/null)"} )
_wanted devices expl 'block device' compadd -a _devices
}
_arguments \
'(- *)'{-h,--help}'[Show help text]' \
'(- *)--version[Show package version]' \
'--welcome=[Show welcome text]:boolean:(yes no)' \
'--chrome=[Show colored bars at top and bottom of the terminal]:boolean:(yes no)' \
'--erase=[Erase target disk before installation]:boolean:(yes no auto)' \
'--confirm=[Query for confirmation before installation]:boolean:(yes no)' \
'--summary=[Show summary before installation]:boolean:(yes no)' \
'--reboot=[Reboot system after installation]:boolean:(yes no)' \
'--variables=[Register installation in firmware variables]:boolean:(yes no auto)' \
'--mute-console=[Mute kernel/PID 1 console output during installation]:boolean:(yes no)' \
'--copy-locale=[Copy current locale to target system]:boolean:(yes no)' \
'--copy-keymap=[Copy current keymap to target system]:boolean:(yes no)' \
'--copy-timezone=[Copy current timezone to target system]:boolean:(yes no)' \
'--definitions=[Find partition definitions in directory]:directory:_directories' \
'--kernel=[Kernel image to install]:kernel image:_files' \
'--set-credential=[Install a credential with a literal value]: : _message "ID:VALUE"' \
'--load-credential=[Load credential from a file or AF_UNIX socket]: : _message "ID:PATH"' \
'*::block device:_systemd-sysinstall_devices'
shell-completion/zsh/meson.build
+1
View File
@@ -43,6 +43,7 @@ foreach item : [
['_systemd-nspawn', ''],
['_systemd-path', ''],
['_systemd-run', ''],
['_systemd-sysinstall', 'ENABLE_SYSINSTALL'],
['_systemd-tmpfiles', 'ENABLE_TMPFILES'],
['_timedatectl', 'ENABLE_TIMEDATED'],
['_udevadm', ''],
src/basic/time-util.c
+10
View File
@@ -1697,6 +1697,16 @@ int get_timezone(char **ret) {
return strdup_to(ret, e);
}
int get_timezone_prefer_env(char **ret) {
assert(ret);
const char *e = getenv("TZ");
if (e && e[0] == ':' && timezone_is_valid(e + 1, LOG_DEBUG))
return strdup_to(ret, e + 1);
return get_timezone(ret);
}
const char* etc_localtime(void) {
static const char *cached = NULL;
src/basic/time-util.h
+1
View File
@@ -178,6 +178,7 @@ bool clock_supported(clockid_t clock);
usec_t usec_shift_clock(usec_t x, clockid_t from, clockid_t to);
int get_timezone(char **ret);
int get_timezone_prefer_env(char **ret);
const char* etc_localtime(void);
int mktime_or_timegm_usec(struct tm *tm, bool utc, usec_t *ret);
src/sysinstall/meson.build
+10
View File
@@ -0,0 +1,10 @@
# SPDX-License-Identifier: LGPL-2.1-or-later
executables += [
executable_template + {
'name' : 'systemd-sysinstall',
'public' : true,
'conditions' : ['ENABLE_SYSINSTALL'],
'sources' : files('sysinstall.c'),
},
]
src/sysinstall/sysinstall.c
+1425
View File
File diff suppressed because it is too large Load Diff
units/meson.build
+6
View File
@@ -240,6 +240,7 @@ units = [
},
{ 'file' : 'sysinit.target' },
{ 'file' : 'syslog.socket' },
{ 'file' : 'system-install.target' },
{
'file' : 'system-systemd\\x2dcryptsetup.slice',
'conditions' : ['HAVE_LIBCRYPTSETUP'],
@@ -778,6 +779,11 @@ units = [
'file' : 'systemd-sysext@.service',
'conditions' : ['ENABLE_SYSEXT'],
},
{
'file' : 'systemd-sysinstall.service',
'conditions' : ['ENABLE_SYSINSTALL'],
'symlinks' : ['system-install.target.wants/'],
},
{
'file' : 'systemd-sysupdate-reboot.service.in',
'conditions' : ['ENABLE_SYSUPDATE'],
units/system-install.target
+15
View File
@@ -0,0 +1,15 @@
# SPDX-License-Identifier: LGPL-2.1-or-later
#
# This file is part of systemd.
#
# systemd is free software; you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation; either version 2.1 of the License, or
# (at your option) any later version.
[Unit]
Description=System Installer
Documentation=man:systemd-sysinstall(8)
Requires=sysinit.target
After=sysinit.target
AllowIsolate=yes
units/systemd-sysinstall.service
+22
View File
@@ -0,0 +1,22 @@
# SPDX-License-Identifier: LGPL-2.1-or-later
#
# This file is part of systemd.
#
# systemd is free software; you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation; either version 2.1 of the License, or
# (at your option) any later version.
[Unit]
Description=System Install Tool
Documentation=man:systemd-sysinstall(8)
Wants=systemd-logind.service
After=systemd-logind.service
[Service]
ExecStart=systemd-sysinstall --variables=yes --reboot=yes --mute-console=yes
StandardOutput=tty
StandardInput=tty
StandardError=tty
TTYReset=yes
FailureAction=halt