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 "2013-10-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>
40
<holder>Teddy Hogeborn</holder>
41
<holder>Björn Påhlsson</holder>
43
<xi:include href="legalnotice.xml"/>
47
<refentrytitle>&CONFNAME;</refentrytitle>
48
<manvolnum>5</manvolnum>
52
<refname><filename>&CONFNAME;</filename></refname>
54
Configuration file for the Mandos server
59
<synopsis>&CONFPATH;</synopsis>
62
<refsect1 id="description">
63
<title>DESCRIPTION</title>
65
The file &CONFPATH; is a simple configuration file for
66
<citerefentry><refentrytitle>mandos</refentrytitle>
67
<manvolnum>8</manvolnum></citerefentry>, and is read by it at
68
startup. The configuration file starts with <quote><literal
69
>[DEFAULT]</literal></quote> on a line by itself, followed by
70
any number of <quote><varname><replaceable>option</replaceable
71
></varname>=<replaceable>value</replaceable></quote> entries,
72
with continuations in the style of RFC 822. <quote><varname
73
><replaceable>option</replaceable></varname>: <replaceable
74
>value</replaceable></quote> is also accepted. Note that
75
leading whitespace is removed from values. Lines beginning with
76
<quote>#</quote> or <quote>;</quote> are ignored and may be used
82
<title>OPTIONS</title>
86
<term><option>interface<literal> = </literal><replaceable
87
>NAME</replaceable></option></term>
89
<xi:include href="mandos-options.xml" xpointer="interface"/>
94
<term><option>address<literal> = </literal><replaceable
95
>ADDRESS</replaceable></option></term>
97
<xi:include href="mandos-options.xml" xpointer="address"/>
102
<term><option>port<literal> = </literal><replaceable
103
>NUMBER</replaceable></option></term>
105
<xi:include href="mandos-options.xml" xpointer="port"/>
110
<term><option>debug<literal> = </literal>{ <literal
111
>1</literal> | <literal>yes</literal> | <literal
112
>true</literal> | <literal>on</literal> | <literal
113
>0</literal> | <literal>no</literal> | <literal
114
>false</literal> | <literal>off</literal> }</option></term>
116
<xi:include href="mandos-options.xml" xpointer="debug"/>
121
<term><option>priority<literal> = </literal><replaceable
122
>STRING</replaceable></option></term>
124
<xi:include href="mandos-options.xml" xpointer="priority"/>
129
<term><option>servicename<literal> = </literal
130
><replaceable>NAME</replaceable></option></term>
132
<xi:include href="mandos-options.xml"
133
xpointer="servicename"/>
138
<term><option>use_dbus<literal> = </literal>{ <literal
139
>1</literal> | <literal>yes</literal> | <literal
140
>true</literal> | <literal>on</literal> | <literal
141
>0</literal> | <literal>no</literal> | <literal
142
>false</literal> | <literal>off</literal> }</option></term>
144
<xi:include href="mandos-options.xml" xpointer="dbus"/>
149
<term><option>use_ipv6<literal> = </literal>{ <literal
150
>1</literal> | <literal>yes</literal> | <literal
151
>true</literal> | <literal>on</literal> | <literal
152
>0</literal> | <literal>no</literal> | <literal
153
>false</literal> | <literal>off</literal> }</option></term>
155
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
160
<term><option>restore<literal> = </literal>{ <literal
161
>1</literal> | <literal>yes</literal> | <literal
162
>true</literal> | <literal>on</literal> | <literal
163
>0</literal> | <literal>no</literal> | <literal
164
>false</literal> | <literal>off</literal> }</option></term>
166
<xi:include href="mandos-options.xml" xpointer="restore"/>
171
<term><option>statedir<literal> = </literal><replaceable
172
>DIRECTORY</replaceable></option></term>
174
<xi:include href="mandos-options.xml" xpointer="statedir"/>
179
<term><option>socket<literal> = </literal><replaceable
180
>NUMBER</replaceable></option></term>
182
<xi:include href="mandos-options.xml" xpointer="socket"/>
189
<refsect1 id="files">
192
The file described here is &CONFPATH;
199
The <literal>[DEFAULT]</literal> is necessary because the Python
200
built-in module <systemitem class="library">ConfigParser</systemitem>
205
<refsect1 id="example">
206
<title>EXAMPLE</title>
209
No options are actually required:
217
An example using all the options:
221
# A configuration example
223
address = fe80::aede:48ff:fe71:f6f2
226
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
231
statedir = /var/lib/mandos
236
<refsect1 id="see_also">
237
<title>SEE ALSO</title>
239
<citerefentry><refentrytitle>intro</refentrytitle>
240
<manvolnum>8mandos</manvolnum></citerefentry>,
241
<citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
242
><manvolnum>3</manvolnum></citerefentry>,
243
<citerefentry><refentrytitle>mandos</refentrytitle>
244
<manvolnum>8</manvolnum></citerefentry>,
245
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
246
<manvolnum>5</manvolnum></citerefentry>
252
RFC 4291: <citetitle>IP Version 6 Addressing
253
Architecture</citetitle>
258
<term>Section 2.2: <citetitle>Text Representation of
259
Addresses</citetitle></term>
260
<listitem><para/></listitem>
263
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
264
Address</citetitle></term>
265
<listitem><para/></listitem>
268
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
269
Addresses</citetitle></term>
272
The clients use IPv6 link-local addresses, which are
273
immediately usable since a link-local addresses is
274
automatically assigned to a network interface when it
284
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
288
Zeroconf is the network protocol standard used by clients
289
for finding the Mandos server on the local network.
296
<!-- Local Variables: -->
297
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
298
<!-- time-stamp-end: "[\"']>" -->
299
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
mandos.conf.xml
