/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">
5
4
<!ENTITY CONFNAME "mandos.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-09-04">
 
6
<!ENTITY TIMESTAMP "2011-11-26">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
    <productname>Mandos</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
16
    <productnumber>&version;</productnumber>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
19
20
        <firstname>Björn</firstname>
20
21
        <surname>Påhlsson</surname>
21
22
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.se</email>
23
24
        </address>
24
25
      </author>
25
26
      <author>
26
27
        <firstname>Teddy</firstname>
27
28
        <surname>Hogeborn</surname>
28
29
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.se</email>
30
31
        </address>
31
32
      </author>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
 
36
      <year>2009</year>
 
37
      <year>2011</year>
35
38
      <holder>Teddy Hogeborn</holder>
36
39
      <holder>Björn Påhlsson</holder>
37
40
    </copyright>
38
41
    <xi:include href="legalnotice.xml"/>
39
42
  </refentryinfo>
40
 
 
 
43
  
41
44
  <refmeta>
42
45
    <refentrytitle>&CONFNAME;</refentrytitle>
43
46
    <manvolnum>5</manvolnum>
49
52
      Configuration file for the Mandos server
50
53
    </refpurpose>
51
54
  </refnamediv>
52
 
 
 
55
  
53
56
  <refsynopsisdiv>
54
57
    <synopsis>&CONFPATH;</synopsis>
55
58
  </refsynopsisdiv>
56
 
 
 
59
  
57
60
  <refsect1 id="description">
58
61
    <title>DESCRIPTION</title>
59
62
    <para>
71
74
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
72
75
      to provide comments.
73
76
    </para>
74
 
 
 
77
    
75
78
  </refsect1>
76
79
  <refsect1>
77
80
    <title>OPTIONS</title>
84
87
          <xi:include href="mandos-options.xml" xpointer="interface"/>
85
88
        </listitem>
86
89
      </varlistentry>
87
 
 
 
90
      
88
91
      <varlistentry>
89
92
        <term><option>address<literal> = </literal><replaceable
90
93
          >ADDRESS</replaceable></option></term>
92
95
          <xi:include href="mandos-options.xml" xpointer="address"/>
93
96
        </listitem>
94
97
      </varlistentry>
95
 
 
 
98
      
96
99
      <varlistentry>
97
100
        <term><option>port<literal> = </literal><replaceable
98
101
        >NUMBER</replaceable></option></term>
100
103
          <xi:include href="mandos-options.xml" xpointer="port"/>
101
104
        </listitem>
102
105
      </varlistentry>
103
 
 
 
106
      
104
107
      <varlistentry>
105
108
        <term><option>debug<literal> = </literal>{ <literal
106
109
          >1</literal> | <literal>yes</literal> | <literal
111
114
          <xi:include href="mandos-options.xml" xpointer="debug"/>
112
115
        </listitem>
113
116
      </varlistentry>
114
 
 
 
117
      
115
118
      <varlistentry>
116
119
        <term><option>priority<literal> = </literal><replaceable
117
120
        >STRING</replaceable></option></term>
119
122
          <xi:include href="mandos-options.xml" xpointer="priority"/>
120
123
        </listitem>
121
124
      </varlistentry>
122
 
 
 
125
      
123
126
      <varlistentry>
124
127
        <term><option>servicename<literal> = </literal
125
128
        ><replaceable>NAME</replaceable></option></term>
129
132
        </listitem>
130
133
      </varlistentry>
131
134
      
 
135
      <varlistentry>
 
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>
 
141
        <listitem>
 
142
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
143
        </listitem>
 
144
      </varlistentry>
 
145
      
 
146
      <varlistentry>
 
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>
 
152
        <listitem>
 
153
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
154
        </listitem>
 
155
      </varlistentry>
 
156
      
 
157
      <varlistentry>
 
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>
 
163
        <listitem>
 
164
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
165
        </listitem>
 
166
      </varlistentry>
 
167
      
 
168
      <varlistentry>
 
169
        <term><option>statedir<literal> = </literal><replaceable
 
170
        >DIRECTORY</replaceable></option></term>
 
171
        <listitem>
 
172
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
173
        </listitem>
 
174
      </varlistentry>
 
175
      
132
176
    </variablelist>
133
177
  </refsect1>
134
178
  
166
210
[DEFAULT]
167
211
# A configuration example
168
212
interface = eth0
169
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
 
213
address = fe80::aede:48ff:fe71:f6f2
170
214
port = 1025
171
215
debug = true
172
216
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
173
217
servicename = Daena
 
218
use_dbus = False
 
219
use_ipv6 = True
 
220
restore = True
 
221
statedir = /var/lib/mandos
174
222
      </programlisting>
175
223
    </informalexample>
176
224
  </refsect1>
178
226
  <refsect1 id="see_also">
179
227
    <title>SEE ALSO</title>
180
228
    <para>
 
229
      <citerefentry><refentrytitle>intro</refentrytitle>
 
230
      <manvolnum>8mandos</manvolnum></citerefentry>,
181
231
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
182
232
      ><manvolnum>3</manvolnum></citerefentry>,
183
233
      <citerefentry><refentrytitle>mandos</refentrytitle>
185
235
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
186
236
      <manvolnum>5</manvolnum></citerefentry>
187
237
    </para>
188
 
 
 
238
    
189
239
    <variablelist>
190
240
      <varlistentry>
191
241
        <term>
211
261
              <para>
212
262
                The clients use IPv6 link-local addresses, which are
213
263
                immediately usable since a link-local addresses is
214
 
                automatically assigned to a network interfaces when it
 
264
                automatically assigned to a network interface when it
215
265
                is brought up.
216
266
              </para>
217
267
            </listitem>