1SYSTEMD-SYSUSERS(8)            systemd-sysusers            SYSTEMD-SYSUSERS(8)
2
3
4

NAME

6       systemd-sysusers, systemd-sysusers.service - Allocate system users and
7       groups
8

SYNOPSIS

10       systemd-sysusers [OPTIONS...] [CONFIGFILE...]
11
12       systemd-sysusers.service
13

DESCRIPTION

15       systemd-sysusers creates system users and groups, based on the file
16       format and location specified in sysusers.d(5).
17
18       If invoked with no arguments, it applies all directives from all files
19       found in the directories specified by sysusers.d(5). When invoked with
20       positional arguments, if option --replace=PATH is specified, arguments
21       specified on the command line are used instead of the configuration
22       file PATH. Otherwise, just the configuration specified by the command
23       line arguments is executed. The string "-" may be specified instead of
24       a filename to instruct systemd-sysusers to read the configuration from
25       standard input. If only the basename of a file is specified, all
26       configuration directories are searched for a matching file and the file
27       found that has the highest priority is executed.
28

OPTIONS

30       The following options are understood:
31
32       --root=root
33           Takes a directory path as an argument. All paths will be prefixed
34           with the given alternate root path, including config search paths.
35
36       --image=image
37           Takes a path to a disk image file or block device node. If
38           specified all operations are applied to file system in the
39           indicated disk image. This is similar to --root= but operates on
40           file systems stored in disk images or block devices. The disk image
41           should either contain just a file system or a set of file systems
42           within a GPT partition table, following the Discoverable Partitions
43           Specification[1]. For further information on supported disk images,
44           see systemd-nspawn(1)'s switch of the same name.
45
46       --replace=PATH
47           When this option is given, one ore more positional arguments must
48           be specified. All configuration files found in the directories
49           listed in sysusers.d(5) will be read, and the configuration given
50           on the command line will be handled instead of and with the same
51           priority as the configuration file PATH.
52
53           This option is intended to be used when package installation
54           scripts are running and files belonging to that package are not yet
55           available on disk, so their contents must be given on the command
56           line, but the admin configuration might already exist and should be
57           given higher priority.
58
59           Example 1. RPM installation script for radvd
60
61               echo 'u radvd - "radvd daemon"' | \
62                         systemd-sysusers --replace=/usr/lib/sysusers.d/radvd.conf -
63
64           This will create the radvd user as if
65           /usr/lib/sysusers.d/radvd.conf was already on disk. An admin might
66           override the configuration specified on the command line by placing
67           /etc/sysusers.d/radvd.conf or even
68           /etc/sysusers.d/00-overrides.conf.
69
70           Note that this is the expanded form, and when used in a package,
71           this would be written using a macro with "radvd" and a file
72           containing the configuration line as arguments.
73
74       --inline
75           Treat each positional argument as a separate configuration line
76           instead of a file name.
77
78       --cat-config
79           Copy the contents of config files to standard output. Before each
80           file, the filename is printed as a comment.
81
82       --no-pager
83           Do not pipe output into a pager.
84
85       -h, --help
86           Print a short help text and exit.
87
88       --version
89           Print a short version string and exit.
90

CREDENTIALS

92       systemd-sysusers supports the service credentials logic as implemented
93       by LoadCredential=/SetCredential= (see systemd.exec(1) for details).
94       The following credentials are used when passed in:
95
96       "passwd.hashed-password.user"
97           A UNIX hashed password string to use for the specified user, when
98           creating an entry for it. This is particularly useful for the
99           "root" user as it allows provisioning the default root password to
100           use via a unit file drop-in or from a container manager passing in
101           this credential. Note that setting this credential has no effect if
102           the specified user account already exists. This credential is hence
103           primarily useful in first boot scenarios or systems that are fully
104           stateless and come up with an empty /etc/ on every boot.
105
106       "passwd.plaintext-password.user"
107           Similar to "passwd.hashed-password.user" but expect a literal,
108           plaintext password, which is then automatically hashed before used
109           for the user account. If both the hashed and the plaintext
110           credential are specified for the same user the former takes
111           precedence. It's generally recommended to specify the hashed
112           version; however in test environments with weaker requirements on
113           security it might be easier to pass passwords in plaintext instead.
114
115       "passwd.shell.user"
116           Specifies the shell binary to use for the specified account when
117           creating it.
118
119       Note that by default the systemd-sysusers.service unit file is set up
120       to inherit the "passwd.hashed-password.root",
121       "passwd.plaintext-password.root" and "passwd.shell.root" credentials
122       from the service manager. Thus, when invoking a container with an
123       unpopulated /etc/ for the first time it is possible to configure the
124       root user's password to be "systemd" like this:
125
126           # systemd-nspawn --image=... --set-credential=password.hashed-password.root:'$y$j9T$yAuRJu1o5HioZAGDYPU5d.$F64ni6J2y2nNQve90M/p0ZP0ECP/qqzipNyaY9fjGpC' ...
127
128       Note again that the data specified in these credentials is consulted
129       only when creating an account for the first time, it may not be used
130       for changing the password or shell of an account that already exists.
131
132       Use mkpasswd(1) for generating UNIX password hashes from the command
133       line.
134

EXIT STATUS

136       On success, 0 is returned, a non-zero failure code otherwise.
137

SEE ALSO

139       systemd(1), sysusers.d(5), Users, Groups, UIDs and GIDs on systemd
140       systems[2], systemd.exec(1), mkpasswd(1)
141

NOTES

143        1. Discoverable Partitions Specification
144           https://systemd.io/DISCOVERABLE_PARTITIONS
145
146        2. Users, Groups, UIDs and GIDs on systemd systems
147           https://systemd.io/UIDS-GIDS
148
149
150
151systemd 249                                                SYSTEMD-SYSUSERS(8)
Impressum