man/homed.conf.xml

   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.5/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><simplelist>
  26       <member><filename>/etc/systemd/homed.conf</filename></member>
  27       <member><filename>/etc/systemd/homed.conf.d/*.conf</filename></member>
  28       <member><filename>/run/systemd/homed.conf.d/*.conf</filename></member>
  29       <member><filename>/usr/lib/systemd/homed.conf.d/*.conf</filename></member>
  30     </simplelist></para>
  31   </refsynopsisdiv>
  32
  33   <refsect1>
  34     <title>Description</title>
  35
  36     <para>These configuration files control default parameters for home areas/user accounts created and
  37     managed by
  38     <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  39
  40   </refsect1>
  41
  42   <xi:include href="standard-conf.xml" xpointer="main-conf" />
  43
  44   <refsect1>
  45     <title>Options</title>
  46
  47     <para>The following options are available in the [Home] section:</para>
  48
  49     <variablelist class='home-directives'>
  50
  51       <varlistentry>
  52         <term><varname>DefaultStorage=</varname></term>
  53         <listitem><para>The default storage to use for home areas. Takes one of <literal>luks</literal>,
  54         <literal>fscrypt</literal>, <literal>directory</literal>, <literal>subvolume</literal>,
  55         <literal>cifs</literal>. For details about these options, see
  56         <citerefentry><refentrytitle>homectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. If not
  57         configured or assigned the empty string, the default storage is automatically determined: if not
  58         running in a container environment and <filename>/home/</filename> is not itself encrypted, defaults
  59         to <literal>luks</literal>. Otherwise defaults to <literal>subvolume</literal> if
  60         <filename>/home/</filename> is on a btrfs file system, and <literal>directory</literal>
  61         otherwise. Note that the storage selected on the <command>homectl</command> command line always takes
  62         precedence.</para>
  63
  64         <xi:include href="version-info.xml" xpointer="v246"/></listitem>
  65       </varlistentry>
  66
  67       <varlistentry>
  68         <term><varname>DefaultFileSystemType=</varname></term>
  69         <listitem><para>When using <literal>luks</literal> as storage (see above), selects the default file
  70         system to use inside the user's LUKS volume. Takes one of <literal>btrfs</literal>,
  71         <literal>ext4</literal> or <literal>xfs</literal>. If not specified defaults to
  72         <literal>btrfs</literal>. This setting has no effect if a different storage mechanism is used. The
  73         file system type selected on the <command>homectl</command> command line always takes
  74         precedence.</para>
  75
  76         <xi:include href="version-info.xml" xpointer="v246"/></listitem>
  77       </varlistentry>
  78
  79     </variablelist>
  80   </refsect1>
  81
  82   <refsect1>
  83       <title>See Also</title>
  84       <para><simplelist type="inline">
  85       <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
  86       <member><citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
  87       </simplelist></para>
  88   </refsect1>
  89
  90 </refentry>