/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 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 "2009-02-25">
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>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
36
 
      <year>2009</year>
37
35
      <holder>Teddy Hogeborn</holder>
38
36
      <holder>Björn Påhlsson</holder>
39
37
    </copyright>
40
38
    <xi:include href="legalnotice.xml"/>
41
39
  </refentryinfo>
42
 
  
 
40
 
43
41
  <refmeta>
44
42
    <refentrytitle>&CONFNAME;</refentrytitle>
45
43
    <manvolnum>5</manvolnum>
51
49
      Configuration file for the Mandos server
52
50
    </refpurpose>
53
51
  </refnamediv>
54
 
  
 
52
 
55
53
  <refsynopsisdiv>
56
54
    <synopsis>&CONFPATH;</synopsis>
57
55
  </refsynopsisdiv>
58
 
  
 
56
 
59
57
  <refsect1 id="description">
60
58
    <title>DESCRIPTION</title>
61
59
    <para>
73
71
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
74
72
      to provide comments.
75
73
    </para>
76
 
    
 
74
 
77
75
  </refsect1>
78
76
  <refsect1>
79
77
    <title>OPTIONS</title>
86
84
          <xi:include href="mandos-options.xml" xpointer="interface"/>
87
85
        </listitem>
88
86
      </varlistentry>
89
 
      
 
87
 
90
88
      <varlistentry>
91
89
        <term><option>address<literal> = </literal><replaceable
92
90
          >ADDRESS</replaceable></option></term>
94
92
          <xi:include href="mandos-options.xml" xpointer="address"/>
95
93
        </listitem>
96
94
      </varlistentry>
97
 
      
 
95
 
98
96
      <varlistentry>
99
97
        <term><option>port<literal> = </literal><replaceable
100
98
        >NUMBER</replaceable></option></term>
102
100
          <xi:include href="mandos-options.xml" xpointer="port"/>
103
101
        </listitem>
104
102
      </varlistentry>
105
 
      
 
103
 
106
104
      <varlistentry>
107
105
        <term><option>debug<literal> = </literal>{ <literal
108
106
          >1</literal> | <literal>yes</literal> | <literal
113
111
          <xi:include href="mandos-options.xml" xpointer="debug"/>
114
112
        </listitem>
115
113
      </varlistentry>
116
 
      
 
114
 
117
115
      <varlistentry>
118
116
        <term><option>priority<literal> = </literal><replaceable
119
117
        >STRING</replaceable></option></term>
121
119
          <xi:include href="mandos-options.xml" xpointer="priority"/>
122
120
        </listitem>
123
121
      </varlistentry>
124
 
      
 
122
 
125
123
      <varlistentry>
126
124
        <term><option>servicename<literal> = </literal
127
125
        ><replaceable>NAME</replaceable></option></term>
131
129
        </listitem>
132
130
      </varlistentry>
133
131
      
134
 
      <varlistentry>
135
 
        <term><option>use_dbus<literal> = </literal>{ <literal
136
 
          >1</literal> | <literal>yes</literal> | <literal
137
 
          >true</literal> | <literal>on</literal> | <literal
138
 
          >0</literal> | <literal>no</literal> | <literal
139
 
          >false</literal> | <literal>off</literal> }</option></term>
140
 
        <listitem>
141
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
142
 
        </listitem>
143
 
      </varlistentry>
144
 
      
145
 
      <varlistentry>
146
 
        <term><option>use_ipv6<literal> = </literal>{ <literal
147
 
          >1</literal> | <literal>yes</literal> | <literal
148
 
          >true</literal> | <literal>on</literal> | <literal
149
 
          >0</literal> | <literal>no</literal> | <literal
150
 
          >false</literal> | <literal>off</literal> }</option></term>
151
 
        <listitem>
152
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
153
 
        </listitem>
154
 
      </varlistentry>
155
 
      
156
132
    </variablelist>
157
133
  </refsect1>
158
134
  
168
144
    <para>
169
145
      The <literal>[DEFAULT]</literal> is necessary because the Python
170
146
      built-in module <systemitem class="library">ConfigParser</systemitem>
171
 
      requires it.
 
147
      requres it.
172
148
    </para>
173
149
  </refsect1>
174
150
  
190
166
[DEFAULT]
191
167
# A configuration example
192
168
interface = eth0
193
 
address = fe80::aede:48ff:fe71:f6f2
 
169
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
194
170
port = 1025
195
171
debug = true
196
172
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
197
173
servicename = Daena
198
 
use_dbus = False
199
 
use_ipv6 = True
200
174
      </programlisting>
201
175
    </informalexample>
202
176
  </refsect1>
211
185
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
212
186
      <manvolnum>5</manvolnum></citerefentry>
213
187
    </para>
214
 
    
 
188
 
215
189
    <variablelist>
216
190
      <varlistentry>
217
191
        <term>
237
211
              <para>
238
212
                The clients use IPv6 link-local addresses, which are
239
213
                immediately usable since a link-local addresses is
240
 
                automatically assigned to a network interface when it
 
214
                automatically assigned to a network interfaces when it
241
215
                is brought up.
242
216
              </para>
243
217
            </listitem>