/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: 2014-10-05 19:46:11 UTC
  • mto: (237.7.304 trunk)
  • mto: This revision was merged to the branch mainline in revision 323.
  • Revision ID: teddy@recompile.se-20141005194611-stgt883m335wy4jl
When building Debian package, prefer libgnutls28 to libgnutls26.

This is part of the Debian "gnutls28" transition.

* debian/control (Build-Depends): Change "libgnutls-dev" to
                                  "libgnutls28-dev | gnutls-dev".

Show diffs side-by-side

added added

removed removed

Lines of Context:
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.
 
47
  </para>
 
48
  
 
49
  <para id="priority_compat">
 
50
    GnuTLS priority string for the <acronym>TLS</acronym> handshake.
 
51
    The default is <quote><literal
 
52
    >SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:</literal>
 
53
    <literal>+SIGN-RSA-RMD160</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.
42
60
  </para>
43
61
  
44
62
  <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.
 
63
    GnuTLS priority string for the <acronym>TLS</acronym> handshake.
 
64
    The default is <quote><literal
 
65
    >SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.  See
 
66
    <citerefentry><refentrytitle >gnutls_priority_init</refentrytitle>
 
67
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
 
68
    <emphasis>Warning</emphasis>: changing this may make the
 
69
    <acronym>TLS</acronym> handshake fail, making server-client
 
70
    communication impossible.
52
71
  </para>
53
72
  
54
73
  <para id="servicename">
55
74
    Zeroconf service name.  The default is
56
75
    <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
 
76
    changed if for some reason is would be necessary to run more than
 
77
    one server on the same <emphasis>host</emphasis>.  This would not
59
78
    normally be useful.  If there are name collisions on the same
60
79
    <emphasis>network</emphasis>, the newer server will automatically
61
80
    rename itself to <quote><literal>Mandos #2</literal></quote>, and
62
81
    so on; therefore, this option is not needed in that case.
63
82
  </para>
64
83
  
 
84
  <para id="dbus">
 
85
    This option controls whether the server will provide a D-Bus
 
86
    system bus interface.  The default is to provide such an
 
87
    interface.
 
88
  </para>
 
89
  
 
90
  <para id="ipv6">
 
91
    This option controls whether the server will use IPv6 sockets and
 
92
    addresses.  The default is to use IPv6.  This option should
 
93
    <emphasis>never</emphasis> normally be turned off, <emphasis>even in
 
94
    IPv4-only environments</emphasis>.  This is because <citerefentry>
 
95
    <refentrytitle>mandos-client</refentrytitle>
 
96
    <manvolnum>8mandos</manvolnum></citerefentry> will normally use
 
97
    IPv6 link-local addresses, and will not be able to find or connect
 
98
    to the server if this option is turned off.  <emphasis>Only
 
99
    advanced users should consider changing this option</emphasis>.
 
100
  </para>
 
101
  
 
102
  <para id="restore">
 
103
    This option controls whether the server will restore its state
 
104
    from the last time it ran.  Default is to restore last state.
 
105
  </para>
 
106
  
 
107
  <para id="statedir">
 
108
    Directory to save (and restore) state in.  Default is
 
109
    <quote><filename
 
110
    class="directory">/var/lib/mandos</filename></quote>.
 
111
  </para>
 
112
  
 
113
  <para id="socket">
 
114
    If this option is used, the server will not create a new network
 
115
    socket, but will instead use the supplied file descriptor.  By
 
116
    default, the server will create a new network socket.
 
117
  </para>
 
118
  
 
119
  <para id="foreground">
 
120
    This option will make the server run in the foreground and not
 
121
    write a PID file.  The default is to <emphasis>not</emphasis> run
 
122
    in the foreground, except in <option>debug</option> mode, which
 
123
    implies this option.
 
124
  </para>
 
125
  
 
126
  <para id="zeroconf">
 
127
    This option controls whether the server will announce its
 
128
    existence using Zeroconf.  Default is to use Zeroconf.  If
 
129
    Zeroconf is not used, a <option>port</option> number or a
 
130
    <option>socket</option> is required.
 
131
  </para>
 
132
  
65
133
</section>