/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-options.xml

  • Committer: Teddy Hogeborn
  • Date: 2012-11-14 21:03:24 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 303.
  • Revision ID: teddy@recompile.se-20121114210324-n7m7k0ki2ncmje3a
* mandos-ctl (string_to_delta): Try to parse RFC 3339 duration before
                                anything else.  This also minimizes
                                the changes from the last release.
  (PGPEngine): Use straight subprocess.Popen() to call "gpg".
* mandos-monitor (UserInterface.run): Fix grammar.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-options.xml
5
5
<!--
6
6
This file is used by both mandos(8) and mandos.conf(5), since these
7
7
options can be used both on the command line and in the config file.
 
8
 
 
9
It is also used for some texts by mandos-client(8mandos).
8
10
-->
9
11
 
10
12
<section>
12
14
  
13
15
  <para id="interface">
14
16
    If this is specified, the server will only announce the service
15
 
    and listen to requests on network interface
16
 
    <replaceable>IF</replaceable>.  Default is to use all available
17
 
    interfaces.  <emphasis>Note:</emphasis> a failure to bind to the
18
 
    specified interface is not considered critical, and the server
19
 
    does not exit, but will instead continue starting normally.
 
17
    and listen to requests on the specified network interface.
 
18
    Default is to use all available interfaces.  <emphasis
 
19
    >Note:</emphasis> a failure to bind to the specified
 
20
    interface is not considered critical, and the server will not
 
21
    exit, but instead continue normally.
20
22
  </para>
21
23
  
22
24
  <para id="address">
24
26
    specified IPv6 address.  If a link-local address is specified, an
25
27
    interface should be set, since a link-local address is only valid
26
28
    on a single interface.  By default, the server will listen to all
27
 
    available addresses.  If set, this must be an IPv6 address; an
28
 
    IPv4 address can only be specified using the <quote><systemitem
29
 
    class="ipaddress">::FFFF:192.0.2.3</systemitem ></quote> format.
 
29
    available addresses.  If set, this must normally be an IPv6
 
30
    address; an IPv4 address can only be specified using IPv4-mapped
 
31
    IPv6 address syntax: <quote><systemitem class="ipaddress"
 
32
    >::FFFF:192.0.2.3</systemitem ></quote>.  (Only if IPv6 usage is
 
33
    <emphasis>disabled</emphasis> (see below) must this be an IPv4
 
34
    address.)
30
35
  </para>
31
36
  
32
37
  <para id="port">
37
42
  
38
43
  <para id="debug">
39
44
    If the server is run in debug mode, it will run in the foreground
40
 
    and print a lot of debugging information.  The default is
41
 
    <emphasis>not</emphasis> to run in debug mode.
 
45
    and print a lot of debugging information.  The default is to
 
46
    <emphasis>not</emphasis> run in debug mode.
42
47
  </para>
43
48
  
44
49
  <para id="priority">
45
 
    GnuTLS priority string for the TLS handshake with the clients.
46
 
    The default is
47
 
    <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
48
 
    See <citerefentry><refentrytitle>gnutls_priority_init
49
 
    </refentrytitle><manvolnum>3</manvolnum></citerefentry> for the
50
 
    syntax.  <emphasis>Warning</emphasis>: changing this may make the
51
 
    TLS handshake fail, making communication with clients impossible.
 
50
    GnuTLS priority string for the <acronym>TLS</acronym> handshake.
 
51
    The default is <quote><literal
 
52
    >SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.  See
 
53
    <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle>
 
54
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
 
55
    <emphasis>Warning</emphasis>: changing this may make the
 
56
    <acronym>TLS</acronym> handshake fail, making server-client
 
57
    communication impossible.
52
58
  </para>
53
59
  
54
60
  <para id="servicename">
55
61
    Zeroconf service name.  The default is
56
62
    <quote><literal>Mandos</literal></quote>.  This only needs to be
57
 
    changed this if it, for some reason, is necessary to run more than
58
 
    one server on the same <emphasis>host</emphasis>, which would not
 
63
    changed if for some reason is would be necessary to run more than
 
64
    one server on the same <emphasis>host</emphasis>.  This would not
59
65
    normally be useful.  If there are name collisions on the same
60
66
    <emphasis>network</emphasis>, the newer server will automatically
61
67
    rename itself to <quote><literal>Mandos #2</literal></quote>, and
62
68
    so on; therefore, this option is not needed in that case.
63
69
  </para>
64
70
  
 
71
  <para id="dbus">
 
72
    This option controls whether the server will provide a D-Bus
 
73
    system bus interface.  The default is to provide such an
 
74
    interface.
 
75
  </para>
 
76
  
 
77
  <para id="ipv6">
 
78
    This option controls whether the server will use IPv6 sockets and
 
79
    addresses.  The default is to use IPv6.  This option should
 
80
    <emphasis>never</emphasis> normally be turned off, <emphasis>even in
 
81
    IPv4-only environments</emphasis>.  This is because <citerefentry>
 
82
    <refentrytitle>mandos-client</refentrytitle>
 
83
    <manvolnum>8mandos</manvolnum></citerefentry> will normally use
 
84
    IPv6 link-local addresses, and will not be able to find or connect
 
85
    to the server if this option is turned off.  <emphasis>Only
 
86
    advanced users should consider changing this option</emphasis>.
 
87
  </para>
 
88
  
 
89
  <para id="restore">
 
90
    This option controls whether the server will restore its state
 
91
    from the last time it ran.  Default is to restore last state.
 
92
  </para>
 
93
  
 
94
  <para id="statedir">
 
95
    Directory to save (and restore) state in.  Default is
 
96
    <quote><filename
 
97
    class="directory">/var/lib/mandos</filename></quote>.
 
98
  </para>
 
99
  
 
100
  <para id="socket">
 
101
    If this option is used, the server will not create a new network
 
102
    socket, but will instead use the supplied file descriptor.  By
 
103
    default, the server will create a new network socket.
 
104
  </para>
 
105
  
 
106
  <para id="foreground">
 
107
    This option will make the server run in the foreground and not
 
108
    write a PID file.  The default is to <emphasis>not</emphasis> run
 
109
    in the foreground, except in <option>debug</option> mode, which
 
110
    implies this option.
 
111
  </para>
 
112
  
65
113
</section>