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 "2011-11-26">
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>
38
<holder>Teddy Hogeborn</holder>
39
<holder>Björn Påhlsson</holder>
41
<xi:include href="legalnotice.xml"/>
45
<refentrytitle>&CONFNAME;</refentrytitle>
46
<manvolnum>5</manvolnum>
50
<refname><filename>&CONFNAME;</filename></refname>
52
Configuration file for the Mandos server
57
<synopsis>&CONFPATH;</synopsis>
60
<refsect1 id="description">
61
<title>DESCRIPTION</title>
63
The file &CONFPATH; is a simple configuration file for
64
<citerefentry><refentrytitle>mandos</refentrytitle>
65
<manvolnum>8</manvolnum></citerefentry>, and is read by it at
66
startup. The configuration file starts with <quote><literal
67
>[DEFAULT]</literal></quote> on a line by itself, followed by
68
any number of <quote><varname><replaceable>option</replaceable
69
></varname>=<replaceable>value</replaceable></quote> entries,
70
with continuations in the style of RFC 822. <quote><varname
71
><replaceable>option</replaceable></varname>: <replaceable
72
>value</replaceable></quote> is also accepted. Note that
73
leading whitespace is removed from values. Lines beginning with
74
<quote>#</quote> or <quote>;</quote> are ignored and may be used
80
<title>OPTIONS</title>
84
<term><option>interface<literal> = </literal><replaceable
85
>NAME</replaceable></option></term>
87
<xi:include href="mandos-options.xml" xpointer="interface"/>
92
<term><option>address<literal> = </literal><replaceable
93
>ADDRESS</replaceable></option></term>
95
<xi:include href="mandos-options.xml" xpointer="address"/>
100
<term><option>port<literal> = </literal><replaceable
101
>NUMBER</replaceable></option></term>
103
<xi:include href="mandos-options.xml" xpointer="port"/>
108
<term><option>debug<literal> = </literal>{ <literal
109
>1</literal> | <literal>yes</literal> | <literal
110
>true</literal> | <literal>on</literal> | <literal
111
>0</literal> | <literal>no</literal> | <literal
112
>false</literal> | <literal>off</literal> }</option></term>
114
<xi:include href="mandos-options.xml" xpointer="debug"/>
119
<term><option>priority<literal> = </literal><replaceable
120
>STRING</replaceable></option></term>
122
<xi:include href="mandos-options.xml" xpointer="priority"/>
127
<term><option>servicename<literal> = </literal
128
><replaceable>NAME</replaceable></option></term>
130
<xi:include href="mandos-options.xml"
131
xpointer="servicename"/>
136
<term><option>use_dbus<literal> = </literal>{ <literal
137
>1</literal> | <literal>yes</literal> | <literal
138
>true</literal> | <literal>on</literal> | <literal
139
>0</literal> | <literal>no</literal> | <literal
140
>false</literal> | <literal>off</literal> }</option></term>
142
<xi:include href="mandos-options.xml" xpointer="dbus"/>
147
<term><option>use_ipv6<literal> = </literal>{ <literal
148
>1</literal> | <literal>yes</literal> | <literal
149
>true</literal> | <literal>on</literal> | <literal
150
>0</literal> | <literal>no</literal> | <literal
151
>false</literal> | <literal>off</literal> }</option></term>
153
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
158
<term><option>restore<literal> = </literal>{ <literal
159
>1</literal> | <literal>yes</literal> | <literal
160
>true</literal> | <literal>on</literal> | <literal
161
>0</literal> | <literal>no</literal> | <literal
162
>false</literal> | <literal>off</literal> }</option></term>
164
<xi:include href="mandos-options.xml" xpointer="restore"/>
169
<term><option>statedir<literal> = </literal><replaceable
170
>DIRECTORY</replaceable></option></term>
172
<xi:include href="mandos-options.xml" xpointer="statedir"/>
179
<refsect1 id="files">
182
The file described here is &CONFPATH;
189
The <literal>[DEFAULT]</literal> is necessary because the Python
190
built-in module <systemitem class="library">ConfigParser</systemitem>
195
<refsect1 id="example">
196
<title>EXAMPLE</title>
199
No options are actually required:
207
An example using all the options:
211
# A configuration example
213
address = fe80::aede:48ff:fe71:f6f2
216
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
221
statedir = /var/lib/mandos
226
<refsect1 id="see_also">
227
<title>SEE ALSO</title>
229
<citerefentry><refentrytitle>intro</refentrytitle>
230
<manvolnum>8mandos</manvolnum></citerefentry>,
231
<citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
232
><manvolnum>3</manvolnum></citerefentry>,
233
<citerefentry><refentrytitle>mandos</refentrytitle>
234
<manvolnum>8</manvolnum></citerefentry>,
235
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
236
<manvolnum>5</manvolnum></citerefentry>
242
RFC 4291: <citetitle>IP Version 6 Addressing
243
Architecture</citetitle>
248
<term>Section 2.2: <citetitle>Text Representation of
249
Addresses</citetitle></term>
250
<listitem><para/></listitem>
253
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
254
Address</citetitle></term>
255
<listitem><para/></listitem>
258
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
259
Addresses</citetitle></term>
262
The clients use IPv6 link-local addresses, which are
263
immediately usable since a link-local addresses is
264
automatically assigned to a network interface when it
274
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
278
Zeroconf is the network protocol standard used by clients
279
for finding the Mandos server on the local network.
286
<!-- Local Variables: -->
287
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
288
<!-- time-stamp-end: "[\"']>" -->
289
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
mandos.conf.xml
