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 "2018-02-08">
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>
46
<holder>Teddy Hogeborn</holder>
47
<holder>Björn Påhlsson</holder>
49
<xi:include href="legalnotice.xml"/>
53
<refentrytitle>&CONFNAME;</refentrytitle>
54
<manvolnum>5</manvolnum>
58
<refname><filename>&CONFNAME;</filename></refname>
60
Configuration file for the Mandos server
65
<synopsis>&CONFPATH;</synopsis>
68
<refsect1 id="description">
69
<title>DESCRIPTION</title>
71
The file &CONFPATH; is a simple configuration file for
72
<citerefentry><refentrytitle>mandos</refentrytitle>
73
<manvolnum>8</manvolnum></citerefentry>, and is read by it at
74
startup. The configuration file starts with <quote><literal
75
>[DEFAULT]</literal></quote> on a line by itself, followed by
76
any number of <quote><varname><replaceable>option</replaceable
77
></varname>=<replaceable>value</replaceable></quote> entries,
78
with continuations in the style of RFC 822. <quote><varname
79
><replaceable>option</replaceable></varname>: <replaceable
80
>value</replaceable></quote> is also accepted. Note that
81
leading whitespace is removed from values. Lines beginning with
82
<quote>#</quote> or <quote>;</quote> are ignored and may be used
88
<title>OPTIONS</title>
92
<term><option>interface<literal> = </literal><replaceable
93
>NAME</replaceable></option></term>
95
<xi:include href="mandos-options.xml" xpointer="interface"/>
100
<term><option>address<literal> = </literal><replaceable
101
>ADDRESS</replaceable></option></term>
103
<xi:include href="mandos-options.xml" xpointer="address"/>
108
<term><option>port<literal> = </literal><replaceable
109
>NUMBER</replaceable></option></term>
111
<xi:include href="mandos-options.xml" xpointer="port"/>
116
<term><option>debug<literal> = </literal>{ <literal
117
>1</literal> | <literal>yes</literal> | <literal
118
>true</literal> | <literal>on</literal> | <literal
119
>0</literal> | <literal>no</literal> | <literal
120
>false</literal> | <literal>off</literal> }</option></term>
122
<xi:include href="mandos-options.xml" xpointer="debug"/>
127
<term><option>priority<literal> = </literal><replaceable
128
>STRING</replaceable></option></term>
130
<xi:include href="mandos-options.xml" xpointer="priority"/>
135
<term><option>servicename<literal> = </literal
136
><replaceable>NAME</replaceable></option></term>
138
<xi:include href="mandos-options.xml"
139
xpointer="servicename"/>
144
<term><option>use_dbus<literal> = </literal>{ <literal
145
>1</literal> | <literal>yes</literal> | <literal
146
>true</literal> | <literal>on</literal> | <literal
147
>0</literal> | <literal>no</literal> | <literal
148
>false</literal> | <literal>off</literal> }</option></term>
150
<xi:include href="mandos-options.xml" xpointer="dbus"/>
155
<term><option>use_ipv6<literal> = </literal>{ <literal
156
>1</literal> | <literal>yes</literal> | <literal
157
>true</literal> | <literal>on</literal> | <literal
158
>0</literal> | <literal>no</literal> | <literal
159
>false</literal> | <literal>off</literal> }</option></term>
161
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
166
<term><option>restore<literal> = </literal>{ <literal
167
>1</literal> | <literal>yes</literal> | <literal
168
>true</literal> | <literal>on</literal> | <literal
169
>0</literal> | <literal>no</literal> | <literal
170
>false</literal> | <literal>off</literal> }</option></term>
172
<xi:include href="mandos-options.xml" xpointer="restore"/>
177
<term><option>statedir<literal> = </literal><replaceable
178
>DIRECTORY</replaceable></option></term>
180
<xi:include href="mandos-options.xml" xpointer="statedir"/>
185
<term><option>socket<literal> = </literal><replaceable
186
>NUMBER</replaceable></option></term>
188
<xi:include href="mandos-options.xml" xpointer="socket"/>
195
<refsect1 id="files">
198
The file described here is &CONFPATH;
205
The <literal>[DEFAULT]</literal> is necessary because the Python
206
built-in module <systemitem class="library">ConfigParser</systemitem>
209
<xi:include href="bugs.xml"/>
212
<refsect1 id="example">
213
<title>EXAMPLE</title>
216
No options are actually required:
224
An example using all the options:
228
# A configuration example
230
address = fe80::aede:48ff:fe71:f6f2
233
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
238
statedir = /var/lib/mandos
243
<refsect1 id="see_also">
244
<title>SEE ALSO</title>
246
<citerefentry><refentrytitle>intro</refentrytitle>
247
<manvolnum>8mandos</manvolnum></citerefentry>,
248
<citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
249
><manvolnum>3</manvolnum></citerefentry>,
250
<citerefentry><refentrytitle>mandos</refentrytitle>
251
<manvolnum>8</manvolnum></citerefentry>,
252
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
253
<manvolnum>5</manvolnum></citerefentry>
259
RFC 4291: <citetitle>IP Version 6 Addressing
260
Architecture</citetitle>
265
<term>Section 2.2: <citetitle>Text Representation of
266
Addresses</citetitle></term>
267
<listitem><para/></listitem>
270
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
271
Address</citetitle></term>
272
<listitem><para/></listitem>
275
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
276
Addresses</citetitle></term>
279
The clients use IPv6 link-local addresses, which are
280
immediately usable since a link-local addresses is
281
automatically assigned to a network interface when it
291
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
295
Zeroconf is the network protocol standard used by clients
296
for finding the Mandos server on the local network.
303
<!-- Local Variables: -->
304
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
305
<!-- time-stamp-end: "[\"']>" -->
306
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
mandos.conf.xml
