/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-03 13:59:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903135958-k0he2xucqmx7nz4b
* plugins.d/password-request.xml (OPTIONS): Improved wording.
  (FILES): Add text about public and secret key files.
  (BUGS): Commented out.
  (EXAMPLE): Added examples.

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