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 "2016-03-05">
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>
44
<holder>Teddy Hogeborn</holder>
45
<holder>Björn Påhlsson</holder>
47
<xi:include href="legalnotice.xml"/>
51
<refentrytitle>&CONFNAME;</refentrytitle>
52
<manvolnum>5</manvolnum>
56
<refname><filename>&CONFNAME;</filename></refname>
58
Configuration file for the Mandos server
63
<synopsis>&CONFPATH;</synopsis>
66
<refsect1 id="description">
67
<title>DESCRIPTION</title>
69
The file &CONFPATH; is a simple configuration file for
70
<citerefentry><refentrytitle>mandos</refentrytitle>
71
<manvolnum>8</manvolnum></citerefentry>, and is read by it at
72
startup. The configuration file starts with <quote><literal
73
>[DEFAULT]</literal></quote> on a line by itself, followed by
74
any number of <quote><varname><replaceable>option</replaceable
75
></varname>=<replaceable>value</replaceable></quote> entries,
76
with continuations in the style of RFC 822. <quote><varname
77
><replaceable>option</replaceable></varname>: <replaceable
78
>value</replaceable></quote> is also accepted. Note that
79
leading whitespace is removed from values. Lines beginning with
80
<quote>#</quote> or <quote>;</quote> are ignored and may be used
86
<title>OPTIONS</title>
90
<term><option>interface<literal> = </literal><replaceable
91
>NAME</replaceable></option></term>
93
<xi:include href="mandos-options.xml" xpointer="interface"/>
98
<term><option>address<literal> = </literal><replaceable
99
>ADDRESS</replaceable></option></term>
101
<xi:include href="mandos-options.xml" xpointer="address"/>
106
<term><option>port<literal> = </literal><replaceable
107
>NUMBER</replaceable></option></term>
109
<xi:include href="mandos-options.xml" xpointer="port"/>
114
<term><option>debug<literal> = </literal>{ <literal
115
>1</literal> | <literal>yes</literal> | <literal
116
>true</literal> | <literal>on</literal> | <literal
117
>0</literal> | <literal>no</literal> | <literal
118
>false</literal> | <literal>off</literal> }</option></term>
120
<xi:include href="mandos-options.xml" xpointer="debug"/>
125
<term><option>priority<literal> = </literal><replaceable
126
>STRING</replaceable></option></term>
128
<xi:include href="mandos-options.xml" xpointer="priority"/>
133
<term><option>servicename<literal> = </literal
134
><replaceable>NAME</replaceable></option></term>
136
<xi:include href="mandos-options.xml"
137
xpointer="servicename"/>
142
<term><option>use_dbus<literal> = </literal>{ <literal
143
>1</literal> | <literal>yes</literal> | <literal
144
>true</literal> | <literal>on</literal> | <literal
145
>0</literal> | <literal>no</literal> | <literal
146
>false</literal> | <literal>off</literal> }</option></term>
148
<xi:include href="mandos-options.xml" xpointer="dbus"/>
153
<term><option>use_ipv6<literal> = </literal>{ <literal
154
>1</literal> | <literal>yes</literal> | <literal
155
>true</literal> | <literal>on</literal> | <literal
156
>0</literal> | <literal>no</literal> | <literal
157
>false</literal> | <literal>off</literal> }</option></term>
159
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
164
<term><option>restore<literal> = </literal>{ <literal
165
>1</literal> | <literal>yes</literal> | <literal
166
>true</literal> | <literal>on</literal> | <literal
167
>0</literal> | <literal>no</literal> | <literal
168
>false</literal> | <literal>off</literal> }</option></term>
170
<xi:include href="mandos-options.xml" xpointer="restore"/>
175
<term><option>statedir<literal> = </literal><replaceable
176
>DIRECTORY</replaceable></option></term>
178
<xi:include href="mandos-options.xml" xpointer="statedir"/>
183
<term><option>socket<literal> = </literal><replaceable
184
>NUMBER</replaceable></option></term>
186
<xi:include href="mandos-options.xml" xpointer="socket"/>
193
<refsect1 id="files">
196
The file described here is &CONFPATH;
203
The <literal>[DEFAULT]</literal> is necessary because the Python
204
built-in module <systemitem class="library">ConfigParser</systemitem>
207
<xi:include href="bugs.xml"/>
210
<refsect1 id="example">
211
<title>EXAMPLE</title>
214
No options are actually required:
222
An example using all the options:
226
# A configuration example
228
address = fe80::aede:48ff:fe71:f6f2
231
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
236
statedir = /var/lib/mandos
241
<refsect1 id="see_also">
242
<title>SEE ALSO</title>
244
<citerefentry><refentrytitle>intro</refentrytitle>
245
<manvolnum>8mandos</manvolnum></citerefentry>,
246
<citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
247
><manvolnum>3</manvolnum></citerefentry>,
248
<citerefentry><refentrytitle>mandos</refentrytitle>
249
<manvolnum>8</manvolnum></citerefentry>,
250
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
251
<manvolnum>5</manvolnum></citerefentry>
257
RFC 4291: <citetitle>IP Version 6 Addressing
258
Architecture</citetitle>
263
<term>Section 2.2: <citetitle>Text Representation of
264
Addresses</citetitle></term>
265
<listitem><para/></listitem>
268
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
269
Address</citetitle></term>
270
<listitem><para/></listitem>
273
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
274
Addresses</citetitle></term>
277
The clients use IPv6 link-local addresses, which are
278
immediately usable since a link-local addresses is
279
automatically assigned to a network interface when it
289
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
293
Zeroconf is the network protocol standard used by clients
294
for finding the Mandos server on the local network.
301
<!-- Local Variables: -->
302
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
303
<!-- time-stamp-end: "[\"']>" -->
304
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
mandos.conf.xml
