/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-08-27 01:18:25 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080827011825-ka3ni6xvy2ehi1y8
* .bzrignore: New.

* clients.conf ([foo]): Remove Radix-64 checksum.

* mandos (AvahiService.rename, server_state_changed,
          entry_group_state_changed): Make Avahi log messages more
                                      clear that they are about
                                      Zeroconf.
  (fingerprint): Use plain "0" instead of "ctypes.c_uint(0)".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
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;
9
7
]>
10
8
 
11
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
10
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
 
11
    <title>&CONFNAME;</title>
14
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
 
13
    <productname>&CONFNAME;</productname>
 
14
    <productnumber>&VERSION;</productnumber>
18
15
    <authorgroup>
19
16
      <author>
20
17
        <firstname>Björn</firstname>
21
18
        <surname>Påhlsson</surname>
22
19
        <address>
23
 
          <email>belorn@recompile.se</email>
 
20
          <email>belorn@fukt.bsnet.se</email>
24
21
        </address>
25
22
      </author>
26
23
      <author>
27
24
        <firstname>Teddy</firstname>
28
25
        <surname>Hogeborn</surname>
29
26
        <address>
30
 
          <email>teddy@recompile.se</email>
 
27
          <email>teddy@fukt.bsnet.se</email>
31
28
        </address>
32
29
      </author>
33
30
    </authorgroup>
34
31
    <copyright>
35
32
      <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
33
      <holder>Teddy Hogeborn</holder>
46
34
      <holder>Björn Påhlsson</holder>
47
35
    </copyright>
48
 
    <xi:include href="legalnotice.xml"/>
 
36
    <legalnotice>
 
37
      <para>
 
38
        This manual page is free software: you can redistribute it
 
39
        and/or modify it under the terms of the GNU General Public
 
40
        License as published by the Free Software Foundation,
 
41
        either version 3 of the License, or (at your option) any
 
42
        later version.
 
43
      </para>
 
44
 
 
45
      <para>
 
46
        This manual page is distributed in the hope that it will
 
47
        be useful, but WITHOUT ANY WARRANTY; without even the
 
48
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
49
        PARTICULAR PURPOSE.  See the GNU General Public License
 
50
        for more details.
 
51
      </para>
 
52
 
 
53
      <para>
 
54
        You should have received a copy of the GNU General Public
 
55
        License along with this program; If not, see
 
56
        <ulink url="http://www.gnu.org/licenses/"/>.
 
57
      </para>
 
58
    </legalnotice>
49
59
  </refentryinfo>
50
 
  
 
60
 
51
61
  <refmeta>
52
62
    <refentrytitle>&CONFNAME;</refentrytitle>
53
63
    <manvolnum>5</manvolnum>
59
69
      Configuration file for the Mandos server
60
70
    </refpurpose>
61
71
  </refnamediv>
62
 
  
 
72
 
63
73
  <refsynopsisdiv>
64
 
    <synopsis>&CONFPATH;</synopsis>
 
74
    <synopsis>
 
75
      &CONFPATH;
 
76
    </synopsis>
65
77
  </refsynopsisdiv>
66
 
  
 
78
 
67
79
  <refsect1 id="description">
68
80
    <title>DESCRIPTION</title>
69
81
    <para>
81
93
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
82
94
      to provide comments.
83
95
    </para>
84
 
    
 
96
 
85
97
  </refsect1>
86
98
  <refsect1>
87
99
    <title>OPTIONS</title>
88
100
    
89
101
    <variablelist>
90
102
      <varlistentry>
91
 
        <term><option>interface<literal> = </literal><replaceable
92
 
        >NAME</replaceable></option></term>
 
103
        <term><varname>interface</varname></term>
93
104
        <listitem>
 
105
          <synopsis><literal>interface = </literal><replaceable
 
106
          >NAME</replaceable>
 
107
          </synopsis>
94
108
          <xi:include href="mandos-options.xml" xpointer="interface"/>
95
109
        </listitem>
96
110
      </varlistentry>
97
 
      
 
111
 
98
112
      <varlistentry>
99
 
        <term><option>address<literal> = </literal><replaceable
100
 
          >ADDRESS</replaceable></option></term>
 
113
        <term><varname>address</varname></term>
101
114
        <listitem>
 
115
          <synopsis><literal>address = </literal><replaceable
 
116
          >ADDRESS</replaceable>
 
117
          </synopsis>
102
118
          <xi:include href="mandos-options.xml" xpointer="address"/>
103
119
        </listitem>
104
120
      </varlistentry>
105
 
      
 
121
 
106
122
      <varlistentry>
107
 
        <term><option>port<literal> = </literal><replaceable
108
 
        >NUMBER</replaceable></option></term>
 
