Debian Codegraph @

upstream/debian-unstable/man5/homed.conf.5

raw
1 '\" t
2 .TH "HOMED\&.CONF" "5" "" "systemd 261~rc3" "homed.conf"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 homed.conf, homed.conf.d \- Home area/user account manager configuration files
24 .SH "SYNOPSIS"
25 .PP
26 .RS 4
27 /etc/systemd/homed\&.conf
28 .RE
29 .RS 4
30 /run/systemd/homed\&.conf
31 .RE
32 .RS 4
33 /usr/local/lib/systemd/homed\&.conf
34 .RE
35 .RS 4
36 /usr/lib/systemd/homed\&.conf
37 .RE
38 .RS 4
39 /etc/systemd/homed\&.conf\&.d/*\&.conf
40 .RE
41 .RS 4
42 /run/systemd/homed\&.conf\&.d/*\&.conf
43 .RE
44 .RS 4
45 /usr/local/lib/systemd/homed\&.conf\&.d/*\&.conf
46 .RE
47 .RS 4
48 /usr/lib/systemd/homed\&.conf\&.d/*\&.conf
49 .RE
50 .SH "DESCRIPTION"
51 .PP
52 These configuration files control default parameters for home areas/user accounts created and managed by
53 \fBsystemd-homed.service\fR(8)\&.
54 .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE"
55 .PP
56 The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used:
57 /etc/systemd/,
58 /run/systemd/,
59 /usr/local/lib/systemd/
60 \&\s-2\u[1]\d\s+2,
61 /usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in
62 /etc/
63 if it is shipped under
64 /usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&.
65 .PP
66 In addition to the main configuration file, drop\-in configuration snippets are read from
67 /usr/lib/systemd/*\&.conf\&.d/,
68 /usr/local/lib/systemd/*\&.conf\&.d/, and
69 /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the
70 *\&.conf\&.d/
71 configuration subdirectories are sorted by their filename in lexicographic order, regardless of in which of the subdirectories they reside\&. When multiple files specify the same option, for options which accept just a single value, the entry in the file sorted last takes precedence, and for options which accept a list of values, entries are collected as they occur in the sorted files\&.
72 .PP
73 When packages need to customize the configuration, they can install drop\-ins under
74 /usr/\&. Files in
75 /etc/
76 are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in
77 /usr/
78 and the range 60\-90 for drop\-ins in
79 /etc/
80 and
81 /run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&.
82 .PP
83 To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to
84 /dev/null
85 in the configuration directory in
86 /etc/, with the same filename as the vendor configuration file\&.
87 .SH "OPTIONS"
88 .PP
89 The following options are available in the [Home] section:
90 .PP
91 \fIDefaultStorage=\fR
92 .RS 4
93 The default storage to use for home areas\&. Takes one of
94 "luks",
95 "fscrypt",
96 "directory",
97 "subvolume",
98 "cifs"\&. For details about these options, see
99 \fBhomectl\fR(1)\&. If not configured or assigned the empty string, the default storage is automatically determined: if not running in a container environment and
100 /home/
101 is not itself encrypted, defaults to
102 "luks"\&. Otherwise, defaults to
103 "subvolume"
104 if
105 /home/
106 is on a btrfs file system, and
107 "directory"
108 otherwise\&. Note that the storage selected on the
109 \fBhomectl\fR
110 command line always takes precedence\&.
111 .sp
112 Added in version 246\&.
113 .RE
114 .PP
115 \fIDefaultFileSystemType=\fR
116 .RS 4
117 When using
118 "luks"
119 as storage (see above), selects the default file system to use inside the user\*(Aqs LUKS volume\&. Takes one of
120 "btrfs",
121 "ext4"
122 or
123 "xfs"\&. If not specified, defaults to
124 "btrfs"\&. This setting has no effect if a different storage mechanism is used\&. The file system type selected on the
125 \fBhomectl\fR
126 command line always takes precedence\&.
127 .sp
128 Added in version 246\&.
129 .RE
130 .SH "SEE ALSO"
131 .PP
132 \fBsystemd\fR(1), \fBsystemd-homed.service\fR(8)
133 .SH "NOTES"
134 .IP " 1." 4
135 💣💥🧨💥💥💣 Please note that those configuration files must be available at all times. If
136 /usr/local/
137 is a separate partition, it may not be available during early boot, and must not be used for configuration.
138