/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.conf.xml

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY CONFNAME "mandos.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2013-10-23">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY TIMESTAMP "2008-08-31">
9
8
]>
10
9
 
11
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
13
12
    <title>Mandos Manual</title>
14
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
14
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
 
15
    <productnumber>&VERSION;</productnumber>
17
16
    <date>&TIMESTAMP;</date>
18
17
    <authorgroup>
19
18
      <author>
20
19
        <firstname>Björn</firstname>
21
20
        <surname>Påhlsson</surname>
22
21
        <address>
23
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
24
23
        </address>
25
24
      </author>
26
25
      <author>
27
26
        <firstname>Teddy</firstname>
28
27
        <surname>Hogeborn</surname>
29
28
        <address>
30
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
31
30
        </address>
32
31
      </author>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
36
 
      <year>2009</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
35
      <holder>Teddy Hogeborn</holder>
41
36
      <holder>Björn Påhlsson</holder>
42
37
    </copyright>
43
38
    <xi:include href="legalnotice.xml"/>
44
39
  </refentryinfo>
45
 
  
 
40
 
46
41
  <refmeta>
47
42
    <refentrytitle>&CONFNAME;</refentrytitle>
48
43
    <manvolnum>5</manvolnum>
54
49
      Configuration file for the Mandos server
55
50
    </refpurpose>
56
51
  </refnamediv>
57
 
  
 
52
 
58
53
  <refsynopsisdiv>
59
54
    <synopsis>&CONFPATH;</synopsis>
60
55
  </refsynopsisdiv>
61
 
  
 
56
 
62
57
  <refsect1 id="description">
63
58
    <title>DESCRIPTION</title>
64
59
    <para>
76
71
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
77
72
      to provide comments.
78
73
    </para>
79
 
    
 
74
 
80
75
  </refsect1>
81
76
  <refsect1>
82
77
    <title>OPTIONS</title>
89
84
          <xi:include href="mandos-options.xml" xpointer="interface"/>
90
85
        </listitem>
91
86
      </varlistentry>
92
 
      
 
87
 
93
88
      <varlistentry>
94
89
        <term><option>address<literal> = </literal><replaceable
95
90
          >ADDRESS</replaceable></option></term>
97
92
          <xi:include href="mandos-options.xml" xpointer="address"/>
98
93
        </listitem>
99
94
      </varlistentry>
100
 
      
 
95
 
101
96
      <varlistentry>
102
97
        <term><option>port<literal> = </literal><replaceable
103
98
        >NUMBER</replaceable></option></term>
105
100
          <xi:include href="mandos-options.xml" xpointer="port"/>
106
101
        </listitem>
107
102
      </varlistentry>
108
 
      
 
103
 
109
104
      <varlistentry>
110
105
        <term><option>debug<literal> = </literal>{ <literal
111
106
          >1</literal> | <literal>yes</literal> | <literal
116
111
          <xi:include href="mandos-options.xml" xpointer="debug"/>
117
112
        </listitem>
118
113
      </varlistentry>
119
 
      
 
114
 
120
115
      <varlistentry>
121
116
        <term><option>priority<literal> = </literal><replaceable
122
117
        >STRING</replaceable></option></term>
123
118
        <listitem>
124
 
          <xi:include href="mandos-options.xml"
125
 
                      xpointer="priority_compat"/>
 
119
          <xi:include href="mandos-options.xml" xpointer="priority"/>
126
120
        </listitem>
127
121
      </varlistentry>
128
 
      
 
122
 
129
123
      <varlistentry>
130
124
        <term><option>servicename<literal> = </literal
131
125
        ><replaceable>NAME</replaceable></option></term>
135
129
        </listitem>
136
130
      </varlistentry>
137
131
      
138
 
      <varlistentry>
139
 
        <term><option>use_dbus<literal> = </literal>{ <literal
140
 
          >1</literal> | <literal>yes</literal> | <literal
141
 
          >true</literal> | <literal>on</literal> | <literal
142
 
          >0</literal> | <literal>no</literal> | <literal
143
 
          >false</literal> | <literal>off</literal> }</option></term>
144
 
        <listitem>
145
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
146
 
        </listitem>
147
 
      </varlistentry>
148
 
      
149
 
      <varlistentry>
150
 
        <term><option>use_ipv6<literal> = </literal>{ <literal
151
 
          >1</literal> | <literal>yes</literal> | <literal
152
 
          >true</literal> | <literal>on</literal> | <literal
153
 
          >0</literal> | <literal>no</literal> | <literal
154
 
          >false</literal> | <literal>off</literal> }</option></term>
155
 
        <listitem>
156
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
157
 
        </listitem>
158
 
      </varlistentry>
159
 
      
160
 
      <varlistentry>
161
 
        <term><option>restore<literal> = </literal>{ <literal
162
 
          >1</literal> | <literal>yes</literal> | <literal
163
 
          >true</literal> | <literal>on</literal> | <literal
164
 
          >0</literal> | <literal>no</literal> | <literal
165
 
          >false</literal> | <literal>off</literal> }</option></term>
166
 
        <listitem>
167
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
168
 
        </listitem>
169
 
      </varlistentry>
170
 
      
171
 
      <varlistentry>
172
 
        <term><option>statedir<literal> = </literal><replaceable
173
 
        >DIRECTORY</replaceable></option></term>
174
 
        <listitem>
175
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
176
 
        </listitem>
177
 
      </varlistentry>
178
 
      
179
 
      <varlistentry>
180
 
        <term><option>socket<literal> = </literal><replaceable
181
 
        >NUMBER</replaceable></option></term>
182
 
        <listitem>
183
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
184
 
        </listitem>
185
 
      </varlistentry>
186
 
      
187
132
    </variablelist>
188
133
  </refsect1>
189
134
  
199
144
    <para>
200
145
      The <literal>[DEFAULT]</literal> is necessary because the Python
201
146
      built-in module <systemitem class="library">ConfigParser</systemitem>
202
 
      requires it.
 
147
      requres it.
203
148
    </para>
204
149
  </refsect1>
205
150
  
221
166
[DEFAULT]
222
167
# A configuration example
223
168
interface = eth0
224
 
address = fe80::aede:48ff:fe71:f6f2
 
169
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
225
170
port = 1025
226
171
debug = true
227
172
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
228
173
servicename = Daena
229
 
use_dbus = False
230
 
use_ipv6 = True
231
 
restore = True
232
 
statedir = /var/lib/mandos
233
174
      </programlisting>
234
175
    </informalexample>
235
176
  </refsect1>
237
178
  <refsect1 id="see_also">
238
179
    <title>SEE ALSO</title>
239
180
    <para>
240
 
      <citerefentry><refentrytitle>intro</refentrytitle>
241
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
242
181
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
243
182
      ><manvolnum>3</manvolnum></citerefentry>,
244
183
      <citerefentry><refentrytitle>mandos</refentrytitle>
246
185
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
247
186
      <manvolnum>5</manvolnum></citerefentry>
248
187
    </para>
249
 
    
 
188
 
250
189
    <variablelist>
251
190
      <varlistentry>
252
191
        <term>
272
211
              <para>
273
212
                The clients use IPv6 link-local addresses, which are
274
213
                immediately usable since a link-local addresses is
275
 
                automatically assigned to a network interface when it
 
214
                automatically assigned to a network interfaces when it
276
215
                is brought up.
277
216
              </para>
278
217
            </listitem>