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 "2015-07-20">
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>
43
<holder>Teddy Hogeborn</holder>
44
<holder>Björn Påhlsson</holder>
46
<xi:include href="legalnotice.xml"/>
50
<refentrytitle>&CONFNAME;</refentrytitle>
51
<manvolnum>5</manvolnum>
55
<refname><filename>&CONFNAME;</filename></refname>
57
Configuration file for the Mandos server
62
<synopsis>&CONFPATH;</synopsis>
65
<refsect1 id="description">
66
<title>DESCRIPTION</title>
68
The file &CONFPATH; is a simple configuration file for
69
<citerefentry><refentrytitle>mandos</refentrytitle>
70
<manvolnum>8</manvolnum></citerefentry>, and is read by it at
71
startup. The configuration file starts with <quote><literal
72
>[DEFAULT]</literal></quote> on a line by itself, followed by
73
any number of <quote><varname><replaceable>option</replaceable
74
></varname>=<replaceable>value</replaceable></quote> entries,
75
with continuations in the style of RFC 822. <quote><varname
76
><replaceable>option</replaceable></varname>: <replaceable
77
>value</replaceable></quote> is also accepted. Note that
78
leading whitespace is removed from values. Lines beginning with
79
<quote>#</quote> or <quote>;</quote> are ignored and may be used
85
<title>OPTIONS</title>
89
<term><option>interface<literal> = </literal><replaceable
90
>NAME</replaceable></option></term>
92
<xi:include href="mandos-options.xml" xpointer="interface"/>
97
<term><option>address<literal> = </literal><replaceable
98
>ADDRESS</replaceable></option></term>
100
<xi:include href="mandos-options.xml" xpointer="address"/>
105
<term><option>port<literal> = </literal><replaceable
106
>NUMBER</replaceable></option></term>
108
<xi:include href="mandos-options.xml" xpointer="port"/>
113
<term><option>debug<literal> = </literal>{ <literal
114
>1</literal> | <literal>yes</literal> | <literal
115
>true</literal> | <literal>on</literal> | <literal
116
>0</literal> | <literal>no</literal> | <literal
117
>false</literal> | <literal>off</literal> }</option></term>
119
<xi:include href="mandos-options.xml" xpointer="debug"/>
124
<term><option>priority<literal> = </literal><replaceable
125
>STRING</replaceable></option></term>
127
<xi:include href="mandos-options.xml" xpointer="priority"/>
132
<term><option>servicename<literal> = </literal
133
><replaceable>NAME</replaceable></option></term>
135
<xi:include href="mandos-options.xml"
136
xpointer="servicename"/>
141
<term><option>use_dbus<literal> = </literal>{ <literal
142
>1</literal> | <literal>yes</literal> | <literal
143
>true</literal> | <literal>on</literal> | <literal
144
>0</literal> | <literal>no</literal> | <literal
145
>false</literal> | <literal>off</literal> }</option></term>
147
<xi:include href="mandos-options.xml" xpointer="dbus"/>
152
<term><option>use_ipv6<literal> = </literal>{ <literal
153
>1</literal> | <literal>yes</literal> | <literal
154
>true</literal> | <literal>on</literal> | <literal
155
>0</literal> | <literal>no</literal> | <literal
156
>false</literal> | <literal>off</literal> }</option></term>
158
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
163
<term><option>restore<literal> = </literal>{ <literal
164
>1</literal> | <literal>yes</literal> | <literal
165
>true</literal> | <literal>on</literal> | <literal
166
>0</literal> | <literal>no</literal> | <literal
167
>false</literal> | <literal>off</literal> }</option></term>
169
<xi:include href="mandos-options.xml" xpointer="restore"/>
174
<term><option>statedir<literal> = </literal><replaceable
175
>DIRECTORY</replaceable></option></term>
177
<xi:include href="mandos-options.xml" xpointer="statedir"/>
182
<term><option>socket<literal> = </literal><replaceable
183
>NUMBER</replaceable></option></term>
185
<xi:include href="mandos-options.xml" xpointer="socket"/>
192
<refsect1 id="files">
195
The file described here is &CONFPATH;
202
The <literal>[DEFAULT]</literal> is necessary because the Python
203
built-in module <systemitem class="library">ConfigParser</systemitem>
208
<refsect1 id="example">
209
<title>EXAMPLE</title>
212
No options are actually required:
220
An example using all the options:
224
# A configuration example
226
address = fe80::aede:48ff:fe71:f6f2
229
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
234
statedir = /var/lib/mandos
239
<refsect1 id="see_also">
240
<title>SEE ALSO</title>
242
<citerefentry><refentrytitle>intro</refentrytitle>
243
<manvolnum>8mandos</manvolnum></citerefentry>,
244
<citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
245
><manvolnum>3</manvolnum></citerefentry>,
246
<citerefentry><refentrytitle>mandos</refentrytitle>
247
<manvolnum>8</manvolnum></citerefentry>,
248
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
249
<manvolnum>5</manvolnum></citerefentry>
255
RFC 4291: <citetitle>IP Version 6 Addressing
256
Architecture</citetitle>
261
<term>Section 2.2: <citetitle>Text Representation of
262
Addresses</citetitle></term>
263
<listitem><para/></listitem>
266
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
267
Address</citetitle></term>
268
<listitem><para/></listitem>
271
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
272
Addresses</citetitle></term>
275
The clients use IPv6 link-local addresses, which are
276
immediately usable since a link-local addresses is
277
automatically assigned to a network interface when it
287
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
291
Zeroconf is the network protocol standard used by clients
292
for finding the Mandos server on the local network.
299
<!-- Local Variables: -->
300
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
301
<!-- time-stamp-end: "[\"']>" -->
302
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
mandos.conf.xml
