path: root/upstream/debian-unstable/man5/sysusers.d.5

'\" t
.TH "SYSUSERS\&.D" "5" "" "systemd 256~rc3" "sysusers.d"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
sysusers.d \- Declarative allocation of system users and groups
.SH "SYNOPSIS"
.PP
.RS 4
/etc/sysusers\&.d/*\&.conf
.RE
.RS 4
/run/sysusers\&.d/*\&.conf
.RE
.RS 4
/usr/lib/sysusers\&.d/*\&.conf
.RE
.sp
.nf
#Type Name       ID                  GECOS              Home directory Shell
u     user_name  uid                 "User Description" /home/dir      /path/to/shell
u     user_name  uid:gid             "User Description" /home/dir      /path/to/shell
u     user_name  /file/owned/by/user "User Description" /home/dir      /path/to/shell
g     group_name gid
g     group_name /file/owned/by/group
m     user_name  group_name
r     \-          lowest\-highest
.fi
.SH "DESCRIPTION"
.PP
\fBsystemd\-sysusers\fR
uses the files from
sysusers\&.d
directory to create system users and groups and to add users to groups, at package installation or boot time\&. This tool may be used to allocate system users and groups only, it is not useful for creating non\-system (i\&.e\&. regular, "human") users and groups, as it accesses
/etc/passwd
and
/etc/group
directly, bypassing any more complex user databases, for example any database involving NIS or LDAP\&.
.SH "CONFIGURATION DIRECTORIES AND PRECEDENCE"
.PP
Each configuration file shall be named in the style of
\fIpackage\fR\&.conf
or
\fIpackage\fR\-\fIpart\fR\&.conf\&. The second variant should be used when it is desirable to make it easy to override just this part of configuration\&.
.PP
Files in
/etc/sysusers\&.d
override files with the same name in
/usr/lib/sysusers\&.d
and
/run/sysusers\&.d\&. Files in
/run/sysusers\&.d
override files with the same name in
/usr/lib/sysusers\&.d\&. Packages should install their configuration files in
/usr/lib/sysusers\&.d\&. Files in
/etc/sysusers\&.d
are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. All configuration files are sorted by their filename in lexicographic order, regardless of which of the directories they reside in\&. If multiple files specify the same path, the entry in the file with the lexicographically earliest name will be applied\&. All later entries for the same user and group names will be logged as warnings\&.
.PP
If the administrator wants to disable a configuration file supplied by the vendor, the recommended way is to place a symlink to
/dev/null
in
/etc/sysusers\&.d/
bearing the same filename\&.
.SH "CONFIGURATION FILE FORMAT"
.PP
The file format is one line per user or group containing name, ID, GECOS field description, home directory, and login shell:
.sp
.if n \{\
.RS 4
.\}
.nf
#Type Name     ID             GECOS                 Home directory Shell
u     httpd    404            "HTTP User"
u     _authd   /usr/bin/authd "Authorization user"
u     postgres \-              "Postgresql Database" /var/lib/pgsql /usr/libexec/postgresdb
g     input    \-              \-
m     _authd   input
u     root     0              "Superuser"           /root          /bin/zsh
r     \-        500\-900
.fi
.if n \{\
.RE
.\}
.PP
Empty lines and lines beginning with the
"#"
character are ignored, and may be used for commenting\&.
.SS "Type"
.PP
The type consists of a single letter\&. The following line types are understood:
.PP
\fIu\fR
.RS 4
Create a system user and group of the specified name should they not exist yet\&. The user\*(Aqs primary group will be set to the group bearing the same name unless the ID field specifies it\&. The account will be created disabled, so that logins are not allowed\&.
.sp
Added in version 215\&.
.RE
.PP
\fIg\fR
.RS 4
Create a system group of the specified name should it not exist yet\&. Note that
\fIu\fR
implicitly creates a matching group\&. The group will be created with no password set\&.
.sp
Added in version 215\&.
.RE
.PP
\fIm\fR
.RS 4
Add a user to a group\&. If the user or group do not exist yet, they will be implicitly created\&.
.sp
Added in version 215\&.
.RE
.PP
\fIr\fR
.RS 4
Add a range of numeric UIDs/GIDs to the pool to allocate new UIDs and GIDs from\&. If no line of this type is specified, the range of UIDs/GIDs is set to some compiled\-in default\&. Note that both UIDs and GIDs are allocated from the same pool, in order to ensure that users and groups of the same name are likely to carry the same numeric UID and GID\&.
.sp
Added in version 216\&.
.RE
.SS "Name"
.PP
The name field specifies the user or group name\&. The specified name must consist only of the characters a\-z, A\-Z, 0\-9,
"_"
and
"\-", except for the first character which must be one of a\-z, A\-Z or
"_"
(i\&.e\&. numbers and
"\-"
are not permitted as first character)\&. The user/group name must have at least one character, and at most 31\&.
.PP
For further details about the syntax of user/group names, see
\m[blue]\fBUser/Group Name Syntax\fR\m[]\&\s-2\u[1]\d\s+2\&.
.PP
It is strongly recommended to pick user and group names that are unlikely to clash with normal users created by the administrator\&. A good scheme to guarantee this is by prefixing all system and group names with the underscore, and avoiding too generic names\&.
.PP
For
\fIm\fR
lines, this field should contain the user name to add to a group\&.
.PP
For lines of type
\fIr\fR, this field should be set to
"\-"\&.
.SS "ID"
.PP
For
\fIu\fR
and
\fIg\fR, the numeric 32\-bit UID or GID of the user/group\&. Do not use IDs 65535 or 4294967295, as they have special placeholder meanings\&. Specify
"\-"
for automatic UID/GID allocation for the user or group (this is strongly recommended unless it is strictly necessary to use a specific UID or GID)\&. Alternatively, specify an absolute path in the file system\&. In this case, the UID/GID is read from the path\*(Aqs owner/group\&. This is useful to create users whose UID/GID match the owners of pre\-existing files (such as SUID or SGID binaries)\&. The syntaxes
"\fIuid\fR:\fIgid\fR"
and
"\fIuid\fR:\fIgroupname\fR"
are supported to allow creating users with specific primary groups\&. The given group must be created explicitly, or it must already exist\&. Specifying
"\-"
for the UID in these syntaxes is also supported\&.
.PP
For
\fIm\fR
lines, this field should contain the group name to add to a user to\&.
.PP
For lines of type
\fIr\fR, this field should be set to a UID/GID range in the format
"FROM\-TO", where both values are formatted as decimal ASCII numbers\&. Alternatively, a single UID/GID may be specified formatted as decimal ASCII numbers\&.
.SS "GECOS"
.PP
A short, descriptive string for users to be created, enclosed in quotation marks\&. Note that this field may not contain colons\&.
.PP
Only applies to lines of type
\fIu\fR
and should otherwise be left unset (or
"\-")\&.
.SS "Home Directory"
.PP
The home directory for a new system user\&. If omitted, defaults to the root directory\&.
.PP
Only applies to lines of type
\fIu\fR
and should otherwise be left unset (or
"\-")\&. It is recommended to omit this, unless software strictly requires a home directory to be set\&.
.PP
\fBsystemd\-sysusers\fR
only sets the home directory record in the user database\&. To actually create the directory, consider adding a corresponding
\fBtmpfiles.d\fR(5)
fragment\&.
.SS "Shell"
.PP
The login shell of the user\&. If not specified, this will be set to
/usr/sbin/nologin, except if the UID of the user is 0, in which case
/bin/sh
will be used\&.
.PP
Only applies to lines of type
\fIu\fR
and should otherwise be left unset (or
"\-")\&. It is recommended to omit this, unless a shell different
/usr/sbin/nologin
must be used\&.
.SH "SPECIFIERS"
.PP
Specifiers can be used in the
"Name",
"ID",
"GECOS",
"Home directory", and
"Shell"
fields\&. An unknown or unresolvable specifier is treated as invalid configuration\&. The following expansions are understood:
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&1.\ \&Specifiers available
.TS
allbox tab(:);
lB lB lB.
T{
Specifier
T}:T{
Meaning
T}:T{
Details
T}
.T&
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l.
T{
"%a"
T}:T{
Architecture
T}:T{
A short string identifying the architecture of the local system\&. A string such as \fBx86\fR, \fBx86\-64\fR or \fBarm64\fR\&. See the architectures defined for \fIConditionArchitecture=\fR in \fBsystemd.unit\fR(5) for a full list\&.
T}
T{
"%A"
T}:T{
Operating system image version
T}:T{
The operating system image version identifier of the running system, as read from the \fIIMAGE_VERSION=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
T}
T{
"%b"
T}:T{
Boot ID
T}:T{
The boot ID of the running system, formatted as string\&. See \fBrandom\fR(4) for more information\&.
T}
T{
"%B"
T}:T{
Operating system build ID
T}:T{
The operating system build identifier of the running system, as read from the \fIBUILD_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
T}
T{
"%H"
T}:T{
Host name
T}:T{
The hostname of the running system\&.
T}
T{
"%l"
T}:T{
Short host name
T}:T{
The hostname of the running system, truncated at the first dot to remove any domain component\&.
T}
T{
"%m"
T}:T{
Machine ID
T}:T{
The machine ID of the running system, formatted as string\&. See \fBmachine-id\fR(5) for more information\&.
T}
T{
"%M"
T}:T{
Operating system image identifier
T}:T{
The operating system image identifier of the running system, as read from the \fIIMAGE_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
T}
T{
"%o"
T}:T{
Operating system ID
T}:T{
The operating system identifier of the running system, as read from the \fIID=\fR field of /etc/os\-release\&. See \fBos-release\fR(5) for more information\&.
T}
T{
"%T"
T}:T{
Directory for temporary files
T}:T{
This is either /tmp or the path "$TMPDIR", "$TEMP" or "$TMP" are set to\&. (Note that the directory may be specified without a trailing slash\&.)
T}
T{
"%v"
T}:T{
Kernel release
T}:T{
Identical to \fBuname \-r\fR output\&.
T}
T{
"%V"
T}:T{
Directory for larger and persistent temporary files
T}:T{
This is either /var/tmp or the path "$TMPDIR", "$TEMP" or "$TMP" are set to\&. (Note that the directory may be specified without a trailing slash\&.)
T}
T{
"%w"
T}:T{
Operating system version ID
T}:T{
The operating system version identifier of the running system, as read from the \fIVERSION_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
T}
T{
"%W"
T}:T{
Operating system variant ID
T}:T{
The operating system variant identifier of the running system, as read from the \fIVARIANT_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
T}
T{
"%%"
T}:T{
Single percent sign
T}:T{
Use "%%" in place of "%" to specify a single percent sign\&.
T}
.TE
.sp 1
.SH "IDEMPOTENCE"
.PP
Note that
\fBsystemd\-sysusers\fR
will do nothing if the specified users or groups already exist or the users are members of specified groups, so normally there is no reason to override
sysusers\&.d
vendor configuration, except to block certain users or groups from being created\&.
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1), \fBsystemd-sysusers\fR(8)
.SH "NOTES"
.IP " 1." 4
User/Group Name Syntax
.RS 4
\%https://systemd.io/USER_NAMES
.RE