]> git.ipfire.org Git - thirdparty/systemd.git/blame - docs/ENVIRONMENT.md
man: mention that inhibit blocks soft-reboot too
[thirdparty/systemd.git] / docs / ENVIRONMENT.md
CommitLineData
c3e270f4
FB
1---
2title: Known Environment Variables
4cdca0af 3category: Interfaces
b41a3f66 4layout: default
0aff7b75 5SPDX-License-Identifier: LGPL-2.1-or-later
c3e270f4
FB
6---
7
4549fcdb
LP
8# Known Environment Variables
9
10A number of systemd components take additional runtime parameters via
11environment variables. Many of these environment variables are not supported at
12the same level as command line switches and other interfaces are: we don't
13document them in the man pages and we make no stability guarantees for
14them. While they generally are unlikely to be dropped any time soon again, we
15do not want to guarantee that they stay around for good either.
16
17Below is an (incomprehensive) list of the environment variables understood by
18the various tools. Note that this list only covers environment variables not
19documented in the proper man pages.
20
21All tools:
22
e7b86e48
ZJS
23* `$SYSTEMD_OFFLINE=[0|1]` — if set to `1`, then `systemctl` will refrain from
24 talking to PID 1; this has the same effect as the historical detection of
25 `chroot()`. Setting this variable to `0` instead has a similar effect as
54dcf847
LP
26 `$SYSTEMD_IGNORE_CHROOT=1`; i.e. tools will try to communicate with PID 1
27 even if a `chroot()` environment is detected. You almost certainly want to
28 set this to `1` if you maintain a package build system or similar and are
29 trying to use a modern container system and not plain `chroot()`.
f38951a6 30
4549fcdb 31* `$SYSTEMD_IGNORE_CHROOT=1` — if set, don't check whether being invoked in a
f38951a6 32 `chroot()` environment. This is particularly relevant for systemctl, as it
e7b86e48 33 will not alter its behaviour for `chroot()` environments if set. Normally it
f38951a6
CW
34 refrains from talking to PID 1 in such a case; turning most operations such
35 as `start` into no-ops. If that's what's explicitly desired, you might
54dcf847 36 consider setting `$SYSTEMD_OFFLINE=1`.
4549fcdb 37
bd3beda2
ZJS
38* `$SYSTEMD_FIRST_BOOT=0|1` — if set, assume "first boot" condition to be false
39 or true, instead of checking the flag file created by PID 1.
40
4549fcdb
LP
41* `$SD_EVENT_PROFILE_DELAYS=1` — if set, the sd-event event loop implementation
42 will print latency information at runtime.
43
53aa0d02 44* `$SYSTEMD_PROC_CMDLINE` — if set, the contents are used as the kernel command
e7b86e48 45 line instead of the actual one in `/proc/cmdline`. This is useful for
53aa0d02
ZJS
46 debugging, in order to test generators and other code against specific kernel
47 command lines.
48
df78419d
ZJS
49* `$SYSTEMD_OS_RELEASE` — if set, use this path instead of `/etc/os-release` or
50 `/usr/lib/os-release`. When operating under some root (e.g. `systemctl
5cf69e70 51 --root=…`), the path is prefixed with the root. Only useful for debugging.
df78419d 52
e7b86e48 53* `$SYSTEMD_FSTAB` — if set, use this path instead of `/etc/fstab`. Only useful
ed4ad488
ZJS
54 for debugging.
55
99e3d476
ZJS
56* `$SYSTEMD_SYSROOT_FSTAB` — if set, use this path instead of
57 `/sysroot/etc/fstab`. Only useful for debugging `systemd-fstab-generator`.
58
905dd992
LF
59* `$SYSTEMD_SYSFS_CHECK` — takes a boolean. If set, overrides sysfs container
60 detection that ignores `/dev/` entries in fstab. Only useful for debugging
61 `systemd-fstab-generator`.
62
e7b86e48
ZJS
63* `$SYSTEMD_CRYPTTAB` — if set, use this path instead of `/etc/crypttab`. Only
64 useful for debugging. Currently only supported by
65 `systemd-cryptsetup-generator`.
a6c57e74 66
1f1a2243
TA
67* `$SYSTEMD_INTEGRITYTAB` — if set, use this path instead of
68 `/etc/integritytab`. Only useful for debugging. Currently only supported by
69 `systemd-integritysetup-generator`.
70
e7b86e48
ZJS
71* `$SYSTEMD_VERITYTAB` — if set, use this path instead of
72 `/etc/veritytab`. Only useful for debugging. Currently only supported by
73 `systemd-veritysetup-generator`.
08b04ec7 74
2536752d 75* `$SYSTEMD_EFI_OPTIONS` — if set, used instead of the string in the
e7b86e48 76 `SystemdOptions` EFI variable. Analogous to `$SYSTEMD_PROC_CMDLINE`.
2467cc55 77
05c6f341
ZJS
78* `$SYSTEMD_DEFAULT_HOSTNAME` — override the compiled-in fallback hostname
79 (relevant in particular for the system manager and `systemd-hostnamed`).
80 Must be a valid hostname (either a single label or a FQDN).
81
b1fd5cd4
ZJS
82* `$SYSTEMD_IN_INITRD` — takes a boolean. If set, overrides initrd detection.
83 This is useful for debugging and testing initrd-only programs in the main
84 system.
0307ea49 85
385b2eb2
YW
86* `$SYSTEMD_BUS_TIMEOUT=SECS` — specifies the maximum time to wait for method call
87 completion. If no time unit is specified, assumes seconds. The usual other units
88 are understood, too (us, ms, s, min, h, d, w, month, y). If it is not set or set
89 to 0, then the built-in default is used.
90
5f1b0cc6 91* `$SYSTEMD_MEMPOOL=0` — if set, the internal memory caching logic employed by
e7b86e48 92 hash tables is turned off, and libc `malloc()` is used for all allocations.
b4f60743 93
71ea8436
LP
94* `$SYSTEMD_UTF8=` — takes a boolean value, and overrides whether to generate
95 non-ASCII special glyphs at various places (i.e. "→" instead of
1a127aa0 96 "->"). Usually this is determined automatically, based on `$LC_CTYPE`, but in
71ea8436
LP
97 scenarios where locale definitions are not installed it might make sense to
98 override this check explicitly.
99
e7b86e48 100* `$SYSTEMD_EMOJI=0` — if set, tools such as `systemd-analyze security` will
5f1b0cc6
LP
101 not output graphical smiley emojis, but ASCII alternatives instead. Note that
102 this only controls use of Unicode emoji glyphs, and has no effect on other
103 Unicode glyphs.
104
3f5ac303 105* `$RUNTIME_DIRECTORY` — various tools use this variable to locate the
e7b86e48
ZJS
106 appropriate path under `/run/`. This variable is also set by the manager when
107 `RuntimeDirectory=` is used, see systemd.exec(5).
3f5ac303 108
42f3b2f9 109* `$SYSTEMD_CRYPT_PREFIX` — if set configures the hash method prefix to use for
e7b86e48
ZJS
110 UNIX `crypt()` when generating passwords. By default the system's "preferred
111 method" is used, but this can be overridden with this environment variable.
112 Takes a prefix such as `$6$` or `$y$`. (Note that this is only honoured on
113 systems built with libxcrypt and is ignored on systems using glibc's
114 original, internal `crypt()` implementation.)
42f3b2f9 115
54dcf847 116* `$SYSTEMD_SECCOMP=0` — if set, seccomp filters will not be enforced, even if
ce8f6d47
LP
117 support for it is compiled in and available in the kernel.
118
119* `$SYSTEMD_LOG_SECCOMP=1` — if set, system calls blocked by seccomp filtering,
e7b86e48
ZJS
120 for example in `systemd-nspawn`, will be logged to the audit log, if the
121 kernel supports this.
ce8f6d47 122
7c7a9138 123* `$SYSTEMD_ENABLE_LOG_CONTEXT` — if set, extra fields will always be logged to
52afaee7
YW
124 the journal instead of only when logging in debug mode.
125
126* `$SYSTEMD_NETLINK_DEFAULT_TIMEOUT` — specifies the default timeout of waiting
127 replies for netlink messages from the kernel. Defaults to 25 seconds.
7c7a9138 128
e7b86e48 129`systemctl`:
4549fcdb 130
8f1a581e 131* `$SYSTEMCTL_FORCE_BUS=1` — if set, do not connect to PID 1's private D-Bus
4549fcdb
LP
132 listener, and instead always connect through the dbus-daemon D-bus broker.
133
134* `$SYSTEMCTL_INSTALL_CLIENT_SIDE=1` — if set, enable or disable unit files on
135 the client side, instead of asking PID 1 to do this.
136
e7b86e48 137* `$SYSTEMCTL_SKIP_SYSV=1` — if set, do not call SysV compatibility hooks.
4549fcdb 138
e7b86e48 139`systemd-nspawn`:
4549fcdb 140
e7b86e48
ZJS
141* `$SYSTEMD_NSPAWN_UNIFIED_HIERARCHY=1` — if set, force `systemd-nspawn` into
142 unified cgroup hierarchy mode.
4549fcdb 143
e7b86e48
ZJS
144* `$SYSTEMD_NSPAWN_API_VFS_WRITABLE=1` — if set, make `/sys/`, `/proc/sys/`,
145 and friends writable in the container. If set to "network", leave only
146 `/proc/sys/net/` writable.
4549fcdb
LP
147
148* `$SYSTEMD_NSPAWN_CONTAINER_SERVICE=…` — override the "service" name nspawn
149 uses to register with machined. If unset defaults to "nspawn", but with this
150 variable may be set to any other value.
151
152* `$SYSTEMD_NSPAWN_USE_CGNS=0` — if set, do not use cgroup namespacing, even if
153 it is available.
154
155* `$SYSTEMD_NSPAWN_LOCK=0` — if set, do not lock container images when running.
156
e7b86e48 157* `$SYSTEMD_NSPAWN_TMPFS_TMP=0` — if set, do not overmount `/tmp/` in the
1099ceeb
LP
158 container with a tmpfs, but leave the directory from the image in place.
159
4a4654e0
LP
160* `$SYSTEMD_SUPPRESS_SYNC=1` — if set, all disk synchronization syscalls are
161 blocked to the container payload (e.g. `sync()`, `fsync()`, `syncfs()`, …)
162 and the `O_SYNC`/`O_DSYNC` flags are made unavailable to `open()` and
163 friends. This is equivalent to passing `--suppress-sync=yes` on the
164 `systemd-nspawn` command line.
165
e7b86e48 166`systemd-logind`:
4549fcdb
LP
167
168* `$SYSTEMD_BYPASS_HIBERNATION_MEMORY_CHECK=1` — if set, report that
169 hibernation is available even if the swap devices do not provide enough room
170 for it.
94fa1497 171
e7b86e48
ZJS
172* `$SYSTEMD_REBOOT_TO_FIRMWARE_SETUP` — if set, overrides `systemd-logind`'s
173 built-in EFI logic of requesting a reboot into the firmware. Takes a boolean.
174 If set to false, the functionality is turned off entirely. If set to true,
175 instead of requesting a reboot into the firmware setup UI through EFI a file,
176 `/run/systemd/reboot-to-firmware-setup` is created whenever this is
e86c7a3a
LP
177 requested. This file may be checked for by services run during system
178 shutdown in order to request the appropriate operation from the firmware in
179 an alternative fashion.
180
181* `$SYSTEMD_REBOOT_TO_BOOT_LOADER_MENU` — similar to the above, allows
e7b86e48
ZJS
182 overriding of `systemd-logind`'s built-in EFI logic of requesting a reboot
183 into the boot loader menu. Takes a boolean. If set to false, the
184 functionality is turned off entirely. If set to true, instead of requesting a
185 reboot into the boot loader menu through EFI, the file
186 `/run/systemd/reboot-to-boot-loader-menu` is created whenever this is
187 requested. The file contains the requested boot loader menu timeout in µs,
188 formatted in ASCII decimals, or zero in case no timeout is requested. This
189 file may be checked for by services run during system shutdown in order to
190 request the appropriate operation from the boot loader in an alternative
191 fashion.
e86c7a3a
LP
192
193* `$SYSTEMD_REBOOT_TO_BOOT_LOADER_ENTRY` — similar to the above, allows
e7b86e48
ZJS
194 overriding of `systemd-logind`'s built-in EFI logic of requesting a reboot
195 into a specific boot loader entry. Takes a boolean. If set to false, the
196 functionality is turned off entirely. If set to true, instead of requesting a
197 reboot into a specific boot loader entry through EFI, the file
e86c7a3a
LP
198 `/run/systemd/reboot-to-boot-loader-entry` is created whenever this is
199 requested. The file contains the requested boot loader entry identifier. This
200 file may be checked for by services run during system shutdown in order to
201 request the appropriate operation from the boot loader in an alternative
5c90c67a 202 fashion. Note that by default only boot loader entries which follow the
db811444
ZJS
203 [Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification)
204 and are placed in the ESP or the Extended Boot Loader partition may be
205 selected this way. However, if a directory `/run/boot-loader-entries/`
206 exists, the entries are loaded from there instead. The directory should
207 contain the usual directory hierarchy mandated by the Boot Loader
208 Specification, i.e. the entry drop-ins should be placed in
e86c7a3a
LP
209 `/run/boot-loader-entries/loader/entries/*.conf`, and the files referenced by
210 the drop-ins (including the kernels and initrds) somewhere else below
211 `/run/boot-loader-entries/`. Note that all these files may be (and are
e7b86e48 212 supposed to be) symlinks. `systemd-logind` will load these files on-demand,
e86c7a3a
LP
213 these files can hence be updated (ideally atomically) whenever the boot
214 loader configuration changes. A foreign boot loader installer script should
215 hence synthesize drop-in snippets and symlinks for all boot entries at boot
e7b86e48
ZJS
216 or whenever they change if it wants to integrate with `systemd-logind`'s
217 APIs.
e86c7a3a 218
a7910612 219`systemd-udevd` and sd-device library:
679dab6a 220
54dcf847 221* `$NET_NAMING_SCHEME=` — if set, takes a network naming scheme (i.e. one of
679dab6a 222 "v238", "v239", "v240"…, or the special value "latest") as parameter. If
e7b86e48
ZJS
223 specified udev's `net_id` builtin will follow the specified naming scheme
224 when determining stable network interface names. This may be used to revert
225 to naming schemes of older udev versions, in order to provide more stable
226 naming across updates. This environment variable takes precedence over the
227 kernel command line option `net.naming-scheme=`, except if the value is
228 prefixed with `:` in which case the kernel command line option takes
229 precedence, if it is specified as well.
679dab6a 230
a7910612
LP
231* `$SYSTEMD_DEVICE_VERIFY_SYSFS` — if set to "0", disables verification that
232 devices sysfs path are actually backed by sysfs. Relaxing this verification
233 is useful for testing purposes.
234
e7b86e48 235`nss-systemd`:
dba1bd43
LP
236
237* `$SYSTEMD_NSS_BYPASS_SYNTHETIC=1` — if set, `nss-systemd` won't synthesize
238 user/group records for the `root` and `nobody` users if they are missing from
239 `/etc/passwd`.
240
241* `$SYSTEMD_NSS_DYNAMIC_BYPASS=1` — if set, `nss-systemd` won't return
242 user/group records for dynamically registered service users (i.e. users
243 registered through `DynamicUser=1`).
244
e7b86e48 245`systemd-timedated`:
41d0da0f
YW
246
247* `$SYSTEMD_TIMEDATED_NTP_SERVICES=…` — colon-separated list of unit names of
248 NTP client services. If set, `timedatectl set-ntp on` enables and starts the
249 first existing unit listed in the environment variable, and
250 `timedatectl set-ntp off` disables and stops all listed units.
39922217 251
e7b86e48 252`systemd-sulogin-shell`:
33eb44fe
AH
253
254* `$SYSTEMD_SULOGIN_FORCE=1` — This skips asking for the root password if the
255 root password is not available (such as when the root account is locked).
256 See `sulogin(8)` for more details.
257
e7b86e48 258`bootctl` and other tools that access the EFI System Partition (ESP):
8cbb7d87
LP
259
260* `$SYSTEMD_RELAX_ESP_CHECKS=1` — if set, the ESP validation checks are
261 relaxed. Specifically, validation checks that ensure the specified ESP path
262 is a FAT file system are turned off, as are checks that the path is located
263 on a GPT partition with the correct type UUID.
264
cc7a0bfa
LP
265* `$SYSTEMD_ESP_PATH=…` — override the path to the EFI System Partition. This
266 may be used to override ESP path auto detection, and redirect any accesses to
e7b86e48
ZJS
267 the ESP to the specified directory. Note that unlike with `bootctl`'s
268 `--path=` switch only very superficial validation of the specified path is
269 done when this environment variable is used.
cc7a0bfa 270
2e76ca79
LN
271* `$KERNEL_INSTALL_CONF_ROOT=…` — override the built in default configuration
272 directory /etc/kernel/ to read files like entry-token and install.conf from.
273
e7b86e48 274`systemd` itself:
39922217
LP
275
276* `$SYSTEMD_ACTIVATION_UNIT` — set for all NSS and PAM module invocations that
277 are done by the service manager on behalf of a specific unit, in child
278 processes that are later (after execve()) going to become unit
279 processes. Contains the full unit name (e.g. "foobar.service"). NSS and PAM
280 modules can use this information to determine in which context and on whose
281 behalf they are being called, which may be useful to avoid deadlocks, for
282 example to bypass IPC calls to the very service that is about to be
283 started. Note that NSS and PAM modules should be careful to only rely on this
284 data when invoked privileged, or possibly only when getppid() returns 1, as
285 setting environment variables is of course possible in any even unprivileged
286 contexts.
287
288* `$SYSTEMD_ACTIVATION_SCOPE` — closely related to `$SYSTEMD_ACTIVATION_UNIT`,
289 it is either set to `system` or `user` depending on whether the NSS/PAM
290 module is called by systemd in `--system` or `--user` mode.
59f13dd6 291
88e4bfa6
MS
292* `$SYSTEMD_SUPPORT_DEVICE`, `$SYSTEMD_SUPPORT_MOUNT`, `$SYSTEMD_SUPPORT_SWAP` -
293 can be set to `0` to mark respective unit type as unsupported. Generally,
294 having less units saves system resources so these options might be useful
295 for cases where we don't need to track given unit type, e.g. `--user` manager
296 often doesn't need to deal with device or swap units because they are
297 handled by the `--system` manager (PID 1). Note that setting certain unit
298 type as unsupported may not prevent loading some units of that type if they
299 are referenced by other units of another supported type.
300
24a4542c
LB
301* `$SYSTEMD_DEFAULT_MOUNT_RATE_LIMIT_BURST` — can be set to override the mount
302 units burst rate limit for parsing `/proc/self/mountinfo`. On a system with
303 few resources but many mounts the rate limit may be hit, which will cause the
304 processing of mount units to stall. The burst limit may be adjusted when the
305 default is not appropriate for a given system. Defaults to `5`, accepts
306 positive integers.
307
e7b86e48 308`systemd-remount-fs`:
59f13dd6 309
d238709c 310* `$SYSTEMD_REMOUNT_ROOT_RW=1` — if set and no entry for the root directory
e7b86e48 311 exists in `/etc/fstab` (this file always takes precedence), then the root
59f13dd6 312 directory is remounted writable. This is primarily used by
e7b86e48 313 `systemd-gpt-auto-generator` to ensure the root partition is mounted writable
59f13dd6 314 in accordance to the GPT partition flags.
a7d9fccd 315
e7b86e48 316`systemd-firstboot` and `localectl`:
a7d9fccd 317
54dcf847 318* `$SYSTEMD_LIST_NON_UTF8_LOCALES=1` — if set, non-UTF-8 locales are listed among
a7d9fccd
LP
319 the installed ones. By default non-UTF-8 locales are suppressed from the
320 selection, since we are living in the 21st century.
7a87fb61 321
d8962609
JM
322`systemd-resolved`:
323
324* `$SYSTEMD_RESOLVED_SYNTHESIZE_HOSTNAME` — if set to "0", `systemd-resolved`
325 won't synthesize system hostname on both regular and reverse lookups.
326
e7b86e48 327`systemd-sysext`:
7a87fb61 328
54dcf847 329* `$SYSTEMD_SYSEXT_HIERARCHIES` — this variable may be used to override which
e7b86e48
ZJS
330 hierarchies are managed by `systemd-sysext`. By default only `/usr/` and
331 `/opt/` are managed, and directories may be added or removed to that list by
332 setting this environment variable to a colon-separated list of absolute
333 paths. Only "real" file systems and directories that only contain "real" file
334 systems as submounts should be used. Do not specify API file systems such as
335 `/proc/` or `/sys/` here, or hierarchies that have them as submounts. In
1f4f1666 336 particular, do not specify the root directory `/` here. Similarly,
337 `$SYSTEMD_CONFEXT_HIERARCHIES` works for confext images and supports the
338 systemd-confext multi-call functionality of sysext.
4368c60c 339
e7b86e48 340`systemd-tmpfiles`:
4368c60c 341
54dcf847 342* `$SYSTEMD_TMPFILES_FORCE_SUBVOL` — if unset, `v`/`q`/`Q` lines will create
e7b86e48
ZJS
343 subvolumes only if the OS itself is installed into a subvolume. If set to `1`
344 (or another value interpreted as true), these lines will always create
345 subvolumes if the backing filesystem supports them. If set to `0`, these
346 lines will always create directories.
07dc08c2 347
3fa8a114
JSMR
348`systemd-sysusers`
349
e24c6676 350* `$SOURCE_DATE_EPOCH` — if unset, the field of the date of last password change
3fa8a114 351 in `/etc/shadow` will be the number of days from Jan 1, 1970 00:00 UTC until
1a127aa0 352 today. If `$SOURCE_DATE_EPOCH` is set to a valid UNIX epoch value in seconds,
3fa8a114
JSMR
353 then the field will be the number of days until that time instead. This is to
354 support creating bit-by-bit reproducible system images by choosing a
355 reproducible value for the field of the date of last password change in
356 `/etc/shadow`. See: https://reproducible-builds.org/specs/source-date-epoch/
357
07dc08c2
ZJS
358`systemd-sysv-generator`:
359
360* `$SYSTEMD_SYSVINIT_PATH` — Controls where `systemd-sysv-generator` looks for
361 SysV init scripts.
362
363* `$SYSTEMD_SYSVRCND_PATH` — Controls where `systemd-sysv-generator` looks for
364 SysV init script runlevel link farms.
48eb2af6 365
f0cb09bb
ZJS
366systemd tests:
367
368* `$SYSTEMD_TEST_DATA` — override the location of test data. This is useful if
369 a test executable is moved to an arbitrary location.
370
371* `$SYSTEMD_TEST_NSS_BUFSIZE` — size of scratch buffers for "reentrant"
372 functions exported by the nss modules.
373
7e81ce6b
LP
374* `$TESTFUNCS` – takes a colon separated list of test functions to invoke,
375 causes all non-matching test functions to be skipped. Only applies to tests
376 using our regular test boilerplate.
377
48eb2af6
ZJS
378fuzzers:
379
380* `$SYSTEMD_FUZZ_OUTPUT` — A boolean that specifies whether to write output to
381 stdout. Setting to true is useful in manual invocations, since all output is
382 suppressed by default.
383
384* `$SYSTEMD_FUZZ_RUNS` — The number of times execution should be repeated in
385 manual invocations.
386
f223fd6a 387Note that it may be also useful to set `$SYSTEMD_LOG_LEVEL`, since all logging
48eb2af6 388is suppressed by default.
23851640 389
54dcf847 390`systemd-importd`:
23851640 391
54dcf847 392* `$SYSTEMD_IMPORT_BTRFS_SUBVOL` — takes a boolean, which controls whether to
23851640
LP
393 prefer creating btrfs subvolumes over plain directories for machine
394 images. Has no effect on non-btrfs file systems where subvolumes are not
395 available anyway. If not set, defaults to true.
396
54dcf847 397* `$SYSTEMD_IMPORT_BTRFS_QUOTA` — takes a boolean, which controls whether to set
23851640
LP
398 up quota automatically for created btrfs subvolumes for machine images. If
399 not set, defaults to true. Has no effect if machines are placed in regular
400 directories, because btrfs subvolumes are not supported or disabled. If
401 enabled, the quota group of the subvolume is automatically added to a
402 combined quota group for all such machine subvolumes.
403
54dcf847 404* `$SYSTEMD_IMPORT_SYNC` — takes a boolean, which controls whether to
23851640
LP
405 synchronize images to disk after installing them, before completing the
406 operation. If not set, defaults to true. If disabled installation of images
407 will be quicker, but not as safe.
54dcf847
LP
408
409`systemd-dissect`, `systemd-nspawn` and all other tools that may operate on
410disk images with `--image=` or similar:
411
412* `$SYSTEMD_DISSECT_VERITY_SIDECAR` — takes a boolean, which controls whether to
413 load "sidecar" Verity metadata files. If enabled (which is the default),
414 whenever a disk image is used, a set of files with the `.roothash`,
415 `.usrhash`, `.roothash.p7s`, `.usrhash.p7s`, `.verity` suffixes are searched
416 adjacent to disk image file, containing the Verity root hashes, their
417 signatures or the Verity data itself. If disabled this automatic discovery of
418 Verity metadata files is turned off.
419
420* `$SYSTEMD_DISSECT_VERITY_EMBEDDED` — takes a boolean, which controls whether
421 to load the embedded Verity signature data. If enabled (which is the
422 default), Verity root hash information and a suitable signature is
423 automatically acquired from a signature partition, following the
db811444 424 [Discoverable Partitions Specification](https://uapi-group.org/specifications/specs/discoverable_partitions_specification).
5c90c67a
BF
425 If disabled any such partition is ignored. Note that this only disables
426 discovery of the root hash and its signature, the Verity data partition
427 itself is still searched in the GPT image.
54dcf847
LP
428
429* `$SYSTEMD_DISSECT_VERITY_SIGNATURE` — takes a boolean, which controls whether
430 to validate the signature of the Verity root hash if available. If enabled
431 (which is the default), the signature of suitable disk images is validated
432 against any of the certificates in `/etc/verity.d/*.crt` (and similar
ba669952 433 directories in `/usr/lib/`, `/run`, …) or passed to the kernel for validation
54dcf847 434 against its built-in certificates.
ccd25f41 435
2b660510
YW
436* `$SYSTEMD_DISSECT_VERITY_TIMEOUT_SEC=sec` — takes a timespan, which controls
437 the timeout waiting for the image to be configured. Defaults to 100 msec.
438
80ce8580
LP
439* `$SYSTEMD_DISSECT_FILE_SYSTEMS=` — takes a colon-separated list of file
440 systems that may be mounted for automatically dissected disk images. If not
441 specified defaults to something like: `ext4:btrfs:xfs:vfat:erofs:squashfs`
442
e8c7c4d9 443* `$SYSTEMD_LOOP_DIRECT_IO` – takes a boolean, which controls whether to enable
1a127aa0 444 `LO_FLAGS_DIRECT_IO` (i.e. direct IO + asynchronous IO) on loopback block
e8c7c4d9
LP
445 devices when opening them. Defaults to on, set this to "0" to disable this
446 feature.
447
ccd25f41
LP
448`systemd-cryptsetup`:
449
450* `$SYSTEMD_CRYPTSETUP_USE_TOKEN_MODULE` – takes a boolean, which controls
451 whether to use the libcryptsetup "token" plugin module logic even when
452 activating via FIDO2, PKCS#11, TPM2, i.e. mechanisms natively supported by
453 `systemd-cryptsetup`. Defaults to enabled.
c04358ce
LP
454
455Various tools that read passwords from the TTY, such as `systemd-cryptenroll`
456and `homectl`:
457
458* `$PASSWORD` — takes a string: the literal password to use. If this
459 environment variable is set it is used as password instead of prompting the
460 user interactively. This exists primarily for debugging and testing
461 purposes. Do not use this for production code paths, since environment
462 variables are typically inherited down the process tree without restrictions
463 and should thus not be used for secrets.
464
465* `$NEWPASSWORD` — similar to `$PASSWORD` above, but is used when both a
466 current and a future password are required, for example if the password is to
467 be changed. In that case `$PASSWORD` shall carry the current (i.e. old)
468 password and `$NEWPASSWORD` the new.
67302b38
LP
469
470`systemd-homed`:
471
472* `$SYSTEMD_HOME_ROOT` – defines an absolute path where to look for home
473 directories/images. When unspecified defaults to `/home/`. This is useful for
474 debugging purposes in order to run a secondary `systemd-homed` instance that
475 operates on a different directory where home directories/images are placed.
476
477* `$SYSTEMD_HOME_RECORD_DIR` – defines an absolute path where to look for
478 fixated home records kept on the host. When unspecified defaults to
479 `/var/lib/systemd/home/`. Similar to `$SYSTEMD_HOME_ROOT` this is useful for
480 debugging purposes, in order to run a secondary `systemd-homed` instance that
481 operates on a record database entirely separate from the host's.
482
483* `$SYSTEMD_HOME_DEBUG_SUFFIX` – takes a short string that is suffixed to
484 `systemd-homed`'s D-Bus and Varlink service names/sockets. This is also
a6f44d61 485 understood by `homectl`. This too is useful for running an additional copy of
67302b38
LP
486 `systemd-homed` that doesn't interfere with the host's main one.
487
488* `$SYSTEMD_HOMEWORK_PATH` – configures the path to the `systemd-homework`
489 binary to invoke. If not specified defaults to
490 `/usr/lib/systemd/systemd-homework`.
491
492 Combining these four environment variables is pretty useful when
493 debugging/developing `systemd-homed`:
494```sh
495SYSTEMD_HOME_DEBUG_SUFFIX=foo \
496 SYSTEMD_HOMEWORK_PATH=/home/lennart/projects/systemd/build/systemd-homework \
497 SYSTEMD_HOME_ROOT=/home.foo/ \
498 SYSTEMD_HOME_RECORD_DIR=/var/lib/systemd/home.foo/ \
499 /home/lennart/projects/systemd/build/systemd-homed
500```
db42f011
LP
501
502* `$SYSTEMD_HOME_MOUNT_OPTIONS_BTRFS`, `$SYSTEMD_HOME_MOUNT_OPTIONS_EXT4`,
503 `$SYSTEMD_HOME_MOUNT_OPTIONS_XFS` – configure the default mount options to
504 use for LUKS home directories, overriding the built-in default mount
505 options. There's one variable for each of the supported file systems for the
506 LUKS home directory backend.
a2a9d541 507
8f30c00c
AD
508* `$SYSTEMD_HOME_MKFS_OPTIONS_BTRFS`, `$SYSTEMD_HOME_MKFS_OPTIONS_EXT4`,
509 `$SYSTEMD_HOME_MKFS_OPTIONS_XFS` – configure additional arguments to use for
510 `mkfs` when formatting LUKS home directories. There's one variable for each
511 of the supported file systems for the LUKS home directory backend.
512
a2a9d541
DDM
513`kernel-install`:
514
515* `$KERNEL_INSTALL_BYPASS` – If set to "1", execution of kernel-install is skipped
516 when kernel-install is invoked. This can be useful if kernel-install is invoked
517 unconditionally as a child process by another tool, such as package managers
518 running kernel-install in a postinstall script.
61297656 519
fba84e12 520`systemd-journald`, `journalctl`:
61297656 521
6337be0a 522* `$SYSTEMD_JOURNAL_COMPACT` – Takes a boolean. If enabled, journal files are written
61297656
DDM
523 in a more compact format that reduces the amount of disk space required by the
524 journal. Note that journal files in compact mode are limited to 4G to allow use of
525 32-bit offsets. Enabled by default.
6337be0a 526
1f06ea74
YW
527* `$SYSTEMD_JOURNAL_COMPRESS` – Takes a boolean, or one of the compression
528 algorithms "XZ", "LZ4", and "ZSTD". If enabled, the default compression
529 algorithm set at compile time will be used when opening a new journal file.
530 If disabled, the journal file compression will be disabled. Note that the
531 compression mode of existing journal files are not changed. To make the
532 specified algorithm takes an effect immediately, you need to explicitly run
533 `journalctl --rotate`.
534
fba84e12
LP
535* `$SYSTEMD_CATALOG` – path to the compiled catalog database file to use for
536 `journalctl -x`, `journalctl --update-catalog`, `journalctl --list-catalog`
537 and related calls.
538
539* `$SYSTEMD_CATALOG_SOURCES` – path to the catalog database input source
540 directory to use for `journalctl --update-catalog`.
541
32295fa0 542`systemd-pcrextend`, `systemd-cryptsetup`:
6337be0a 543
6c51b49c
LP
544* `$SYSTEMD_FORCE_MEASURE=1` — If set, force measuring of resources (which are
545 marked for measurement) even if not booted on a kernel equipped with
546 systemd-stub. Normally, requested measurement of resources is conditionalized
547 on kernels that have booted with `systemd-stub`. With this environment
548 variable the test for that my be bypassed, for testing purposes.
4b8ce14f
DDM
549
550`systemd-repart`:
551
552* `$SYSTEMD_REPART_MKFS_OPTIONS_<FSTYPE>` – configure additional arguments to use for
553 `mkfs` when formatting partition file systems. There's one variable for each
554 of the supported file systems.
e59049d7
LP
555
556* `$SYSTEMD_REPART_OVERRIDE_FSTYPE` – if set the value will override the file
557 system type specified in Format= lines in partition definition files.