1<?xml version='1.0'?>
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
5
6<refentry id="homed.conf" conditional='ENABLE_HOMED'
7    xmlns:xi="http://www.w3.org/2001/XInclude">
8  <refentryinfo>
9    <title>homed.conf</title>
10    <productname>systemd</productname>
11  </refentryinfo>
12
13  <refmeta>
14    <refentrytitle>homed.conf</refentrytitle>
15    <manvolnum>5</manvolnum>
16  </refmeta>
17
18  <refnamediv>
19    <refname>homed.conf</refname>
20    <refname>homed.conf.d</refname>
21    <refpurpose>Home area/user account manager configuration files</refpurpose>
22  </refnamediv>
23
24  <refsynopsisdiv>
25    <para><filename>/etc/systemd/homed.conf</filename></para>
26    <para><filename>/etc/systemd/homed.conf.d/*.conf</filename></para>
27    <para><filename>/run/systemd/homed.conf.d/*.conf</filename></para>
28    <para><filename>/usr/lib/systemd/homed.conf.d/*.conf</filename></para>
29  </refsynopsisdiv>
30
31  <refsect1>
32    <title>Description</title>
33
34    <para>These configuration files control default parameters for home areas/user accounts created and
35    managed by
36    <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
37
38  </refsect1>
39
40  <xi:include href="standard-conf.xml" xpointer="main-conf" />
41
42  <refsect1>
43    <title>Options</title>
44
45    <para>The following options are available in the [Home] section:</para>
46
47    <variablelist class='home-directives'>
48
49      <varlistentry>
50        <term><varname>DefaultStorage=</varname></term>
51        <listitem><para>The default storage to use for home areas. Takes one of <literal>luks</literal>,
52        <literal>fscrypt</literal>, <literal>directory</literal>, <literal>subvolume</literal>,
53        <literal>cifs</literal>. For details about these options, see
54        <citerefentry><refentrytitle>homectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. If not
55        configured or assigned the empty string, the default storage is automatically determined: if not
56        running in a container environment and <filename>/home/</filename> is not itself encrypted, defaults
57        to <literal>luks</literal>. Otherwise defaults to <literal>subvolume</literal> if
58        <filename>/home/</filename> is on a btrfs file system, and <literal>directory</literal>
59        otherwise. Note that the storage selected on the <command>homectl</command> command line always takes
60        precedence.</para></listitem>
61      </varlistentry>
62
63      <varlistentry>
64        <term><varname>DefaultFileSystemType=</varname></term>
65        <listitem><para>When using <literal>luks</literal> as storage (see above), selects the default file
66        system to use inside the user's LUKS volume. Takes one of <literal>btrfs</literal>,
67        <literal>ext4</literal> or <literal>xfs</literal>. If not specified defaults to
68        <literal>btrfs</literal>. This setting has no effect if a different storage mechanism is used. The
69        file system type selected on the <command>homectl</command> command line always takes
70        precedence.</para></listitem>
71      </varlistentry>
72
73    </variablelist>
74  </refsect1>
75
76  <refsect1>
77      <title>See Also</title>
78      <para>
79      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
80      <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
81      </para>
82  </refsect1>
83
84</refentry>
85