/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-04 07:44:49 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080904074449-pk6vtwo9fp3lq62i
* README: Improved spelling.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2016-03-05">
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>2010</year>
38
 
      <year>2011</year>
39
 
      <year>2012</year>
40
 
      <year>2013</year>
41
 
      <year>2014</year>
42
 
      <year>2015</year>
43
 
      <year>2016</year>
44
35
      <holder>Teddy Hogeborn</holder>
45
36
      <holder>Björn Påhlsson</holder>
46
37
    </copyright>
47
38
    <xi:include href="legalnotice.xml"/>
48
39
  </refentryinfo>
49
 
  
 
40
 
50
41
  <refmeta>
51
42
    <refentrytitle>&CONFNAME;</refentrytitle>
52
43
    <manvolnum>5</manvolnum>
58
49
      Configuration file for the Mandos server
59
50
    </refpurpose>
60
51
  </refnamediv>
61
 
  
 
52
 
62
53
  <refsynopsisdiv>
63
54
    <synopsis>&CONFPATH;</synopsis>
64
55
  </refsynopsisdiv>
65
 
  
 
56
 
66
57
  <refsect1 id="description">
67
58
    <title>DESCRIPTION</title>
68
59
    <para>
80
71
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
81
72
      to provide comments.
82
73
    </para>
83
 
    
 
74
 
84
75
  </refsect1>
85
76
  <refsect1>
86
77
    <title>OPTIONS</title>
93
84
          <xi:include href="mandos-options.xml" xpointer="interface"/>
94
85
        </listitem>
95
86
      </varlistentry>
96
 
      
 
87
 
97
88
      <varlistentry>
98
89
        <term><option>address<literal> = </literal><replaceable
99
90
          >ADDRESS</replaceable></option></term>
101
92
          <xi:include href="mandos-options.xml" xpointer="address"/>
102
93
        </listitem>
103
94
      </varlistentry>
104
 
      
 
95
 
105
96
      <varlistentry>
106
97
        <term><option>port<literal> = </literal><replaceable
107
98
        >NUMBER</replaceable></option></term>
109
100
          <xi:include href="mandos-options.xml" xpointer="port"/>
110
101
        </listitem>
111
102
      </varlistentry>
112
 
      
 
103
 
113
104
      <varlistentry>
114
105
        <term><option>debug<literal> = </literal>{ <literal
115
106
          >1</literal> | <literal>yes</literal> | <literal
120
111
          <xi:include href="mandos-options.xml" xpointer="debug"/>
121
112
        </listitem>
122
113
      </varlistentry>
123
 
      
 
114
 
124
115
      <varlistentry>
125
116
        <term><option>priority<literal> = </literal><replaceable
126
117
        >STRING</replaceable></option></term>
128
119
          <xi:include href="mandos-options.xml" xpointer="priority"/>
129
120
        </listitem>
130
121
      </varlistentry>
131
 
      
 
122
 
132
123
      <varlistentry>
133
124
        <term><option>servicename<literal> = </literal
134
125
        ><replaceable>NAME</replaceable></option></term>
138
129
        </listitem>
139
130
      </varlistentry>
140
131
      
141
 
      <varlistentry>
142
 
        <term><option>use_dbus<literal> = </literal>{ <literal
143
 
          >1</literal> | <literal>yes</literal> | <literal
144
 
          >true</literal> | <literal>on</literal> | <literal
145
 
          >0</literal> | <literal>no</literal> | <literal
146
 
          >false</literal> | <literal>off</literal> }</option></term>
147
 
        <listitem>
148
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
149
 
        </listitem>
150
 
      </varlistentry>
151
 
      
152
 
      <varlistentry>
153
 
        <term><option>use_ipv6<literal> = </literal>{ <literal
154
 
          >1</literal> | <literal>yes</literal> | <literal
155
 
          >true</literal> | <literal>on</literal> | <literal
156
 
          >0</literal> | <literal>no</literal> | <literal
157
 
          >false</literal> | <literal>off</literal> }</option></term>
158
 
        <listitem>
159
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
160
 
        </listitem>
161
 
      </varlistentry>
162
 
      
163
 
      <varlistentry>
164
 
        <term><option>restore<literal> = </literal>{ <literal
165
 
          >1</literal> | <literal>yes</literal> | <literal
166
 
          >true</literal> | <literal>on</literal> | <literal
167
 
          >0</literal> | <literal>no</literal> | <literal
168
 
          >false</literal> | <literal>off</literal> }</option></term>
169
 
        <listitem>
170
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
171
 
        </listitem>
172
 
      </varlistentry>
173
 
      
174
 
      <varlistentry>
175
 
        <term><option>statedir<literal> = </literal><replaceable
176
 
        >DIRECTORY</replaceable></option></term>
177
 
        <listitem>
178
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
179
 
        </listitem>
180
 
      </varlistentry>
181
 
      
182
 
      <varlistentry>
183
 
        <term><option>socket<literal> = </literal><replaceable
184
 
        >NUMBER</replaceable></option></term>
185
 
        <listitem>
186
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
187
 
        </listitem>
188
 
      </varlistentry>
189
 
      
190
132
    </variablelist>
191
133
  </refsect1>
192
134
  
202
144
    <para>
203
145
      The <literal>[DEFAULT]</literal> is necessary because the Python
204
146
      built-in module <systemitem class="library">ConfigParser</systemitem>
205
 
      requires it.
 
147
      requres it.
206
148
    </para>
207
 
    <xi:include href="bugs.xml"/>
208
149
  </refsect1>
209
150
  
210
151
  <refsect1 id="example">
225
166
[DEFAULT]
226
167
# A configuration example
227
168
interface = eth0
228
 
address = fe80::aede:48ff:fe71:f6f2
 
169
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
229
170
port = 1025
230
 
debug = True
231
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
 
171
debug = true
 
172
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
232
173
servicename = Daena
233
 
use_dbus = False
234
 
use_ipv6 = True
235
 
restore = True
236
 
statedir = /var/lib/mandos
237
174
      </programlisting>
238
175
    </informalexample>
239
176
  </refsect1>
241
178
  <refsect1 id="see_also">
242
179
    <title>SEE ALSO</title>
243
180
    <para>
244
 
      <citerefentry><refentrytitle>intro</refentrytitle>
245
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
246
181
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
247
182
      ><manvolnum>3</manvolnum></citerefentry>,
248
183
      <citerefentry><refentrytitle>mandos</refentrytitle>
250
185
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
251
186
      <manvolnum>5</manvolnum></citerefentry>
252
187
    </para>
253
 
    
 
188
 
254
189
    <variablelist>
255
190
      <varlistentry>
256
191
        <term>
276
211
              <para>
277
212
                The clients use IPv6 link-local addresses, which are
278
213
                immediately usable since a link-local addresses is
279
 
                automatically assigned to a network interface when it
 
214
                automatically assigned to a network interfaces when it
280
215
                is brought up.
281
216
              </para>
282
217
            </listitem>