/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: Björn Påhlsson
  • Date: 2008-08-25 07:53:43 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 107.
  • Revision ID: belorn@braxen-20080825075343-a7gsy6mkam9t1up9
added configfile as a optional argument to plugin-runner

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).
10
8
-->
11
9
 
12
10
<section>
14
12
  
15
13
  <para id="interface">
16
14
    If this is specified, the server will only announce the service
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.
 
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.
22
20
  </para>
23
21
  
24
22
  <para id="address">
26
24
    specified IPv6 address.  If a link-local address is specified, an
27
25
    interface should be set, since a link-local address is only valid
28
26
    on a single interface.  By default, the server will listen to all
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.)
 
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.
35
30
  </para>
36
31
  
37
32
  <para id="port">
42
37
  
43
38
  <para id="debug">
44
39
    If the server is run in debug mode, it will run in the foreground
45
 
    and print a lot of debugging information.  The default is to
46
 
    <emphasis>not</emphasis> run in debug mode.
 
40
    and print a lot of debugging information.  The default is
 
41
    <emphasis>not</emphasis> to run in debug mode.
47
42
  </para>
48
43
  
49
44
  <para id="priority">
50
 
    GnuTLS priority string for the <acronym>TLS</acronym> handshake.
51
 
    The default is <quote><literal
52
 
    >SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA</literal>
53
 
    <literal>:+SIGN-DSA-SHA256</literal></quote>.
54
 
    See <citerefentry><refentrytitle
55
 
    >gnutls_priority_init</refentrytitle>
56
 
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
57
 
    <emphasis>Warning</emphasis>: changing this may make the
58
 
    <acronym>TLS</acronym> handshake fail, making server-client
59
 
    communication impossible.  Changing this option may also make the
60
 
    network traffic decryptable by an attacker.
 
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.
61
52
  </para>
62
53
  
63
54
  <para id="servicename">
64
55
    Zeroconf service name.  The default is
65
56
    <quote><literal>Mandos</literal></quote>.  This only needs to be
66
 
    changed if for some reason is would be necessary to run more than
67
 
    one server on the same <emphasis>host</emphasis>.  This would not
 
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
68
59
    normally be useful.  If there are name collisions on the same
69
60
    <emphasis>network</emphasis>, the newer server will automatically
70
61
    rename itself to <quote><literal>Mandos #2</literal></quote>, and
71
62
    so on; therefore, this option is not needed in that case.
72
63
  </para>
73
64
  
74
 
  <para id="dbus">
75
 
    This option controls whether the server will provide a D-Bus
76
 
    system bus interface.  The default is to provide such an
77
 
    interface.
78
 
  </para>
79
 
  
80
 
  <para id="ipv6">
81
 
    This option controls whether the server will use IPv6 sockets and
82
 
    addresses.  The default is to use IPv6.  This option should
83
 
    <emphasis>never</emphasis> normally be turned off, <emphasis>even in
84
 
    IPv4-only environments</emphasis>.  This is because <citerefentry>
85
 
    <refentrytitle>mandos-client</refentrytitle>
86
 
    <manvolnum>8mandos</manvolnum></citerefentry> will normally use
87
 
    IPv6 link-local addresses, and will not be able to find or connect
88
 
    to the server if this option is turned off.  <emphasis>Only
89
 
    advanced users should consider changing this option</emphasis>.
90
 
  </para>
91
 
  
92
 
  <para id="restore">
93
 
    This option controls whether the server will restore its state
94
 
    from the last time it ran.  Default is to restore last state.
95
 
  </para>
96
 
  
97
 
  <para id="statedir">
98
 
    Directory to save (and restore) state in.  Default is
99
 
    <quote><filename
100
 
    class="directory">/var/lib/mandos</filename></quote>.
101
 
  </para>
102
 
  
103
 
  <para id="socket">
104
 
    If this option is used, the server will not create a new network
105
 
    socket, but will instead use the supplied file descriptor.  By
106
 
    default, the server will create a new network socket.
107
 
  </para>
108
 
  
109
 
  <para id="foreground">
110
 
    This option will make the server run in the foreground and not
111
 
    write a PID file.  The default is to <emphasis>not</emphasis> run
112
 
    in the foreground, except in <option>debug</option> mode, which
113
 
    implies this option.
114
 
  </para>
115
 
  
116
 
  <para id="zeroconf">
117
 
    This option controls whether the server will announce its
118
 
    existence using Zeroconf.  Default is to use Zeroconf.  If
119
 
    Zeroconf is not used, a <option>port</option> number or a
120
 
    <option>socket</option> is required.
121
 
  </para>
122
 
  
123
65
</section>