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 or more positional arguments must be
48           specified. All configuration files found in the directories listed
49           in sysusers.d(5) will be read, and the configuration given on the
50           command line will be handled instead of and with the same priority
51           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       --dry-run
75           Process the configuration and figure out what entries would be
76           created, but don't actually write anything.
77
78       --inline
79           Treat each positional argument as a separate configuration line
80           instead of a file name.
81
82       --cat-config
83           Copy the contents of config files to standard output. Before each
84           file, the filename is printed as a comment.
85
86       --no-pager
87           Do not pipe output into a pager.
88
89       -h, --help
90           Print a short help text and exit.
91
92       --version
93           Print a short version string and exit.
94

CREDENTIALS

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

EXIT STATUS

140       On success, 0 is returned, a non-zero failure code otherwise.
141

SEE ALSO

143       systemd(1), sysusers.d(5), Users, Groups, UIDs and GIDs on systemd
144       systems[2], systemd.exec(1), mkpasswd(1)
145

NOTES

147        1. Discoverable Partitions Specification
148           https://systemd.io/DISCOVERABLE_PARTITIONS
149
150        2. Users, Groups, UIDs and GIDs on systemd systems
151           https://systemd.io/UIDS-GIDS
152
153
154
155systemd 251                                                SYSTEMD-SYSUSERS(8)
Impressum