123
        <term><varname>port</varname></term>
109
124
        <listitem>
 
125
          <synopsis><literal>port = </literal><replaceable
 
126
          >NUMBER</replaceable>
 
127
          </synopsis>
110
128
          <xi:include href="mandos-options.xml" xpointer="port"/>
111
129
        </listitem>
112
130
      </varlistentry>
113
 
      
 
131
 
114
132
      <varlistentry>
115
 
        <term><option>debug<literal> = </literal>{ <literal
 
133
        <term><varname>debug</varname></term>
 
134
        <listitem>
 
135
          <synopsis><literal>debug = </literal>{ <literal
116
136
          >1</literal> | <literal>yes</literal> | <literal
117
137
          >true</literal> | <literal>on</literal> | <literal
118
138
          >0</literal> | <literal>no</literal> | <literal
119
 
          >false</literal> | <literal>off</literal> }</option></term>
120
 
        <listitem>
 
139
          >false</literal> | <literal>off</literal> }
 
140
          </synopsis>
121
141
          <xi:include href="mandos-options.xml" xpointer="debug"/>
122
142
        </listitem>
123
143
      </varlistentry>
124
 
      
 
144
 
125
145
      <varlistentry>
126
 
        <term><option>priority<literal> = </literal><replaceable
127
 
        >STRING</replaceable></option></term>
 
146
        <term><varname>priority</varname></term>
128
147
        <listitem>
 
148
          <synopsis><literal>priority = </literal><replaceable
 
149
          >STRING</replaceable>
 
150
          </synopsis>
129
151
          <xi:include href="mandos-options.xml" xpointer="priority"/>
130
152
        </listitem>
131
153
      </varlistentry>
132
 
      
 
154
 
133
155
      <varlistentry>
134
 
        <term><option>servicename<literal> = </literal
135
 
        ><replaceable>NAME</replaceable></option></term>
 
156
        <term><varname>servicename</varname></term>
136
157
        <listitem>
 
158
          <synopsis><literal>servicename = </literal><replaceable
 
159
          >NAME</replaceable>
 
160
          </synopsis>
137
161
          <xi:include href="mandos-options.xml"
138
162
                      xpointer="servicename"/>
139
163
        </listitem>
140
164
      </varlistentry>
141
165
      
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
166
    </variablelist>
192
167
  </refsect1>
193
168
  
203
178
    <para>
204
179
      The <literal>[DEFAULT]</literal> is necessary because the Python
205
180
      built-in module <systemitem class="library">ConfigParser</systemitem>
206
 
      requires it.
 
181
      requres it.
207
182
    </para>
208
 
    <xi:include href="bugs.xml"/>
209
183
  </refsect1>
210
184
  
211
185
  <refsect1 id="example">
226
200
[DEFAULT]
227
201
# A configuration example
228
202
interface = eth0
229
 
address = fe80::aede:48ff:fe71:f6f2
 
203
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
230
204
port = 1025
231
 
debug = True
232
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
 
205
debug = true
 
206
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
233
207
servicename = Daena
234
 
use_dbus = False
235
 
use_ipv6 = True
236
 
restore = True
237
 
statedir = /var/lib/mandos
238
208
      </programlisting>
239
209
    </informalexample>
240
210
  </refsect1>
242
212
  <refsect1 id="see_also">
243
213
    <title>SEE ALSO</title>
244
214
    <para>
245
 
      <citerefentry><refentrytitle>intro</refentrytitle>
246
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
247
 
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
248
 
      ><manvolnum>3</manvolnum></citerefentry>,
249
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
250
 
      <manvolnum>8</manvolnum></citerefentry>,
251
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
252
 
      <manvolnum>5</manvolnum></citerefentry>
 
215
      <citerefentry>
 
216
        <refentrytitle>mandos</refentrytitle>
 
217
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
218
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
219
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
220
        <refentrytitle>gnutls_priority_init</refentrytitle>
 
221
        <manvolnum>3</manvolnum></citerefentry>
253
222
    </para>
254
 
    
 
223
 
255
224
    <variablelist>
256
225
      <varlistentry>
257
226
        <term>
277
246
              <para>
278
247
                The clients use IPv6 link-local addresses, which are
279
248
                immediately usable since a link-local addresses is
280
 
                automatically assigned to a network interface when it
 
249
                automatically assigned to a network interfaces when it
281
250
                is brought up.
282
251
              </para>
283
252
            </listitem>
299
268
    </variablelist>
300
269
  </refsect1>
301
270
</refentry>
302
 
<!-- Local Variables: -->
303
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
304
 
<!-- time-stamp-end: "[\"']>" -->
305
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
306
 
<!-- End: -->