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