systemd-firstboot(1)

1SYSTEMD-FIRSTBOOT(1)           systemd-firstboot          SYSTEMD-FIRSTBOOT(1)
2
3
4

NAME

6       systemd-firstboot, systemd-firstboot.service - Initialize basic system
7       settings on or before the first boot-up of a system
8

SYNOPSIS

10       systemd-firstboot [OPTIONS...]
11
12       systemd-firstboot.service
13

DESCRIPTION

15       systemd-firstboot initializes the most basic system settings
16       interactively on the first boot, or optionally non-interactively when a
17       system image is created. The service is started if
18       ConditionFirstBoot=yes is satisfied. This essentially means that /etc
19       is empty, see systemd.unit(5) for details.
20
21       The following settings may be set up:
22
23       ·   The system locale, more specifically the two locale variables LANG=
24           and LC_MESSAGES
25
26       ·   The system keyboard map
27
28       ·   The system time zone
29
30       ·   The system host name
31
32       ·   The machine ID of the system
33
34       ·   The root user's password
35
36       Each of the fields may either be queried interactively by users, set
37       non-interactively on the tool's command line, or be copied from a host
38       system that is used to set up the system image.
39
40       If a setting is already initialized, it will not be overwritten and the
41       user will not be prompted for the setting.
42
43       Note that this tool operates directly on the file system and does not
44       involve any running system services, unlike localectl(1),
45       timedatectl(1) or hostnamectl(1). This allows systemd-firstboot to
46       operate on mounted but not booted disk images and in early boot. It is
47       not recommended to use systemd-firstboot on the running system while it
48       is up.
49

OPTIONS

51       The following options are understood:
52
53       --root=root
54           Takes a directory path as an argument. All paths will be prefixed
55           with the given alternate root path, including config search paths.
56           This is useful to operate on a system image mounted to the
57           specified directory instead of the host system itself.
58
59       --locale=LOCALE, --locale-messages=LOCALE
60           Sets the system locale, more specifically the LANG= and LC_MESSAGES
61           settings. The argument should be a valid locale identifier, such as
62           "de_DE.UTF-8". This controls the locale.conf(5) configuration file.
63
64       --keymap=KEYMAP
65           Sets the system keyboard layout. The argument should be a valid
66           keyboard map, such as "de-latin1". This controls the "KEYMAP" entry
67           in the vconsole.conf(5) configuration file.
68
69       --timezone=TIMEZONE
70           Sets the system time zone. The argument should be a valid time zone
71           identifier, such as "Europe/Berlin". This controls the localtime(5)
72           symlink.
73
74       --hostname=HOSTNAME
75           Sets the system hostname. The argument should be a host name,
76           compatible with DNS. This controls the hostname(5) configuration
77           file.
78
79       --machine-id=ID
80           Sets the system's machine ID. This controls the machine-id(5) file.
81
82       --root-password=PASSWORD, --root-password-file=PATH
83           Sets the password of the system's root user. This creates a
84           shadow(5) file. This setting exists in two forms: --root-password=
85           accepts the password to set directly on the command line, and
86           --root-password-file= reads it from a file. Note that it is not
87           recommended to specify passwords on the command line, as other
88           users might be able to see them simply by invoking ps(1).
89
90       --prompt-locale, --prompt-keymap, --prompt-timezone, --prompt-hostname,
91       --prompt-root-password
92           Prompt the user interactively for a specific basic setting. Note
93           that any explicit configuration settings specified on the command
94           line take precedence, and the user is not prompted for it.
95
96       --prompt
97           Query the user for locale, keymap, timezone, hostname and root
98           password. This is equivalent to specifying --prompt-locale,
99           --prompt-keymap, --prompt-timezone, --prompt-hostname,
100           --prompt-root-password in combination.
101
102       --copy-locale, --copy-keymap, --copy-timezone, --copy-root-password
103           Copy a specific basic setting from the host. This only works in
104           combination with --root= (see above).
105
106       --copy
107           Copy locale, keymap, time zone and root password from the host.
108           This is equivalent to specifying --copy-locale, --copy-keymap,
109           --copy-timezone, --copy-root-password in combination.
110
111       --setup-machine-id
112           Initialize the system's machine ID to a random ID. This only works
113           in combination with --root=.
114
115       -h, --help
116           Print a short help text and exit.
117
118       --version
119           Print a short version string and exit.
120

EXIT STATUS

122       On success, 0 is returned, a non-zero failure code otherwise.
123

KERNEL COMMAND LINE

125       systemd.firstboot=
126           Takes a boolean argument, defaults to on. If off,
127           systemd-firstboot.service won't interactively query the user for
128           basic settings at first boot, even if those settings are not
129           initialized yet.
130

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

EXIT STATUS

KERNEL COMMAND LINE

SEE ALSO