/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-02 13:04:42 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902130442-ytnjsmllaph18e20
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
  (BUGS): Commented out.  There are no bugs.
  (EXAMPLE): Added lots of examples.
  (SECURITY): Added text.
  (SEE ALSO): Added "crypttab(5)" and "execve(2)".

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 "2011-11-26">
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
35
      <holder>Teddy Hogeborn</holder>
39
36
      <holder>Björn Påhlsson</holder>
40
37
    </copyright>
41
38
    <xi:include href="legalnotice.xml"/>
42
39
  </refentryinfo>
43
 
  
 
40
 
44
41
  <refmeta>
45
42
    <refentrytitle>&CONFNAME;</refentrytitle>
46
43
    <manvolnum>5</manvolnum>
52
49
      Configuration file for the Mandos server
53
50
    </refpurpose>
54
51
  </refnamediv>
55
 
  
 
52
 
56
53
  <refsynopsisdiv>
57
54
    <synopsis>&CONFPATH;</synopsis>
58
55
  </refsynopsisdiv>
59
 
  
 
56
 
60
57
  <refsect1 id="description">
61
58
    <title>DESCRIPTION</title>
62
59
    <para>
74
71
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
75
72
      to provide comments.
76
73
    </para>
77
 
    
 
74
 
78
75
  </refsect1>
79
76
  <refsect1>
80
77
    <title>OPTIONS</title>
87
84
          <xi:include href="mandos-options.xml" xpointer="interface"/>
88
85
        </listitem>
89
86
      </varlistentry>
90
 
      
 
87
 
91
88
      <varlistentry>
92
89
        <term><option>address<literal> = </literal><replaceable
93
90
          >ADDRESS</replaceable></option></term>
95
92
          <xi:include href="mandos-options.xml" xpointer="address"/>
96
93
        </listitem>
97
94
      </varlistentry>
98
 
      
 
95
 
99
96
      <varlistentry>
100
97
        <term><option>port<literal> = </literal><replaceable
101
98
        >NUMBER</replaceable></option></term>
103
100
          <xi:include href="mandos-options.xml" xpointer="port"/>
104
101
        </listitem>
105
102
      </varlistentry>
106
 
      
 
103
 
107
104
      <varlistentry>
108
105
        <term><option>debug<literal> = </literal>{ <literal
109
106
          >1</literal> | <literal>yes</literal> | <literal
114
111
          <xi:include href="mandos-options.xml" xpointer="debug"/>
115
112
        </listitem>
116
113
      </varlistentry>
117
 
      
 
114
 
118
115
      <varlistentry>
119
116
        <term><option>priority<literal> = </literal><replaceable
120
117
        >STRING</replaceable></option></term>
122
119
          <xi:include href="mandos-options.xml" xpointer="priority"/>
123
120
        </listitem>
124
121
      </varlistentry>
125
 
      
 
122
 
126
123
      <varlistentry>
127
124
        <term><option>servicename<literal> = </literal
128
125
        ><replaceable>NAME</replaceable></option></term>
132
129
        </listitem>
133
130
      </varlistentry>
134
131
      
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
 
      
176
132
    </variablelist>
177
133
  </refsect1>
178
134
  
188
144
    <para>
189
145
      The <literal>[DEFAULT]</literal> is necessary because the Python
190
146
      built-in module <systemitem class="library">ConfigParser</systemitem>
191
 
      requires it.
 
147
      requres it.
192
148
    </para>
193
149
  </refsect1>
194
150
  
210
166
[DEFAULT]
211
167
# A configuration example
212
168
interface = eth0
213
 
address = fe80::aede:48ff:fe71:f6f2
 
169
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
214
170
port = 1025
215
171
debug = true
216
172
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
217
173
servicename = Daena
218
 
use_dbus = False
219
 
use_ipv6 = True
220
 
restore = True
221
 
statedir = /var/lib/mandos
222
174
      </programlisting>
223
175
    </informalexample>
224
176
  </refsect1>
226
178
  <refsect1 id="see_also">
227
179
    <title>SEE ALSO</title>
228
180
    <para>
229
 
      <citerefentry><refentrytitle>intro</refentrytitle>
230
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
231
181
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
232
182
      ><manvolnum>3</manvolnum></citerefentry>,
233
183
      <citerefentry><refentrytitle>mandos</refentrytitle>
235
185
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
236
186
      <manvolnum>5</manvolnum></citerefentry>
237
187
    </para>
238
 
    
 
188
 
239
189
    <variablelist>
240
190
      <varlistentry>
241
191
        <term>
261
211
              <para>
262
212
                The clients use IPv6 link-local addresses, which are
263
213
                immediately usable since a link-local addresses is
264
 
                automatically assigned to a network interface when it
 
214
                automatically assigned to a network interfaces when it
265
215
                is brought up.
266
216
              </para>
267
217
            </listitem>