summaryrefslogtreecommitdiffstats
path: root/man/systemd-firstboot.xml
blob: 42fd753f533d90a36d4a12f8c4fd48d5554bdee8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2014 Lennart Poettering

  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
  Lesser 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 <http://www.gnu.org/licenses/>.
-->

<refentry id="systemd-firstboot"
          xmlns:xi="http://www.w3.org/2001/XInclude">

        <refentryinfo>
                <title>systemd-firstboot</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>systemd-firstboot</refentrytitle>
                <manvolnum>1</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>systemd-firstboot</refname>
                <refname>systemd-firstboot.service</refname>
                <refpurpose>Initialize basic system settings on or before the first boot-up of a system</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <cmdsynopsis>
                        <command>systemd-firstboot</command>
                        <arg choice="opt" rep="repeat">OPTIONS</arg>
                </cmdsynopsis>

                <para><filename>systemd-firstboot.service</filename></para>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><command>systemd-firstboot</command> initializes
                the most basic system settings interactively on the
                first boot, or optionally non-interactively when a
                system image is created. The following settings may be
                set up:</para>

                <itemizedlist>
                        <listitem><para>The system locale, more
                        specifically the two locale variables
                        <varname>LANG=</varname> and
                        <varname>LC_MESSAGES</varname></para></listitem>

                        <listitem><para>The system time zone</para></listitem>

                        <listitem><para>The system host name</para></listitem>

                        <listitem><para>The machine ID of the system</para></listitem>

                        <listitem><para>The root user's password</para></listitem>
                </itemizedlist>

                <para>Each of the fields may either be queried
                interactively from the users, set non-interactively on
                the tool's command line, or be copied from a host
                system that is used to set up the system image.</para>

                <para>If a setting is already initialized it will not
                be overwritten and the user will not be prompted for
                the setting.</para>

                <para>Note that this tool operates directly on the
                file system and does not involve any running system
                services, unlike
                <citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                or
                <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. This
                allows <command>systemd-firstboot</command> to operate
                on mounted but not booted disk images and in early
                boot. It is not recommended to use
                <command>systemd-firsboot</command> on the running
                system while it is up.</para>
        </refsect1>

        <refsect1>
                <title>Options</title>

                <para>The following options are understood:</para>

                <variablelist>
                        <varlistentry>
                                <term><option>--root=<replaceable>root</replaceable></option></term>
                                <listitem><para>Takes a directory path
                                as an argument. All paths will be
                                prefixed with the given alternate
                                <replaceable>root</replaceable> path,
                                including config search paths. This is
                                useful to operate on a system image
                                mounted to the specified directory
                                instead of the host system itself.
                                </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--locale=<replaceable>LOCALE</replaceable></option></term>
                                <term><option>--locale-messages=<replaceable>LOCALE</replaceable></option></term>

                                <listitem><para>Sets the system
                                locale, more specifically the
                                <varname>LANG=</varname> and
                                <varname>LC_MESSAGES</varname>
                                settings. The argument should be a
                                valid locale identifier, such as
                                <literal>de_DE.UTF-8</literal>. This
                                controls the
                                <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                configuration file.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--timezone=<replaceable>TIMEZONE</replaceable></option></term>

                                <listitem><para>Sets the system time
                                zone. The argument should be a valid
                                time zone identifier, such as
                                <literal>Europe/Berlin</literal>. This
                                controls the
                                <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                symlink.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--hostname=<replaceable>HOSTNAME</replaceable></option></term>

                                <listitem><para>Sets the system
                                hostname. The argument should be a
                                host name, compatible with DNS. This
                                controls the
                                <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                configuration file.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--machine-id=<replaceable>ID</replaceable></option></term>

                                <listitem><para>Sets the system's machine ID. This
                                controls the
                                <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                file.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--root-password=<replaceable>PASSWORD</replaceable></option></term>
                                <term><option>--root-password-file=<replaceable>PATH</replaceable></option></term>

                                <listitem><para>Sets the password of
                                the system's root user. This creates a
                                <citerefentry><refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                file. This setting exists in two
                                forms:
                                <option>--root-password=</option>
                                accepts the password to set directly
                                on the command line,
                                <option>--root-password-file=</option>
                                reads it from a file. Note that
                                it is not recommended specifying
                                passwords on the command line as other
                                users might be able to see them
                                simply by invoking
                                <citerefentry><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--prompt-locale</option></term>
                                <term><option>--prompt-timezone</option></term>
                                <term><option>--prompt-hostname</option></term>
                                <term><option>--prompt-root-password</option></term>

                                <para>Prompt the user interactively
                                for a specific basic setting. Note
                                that any explicit configuration
                                settings specified on the command line
                                take precedence, and the user is not
                                prompted for it.</para>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--prompt</option></term>

                                <para>Query the user for locale,
                                timezone, hostname and root
                                password. This is equivalent to
                                specifiying
                                <option>--prompt-locale</option>,
                                <option>--prompt-timezone</option>,
                                <option>--prompt-hostname</option>,
                                <option>--prompt-root-password</option>
                                in combination.</para>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--copy-locale</option></term>
                                <term><option>--copy-timezone</option></term>
                                <term><option>--copy-root-password</option></term>

                                <para>Copy a specific basic setting
                                from the host. This only works in
                                combination with
                                <option>--root=</option> (see
                                above).</para>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--copy</option></term>

                                <para>Copy locale, time zone and root
                                password from the host. This is
                                equivalent to specifiying
                                <option>--copy-locale</option>,
                                <option>--copy-timezone</option>,
                                <option>--copy-root-password</option>
                                in combination.</para>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--setup-machine-id</option></term>

                                <para>Initialize the system's machine
                                ID to a random ID. This only works
                                combination with
                                <option>--root=</option>.</para>
                        </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, a non-zero failure
                code otherwise.</para>
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>