1<?xml version="1.0"?>
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
4[<!ENTITY version SYSTEM "../version.xml">]>
5<refentry id="udisks2.conf.5">
6  <refentryinfo>
7    <title>udisks2.conf</title>
8    <date>August 2018</date>
9    <productname>udisks</productname>
10  </refentryinfo>
11
12  <refmeta>
13    <refentrytitle>udisks2.conf</refentrytitle>
14    <manvolnum>5</manvolnum>
15    <refmiscinfo class="manual">UDisks Daemon Configuration</refmiscinfo>
16    <refmiscinfo class="source">udisks2.conf</refmiscinfo>
17    <refmiscinfo class="version">&version;</refmiscinfo>
18  </refmeta>
19
20  <refnamediv>
21    <refname>udisks2.conf</refname>
22    <refpurpose>The udisks2 configuration file</refpurpose>
23  </refnamediv>
24
25  <refsect1>
26    <title>DESCRIPTION</title>
27    <para>
28      The udisks project provides additional functionality via pluggable
29      modules. These plugins can be inserted into the daemon either by D-Bus
30      call <function>org.freedesktop.UDisks2.Manager.EnableModules()</function>
31      or by running the udisks daemon with
32      <option>--force-load-modules</option> command line option.
33    </para>
34
35    <para>
36      It is also possible to configure the modules loading behavior via
37      the configuration file placed at
38      <emphasis>@sysconfdir@/udisks2/udisks2.conf</emphasis>.
39    </para>
40  </refsect1>
41
42  <refsect1>
43    <title>CONFIGURATION FILE</title>
44    <para>
45      The default configuration file <emphasis
46      role="bold">udisks2.conf</emphasis> looks like this:
47    </para>
48
49    <programlisting>
50    [udisks2]
51    modules=*
52    modules_load_preference=ondemand
53
54    [defaults]
55    encryption=luks1
56    </programlisting>
57
58    <para>
59      <variablelist>
60        <varlistentry>
61          <term><option>modules = &lt;string list&gt;</option></term>
62          <para>
63            This variable controls what modules should be loaded. It may
64            contain either a comma-separated list of modules to load or a
65            single asterisk which stands for all the modules.
66          </para>
67        </varlistentry>
68
69        <varlistentry>
70          <term><option>modules_load_preference = ondemand|onstartup</option></term>
71          <para>
72            This key tells udisksd when to load the plugins: either at startup
73            or on demand by D-Bus
74            <function>org.freedesktop.UDisks2.Manager.EnableModules()</function>.
75          </para>
76        </varlistentry>
77
78        <varlistentry>
79          <term><option>encryption = luks1|luks2</option></term>
80          <para>
81            This variable controls which encryption technology will be used
82            by default when creating an encrypted filesystem.
83          </para>
84        </varlistentry>
85      </variablelist>
86    </para>
87  </refsect1>
88
89  <refsect1>
90    <title>AUTHOR</title>
91    <para>
92      <email><![CDATA[phatina@redhat.com]]></email>
93    </para>
94  </refsect1>
95
96  <refsect1>
97    <title>BUGS</title>
98    <para>
99      Please send bug reports to either the distribution bug tracker
100      or the upstream bug tracker at
101      <ulink url="https://github.com/storaged-project/udisks/issues"/>.
102    </para>
103  </refsect1>
104
105  <refsect1>
106    <title>SEE ALSO</title>
107    <para>
108      <link linkend="udisks.8"><citerefentry><refentrytitle>udisks</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>,
109      <link linkend="udisksctl.1"><citerefentry><refentrytitle>udisksctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>,
110      <link linkend="umount.udisks2.8"><citerefentry><refentrytitle>umount.udisks2</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>
111    </para>
112  </refsect1>
113</refentry>
114