/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

  • Committer: Teddy Hogeborn
  • Date: 2008-09-03 19:37:07 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903193707-sas85ud9r37ubs9r
* mandos-clients.conf.xml (OPTIONS): Add info to all options about
                                     whether it is a required or
                                     optional.

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