/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-clients.conf.xml

* initramfs-tools-hook: Add missing terminating `" when setting
                        mandos_user and mandos_group.

* mandos.conf.xml (SEE ALSO): Improved grammar.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.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">
5
4
<!ENTITY CONFNAME "mandos-clients.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-09-04">
 
6
<!ENTITY TIMESTAMP "2009-02-15">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
    <productname>Mandos</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
16
    <productnumber>&version;</productnumber>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
 
36
      <year>2009</year>
35
37
      <holder>Teddy Hogeborn</holder>
36
38
      <holder>Björn Påhlsson</holder>
37
39
    </copyright>
38
40
    <xi:include href="legalnotice.xml"/>
39
41
  </refentryinfo>
40
 
 
 
42
  
41
43
  <refmeta>
42
44
    <refentrytitle>&CONFNAME;</refentrytitle>
43
45
    <manvolnum>5</manvolnum>
49
51
      Configuration file for the Mandos server
50
52
    </refpurpose>
51
53
  </refnamediv>
52
 
 
 
54
  
53
55
  <refsynopsisdiv>
54
56
    <synopsis>&CONFPATH;</synopsis>
55
57
  </refsynopsisdiv>
56
 
 
 
58
  
57
59
  <refsect1 id="description">
58
60
    <title>DESCRIPTION</title>
59
61
    <para>
95
97
    <para>
96
98
      Unknown options are ignored.  The used options are as follows:
97
99
    </para>
98
 
 
 
100
    
99
101
    <variablelist>
100
 
 
 
102
      
101
103
      <varlistentry>
102
104
        <term><option>timeout<literal> = </literal><replaceable
103
105
        >TIME</replaceable></option></term>
126
128
          </para>
127
129
        </listitem>
128
130
      </varlistentry>
129
 
 
 
131
      
130
132
      <varlistentry>
131
133
        <term><option>interval<literal> = </literal><replaceable
132
134
        >TIME</replaceable></option></term>
149
151
          </para>
150
152
        </listitem>
151
153
      </varlistentry>
152
 
 
 
154
      
153
155
      <varlistentry>
154
156
        <term><option>checker<literal> = </literal><replaceable
155
157
        >COMMAND</replaceable></option></term>
168
170
            <varname>PATH</varname> will be searched.  The default
169
171
            value for the checker command is <quote><literal
170
172
            ><command>fping</command> <option>-q</option> <option
171
 
            >--</option> %(host)s</literal></quote>.
 
173
            >--</option> %%(host)s</literal></quote>.
172
174
          </para>
173
175
          <para>
174
176
            In addition to normal start time expansion, this option
223
225
          </para>
224
226
        </listitem>
225
227
      </varlistentry>
226
 
 
 
228
      
227
229
      <varlistentry>
228
230
        <term><option>secfile<literal> = </literal><replaceable
229
231
        >FILENAME</replaceable></option></term>
239
241
            should <emphasis>not</emphasis> be base64-encoded, but
240
242
            will be sent to clients verbatim.
241
243
          </para>
 
244
          <para>
 
245
            File names of the form <filename>~user/foo/bar</filename>
 
246
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
247
            are supported.
 
248
          </para>
242
249
        </listitem>
243
250
      </varlistentry>
244
 
 
 
251
      
245
252
      <varlistentry>
246
253
        <term><option><literal>host = </literal><replaceable
247
254
        >STRING</replaceable></option></term>
250
257
            This option is <emphasis>optional</emphasis>, but highly
251
258
            <emphasis>recommended</emphasis> unless the
252
259
            <option>checker</option> option is modified to a
253
 
            non-standard value without <quote>%(host)s</quote> in it.
 
260
            non-standard value without <quote>%%(host)s</quote> in it.
254
261
          </para>
255
262
          <para>
256
263
            Host name for this client.  This is not used by the server
313
320
        mode is needed to expose an error of this kind.
314
321
      </para>
315
322
    </refsect2>
316
 
 
 
323
    
317
324
  </refsect1>
318
325
  
319
326
  <refsect1 id="files">
344
351
[DEFAULT]
345
352
timeout = 1h
346
353
interval = 5m
347
 
checker = fping -q -- %(host)s
 
354
checker = fping -q -- %%(host)s
348
355
 
349
356
# Client "foo"
350
357
[foo]
373
380
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
374
381
secfile = /etc/mandos/bar-secret
375
382
timeout = 15m
376
 
 
377
383
      </programlisting>
378
384
    </informalexample>
379
385
  </refsect1>