1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY CONFNAME "mandos.conf">
5
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
6
<!ENTITY TIMESTAMP "2017-02-23">
7
<!ENTITY % common SYSTEM "common.ent">
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
13
<title>Mandos Manual</title>
14
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
<productname>Mandos</productname>
16
<productnumber>&version;</productnumber>
17
<date>&TIMESTAMP;</date>
20
<firstname>Björn</firstname>
21
<surname>Påhlsson</surname>
23
<email>belorn@recompile.se</email>
27
<firstname>Teddy</firstname>
28
<surname>Hogeborn</surname>
30
<email>teddy@recompile.se</email>
45
<holder>Teddy Hogeborn</holder>
46
<holder>Björn Påhlsson</holder>
48
<xi:include href="legalnotice.xml"/>
52
<refentrytitle>&CONFNAME;</refentrytitle>
53
<manvolnum>5</manvolnum>
57
<refname><filename>&CONFNAME;</filename></refname>
59
Configuration file for the Mandos server
64
<synopsis>&CONFPATH;</synopsis>
67
<refsect1 id="description">
68
<title>DESCRIPTION</title>
70
The file &CONFPATH; is a simple configuration file for
71
<citerefentry><refentrytitle>mandos</refentrytitle>
72
<manvolnum>8</manvolnum></citerefentry>, and is read by it at
73
startup. The configuration file starts with <quote><literal
74
>[DEFAULT]</literal></quote> on a line by itself, followed by
75
any number of <quote><varname><replaceable>option</replaceable
76
></varname>=<replaceable>value</replaceable></quote> entries,
77
with continuations in the style of RFC 822. <quote><varname
78
><replaceable>option</replaceable></varname>: <replaceable
79
>value</replaceable></quote> is also accepted. Note that
80
leading whitespace is removed from values. Lines beginning with
81
<quote>#</quote> or <quote>;</quote> are ignored and may be used
87
<title>OPTIONS</title>
91
<term><option>interface<literal> = </literal><replaceable
92
>NAME</replaceable></option></term>
94
<xi:include href="mandos-options.xml" xpointer="interface"/>
99
<term><option>address<literal> = </literal><replaceable
100
>ADDRESS</replaceable></option></term>
102
<xi:include href="mandos-options.xml" xpointer="address"/>
107
<term><option>port<literal> = </literal><replaceable
108
>NUMBER</replaceable></option></term>
110
<xi:include href="mandos-options.xml" xpointer="port"/>
115
<term><option>debug<literal> = </literal>{ <literal
116
>1</literal> | <literal>yes</literal> | <literal
117
>true</literal> | <literal>on</literal> | <literal
118
>0</literal> | <literal>no</literal> | <literal
119
>false</literal> | <literal>off</literal> }</option></term>
121
<xi:include href="mandos-options.xml" xpointer="debug"/>
126
<term><option>priority<literal> = </literal><replaceable
127
>STRING</replaceable></option></term>
129
<xi:include href="mandos-options.xml" xpointer="priority"/>
134
<term><option>servicename<literal> = </literal
135
><replaceable>NAME</replaceable></option></term>
137
<xi:include href="mandos-options.xml"
138
xpointer="servicename"/>
143
<term><option>use_dbus<literal> = </literal>{ <literal
144
>1</literal> | <literal>yes</literal> | <literal
145
>true</literal> | <literal>on</literal> | <literal
146
>0</literal> | <literal>no</literal> | <literal
147
>false</literal> | <literal>off</literal> }</option></term>
149
<xi:include href="mandos-options.xml" xpointer="dbus"/>
154
<term><option>use_ipv6<literal> = </literal>{ <literal
155
>1</literal> | <literal>yes</literal> | <literal
156
>true</literal> | <literal>on</literal> | <literal
157
>0</literal> | <literal>no</literal> | <literal
158
>false</literal> | <literal>off</literal> }</option></term>
160
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
165
<term><option>restore<literal> = </literal>{ <literal
166
>1</literal> | <literal>yes</literal> | <literal
167
>true</literal> | <literal>on</literal> | <literal
168
>0</literal> | <literal>no</literal> | <literal
169
>false</literal> | <literal>off</literal> }</option></term>
171
<xi:include href="mandos-options.xml" xpointer="restore"/>
176
<term><option>statedir<literal> = </literal><replaceable
177
>DIRECTORY</replaceable></option></term>
179
<xi:include href="mandos-options.xml" xpointer="statedir"/>
184
<term><option>socket<literal> = </literal><replaceable
185
>NUMBER</replaceable></option></term>
187
<xi:include href="mandos-options.xml" xpointer="socket"/>
194
<refsect1 id="files">
197
The file described here is &CONFPATH;
204
The <literal>[DEFAULT]</literal> is necessary because the Python
205
built-in module <systemitem class="library">ConfigParser</systemitem>
208
<xi:include href="bugs.xml"/>
211
<refsect1 id="example">
212
<title>EXAMPLE</title>
215
No options are actually required:
223
An example using all the options:
227
# A configuration example
229
address = fe80::aede:48ff:fe71:f6f2
232
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
237
statedir = /var/lib/mandos
242
<refsect1 id="see_also">
243
<title>SEE ALSO</title>
245
<citerefentry><refentrytitle>intro</refentrytitle>
246
<manvolnum>8mandos</manvolnum></citerefentry>,
247
<citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
248
><manvolnum>3</manvolnum></citerefentry>,
249
<citerefentry><refentrytitle>mandos</refentrytitle>
250
<manvolnum>8</manvolnum></citerefentry>,
251
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
252
<manvolnum>5</manvolnum></citerefentry>
258
RFC 4291: <citetitle>IP Version 6 Addressing
259
Architecture</citetitle>
264
<term>Section 2.2: <citetitle>Text Representation of
265
Addresses</citetitle></term>
266
<listitem><para/></listitem>
269
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
270
Address</citetitle></term>
271
<listitem><para/></listitem>
274
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
275
Addresses</citetitle></term>
278
The clients use IPv6 link-local addresses, which are
279
immediately usable since a link-local addresses is
280
automatically assigned to a network interface when it
290
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
294
Zeroconf is the network protocol standard used by clients
295
for finding the Mandos server on the local network.
302
<!-- Local Variables: -->
303
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
304
<!-- time-stamp-end: "[\"']>" -->
305
<!-- time-stamp-format: "%:y-%02m-%02d" -->