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 "2009-02-25">
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@fukt.bsnet.se</email>
27
<firstname>Teddy</firstname>
28
<surname>Hogeborn</surname>
30
<email>teddy@fukt.bsnet.se</email>
37
<holder>Teddy Hogeborn</holder>
38
<holder>Björn Påhlsson</holder>
40
<xi:include href="legalnotice.xml"/>
44
<refentrytitle>&CONFNAME;</refentrytitle>
45
<manvolnum>5</manvolnum>
49
<refname><filename>&CONFNAME;</filename></refname>
51
Configuration file for the Mandos server
56
<synopsis>&CONFPATH;</synopsis>
59
<refsect1 id="description">
60
<title>DESCRIPTION</title>
62
The file &CONFPATH; is a simple configuration file for
63
<citerefentry><refentrytitle>mandos</refentrytitle>
64
<manvolnum>8</manvolnum></citerefentry>, and is read by it at
65
startup. The configuration file starts with <quote><literal
66
>[DEFAULT]</literal></quote> on a line by itself, followed by
67
any number of <quote><varname><replaceable>option</replaceable
68
></varname>=<replaceable>value</replaceable></quote> entries,
69
with continuations in the style of RFC 822. <quote><varname
70
><replaceable>option</replaceable></varname>: <replaceable
71
>value</replaceable></quote> is also accepted. Note that
72
leading whitespace is removed from values. Lines beginning with
73
<quote>#</quote> or <quote>;</quote> are ignored and may be used
79
<title>OPTIONS</title>
83
<term><option>interface<literal> = </literal><replaceable
84
>NAME</replaceable></option></term>
86
<xi:include href="mandos-options.xml" xpointer="interface"/>
91
<term><option>address<literal> = </literal><replaceable
92
>ADDRESS</replaceable></option></term>
94
<xi:include href="mandos-options.xml" xpointer="address"/>
99
<term><option>port<literal> = </literal><replaceable
100
>NUMBER</replaceable></option></term>
102
<xi:include href="mandos-options.xml" xpointer="port"/>
107
<term><option>debug<literal> = </literal>{ <literal
108
>1</literal> | <literal>yes</literal> | <literal
109
>true</literal> | <literal>on</literal> | <literal
110
>0</literal> | <literal>no</literal> | <literal
111
>false</literal> | <literal>off</literal> }</option></term>
113
<xi:include href="mandos-options.xml" xpointer="debug"/>
118
<term><option>priority<literal> = </literal><replaceable
119
>STRING</replaceable></option></term>
121
<xi:include href="mandos-options.xml" xpointer="priority"/>
126
<term><option>servicename<literal> = </literal
127
><replaceable>NAME</replaceable></option></term>
129
<xi:include href="mandos-options.xml"
130
xpointer="servicename"/>
135
<term><option>use_dbus<literal> = </literal>{ <literal
136
>1</literal> | <literal>yes</literal> | <literal
137
>true</literal> | <literal>on</literal> | <literal
138
>0</literal> | <literal>no</literal> | <literal
139
>false</literal> | <literal>off</literal> }</option></term>
141
<xi:include href="mandos-options.xml" xpointer="dbus"/>
146
<term><option>use_ipv6<literal> = </literal>{ <literal
147
>1</literal> | <literal>yes</literal> | <literal
148
>true</literal> | <literal>on</literal> | <literal
149
>0</literal> | <literal>no</literal> | <literal
150
>false</literal> | <literal>off</literal> }</option></term>
152
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
159
<refsect1 id="files">
162
The file described here is &CONFPATH;
169
The <literal>[DEFAULT]</literal> is necessary because the Python
170
built-in module <systemitem class="library">ConfigParser</systemitem>
175
<refsect1 id="example">
176
<title>EXAMPLE</title>
179
No options are actually required:
187
An example using all the options:
191
# A configuration example
193
address = fe80::aede:48ff:fe71:f6f2
196
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
204
<refsect1 id="see_also">
205
<title>SEE ALSO</title>
207
<citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
208
><manvolnum>3</manvolnum></citerefentry>,
209
<citerefentry><refentrytitle>mandos</refentrytitle>
210
<manvolnum>8</manvolnum></citerefentry>,
211
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
212
<manvolnum>5</manvolnum></citerefentry>
218
RFC 4291: <citetitle>IP Version 6 Addressing
219
Architecture</citetitle>
224
<term>Section 2.2: <citetitle>Text Representation of
225
Addresses</citetitle></term>
226
<listitem><para/></listitem>
229
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
230
Address</citetitle></term>
231
<listitem><para/></listitem>
234
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
235
Addresses</citetitle></term>
238
The clients use IPv6 link-local addresses, which are
239
immediately usable since a link-local addresses is
240
automatically assigned to a network interface when it
250
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
254
Zeroconf is the network protocol standard used by clients
255
for finding the Mandos server on the local network.
262
<!-- Local Variables: -->
263
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
264
<!-- time-stamp-end: "[\"']>" -->
265
<!-- time-stamp-format: "%:y-%02m-%02d" -->