/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

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY CONFNAME "mandos-clients.conf">
5
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2009-01-04">
 
6
<!ENTITY TIMESTAMP "2009-12-09">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
63
63
      ><refentrytitle>mandos</refentrytitle>
64
64
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
65
      The file needs to list all clients that should be able to use
66
 
      the service.  All clients listed will be regarded as valid, even
67
 
      if a client was declared invalid in a previous run of the
68
 
      server.
 
66
      the service.  All clients listed will be regarded as enabled,
 
67
      even if a client was disabled in a previous run of the server.
69
68
    </para>
70
69
    <para>
71
70
      The format starts with a <literal>[<replaceable>section
108
107
            This option is <emphasis>optional</emphasis>.
109
108
          </para>
110
109
          <para>
111
 
            The timeout is how long the server will wait for a
112
 
            successful checker run until a client is considered
113
 
            invalid - that is, ineligible to get the data this server
114
 
            holds.  By default Mandos will use 1 hour.
 
110
            The timeout is how long the server will wait (for either a
 
111
            successful checker run or a client receiving its secret)
 
112
            until a client is disabled and not allowed to get the data
 
113
            this server holds.  By default Mandos will use 1 hour.
115
114
          </para>
116
115
          <para>
117
116
            The <replaceable>TIME</replaceable> is specified as a
142
141
            not be started if an old one is still running.  The server
143
142
            will wait for a checker to complete until the above
144
143
            <quote><varname>timeout</varname></quote> occurs, at which
145
 
            time the client will be marked invalid, and any running
146
 
            checker killed.  The default interval is 5 minutes.
 
144
            time the client will be disabled, and any running checker
 
145
            killed.  The default interval is 5 minutes.
147
146
          </para>
148
147
          <para>
149
148
            The format of <replaceable>TIME</replaceable> is the same
170
169
            <varname>PATH</varname> will be searched.  The default
171
170
            value for the checker command is <quote><literal
172
171
            ><command>fping</command> <option>-q</option> <option
173
 
            >--</option> %(host)s</literal></quote>.
 
172
            >--</option> %%(host)s</literal></quote>.
174
173
          </para>
175
174
          <para>
176
175
            In addition to normal start time expansion, this option
257
256
            This option is <emphasis>optional</emphasis>, but highly
258
257
            <emphasis>recommended</emphasis> unless the
259
258
            <option>checker</option> option is modified to a
260
 
            non-standard value without <quote>%(host)s</quote> in it.
 
259
            non-standard value without <quote>%%(host)s</quote> in it.
261
260
          </para>
262
261
          <para>
263
262
            Host name for this client.  This is not used by the server
351
350
[DEFAULT]
352
351
timeout = 1h
353
352
interval = 5m
354
 
checker = fping -q -- %(host)s
 
353
checker = fping -q -- %%(host)s
355
354
 
356
355
# Client "foo"
357
356
[foo]