/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.conf.xml

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY CONFNAME "mandos.conf">
6
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
7
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
8
7
]>
9
8
 
10
 
<refentry>
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
10
  <refentryinfo>
12
11
    <title>&CONFNAME;</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
83
82
      The file &CONFPATH; is a simple configuration file for
84
83
      <citerefentry><refentrytitle>mandos</refentrytitle>
85
84
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
86
 
      startup.  The configuration file starts with
87
 
      <quote><literal>[DEFAULT]</literal></quote> on a line by itself,
88
 
      followed by any number of
89
 
      <quote><varname><replaceable>option</replaceable></varname>=<replaceable>value</replaceable></quote>
90
 
      entries, with continuations in the style of RFC 822.
91
 
      <quote><varname><replaceable>option</replaceable></varname>:
92
 
      <replaceable>value</replaceable></quote> is also accepted.  Note
93
 
      that leading whitespace is removed from values.  Lines beginning
94
 
      with <quote>#</quote> or <quote>;</quote> are ignored and may be
95
 
      used to provide comments.
96
 
    </para>
97
 
 
98
 
    <para>
99
 
      The options are:
100
 
    </para>
101
 
 
 
85
      startup.  The configuration file starts with <quote><literal
 
86
      >[DEFAULT]</literal></quote> on a line by itself, followed by
 
87
      any number of <quote><varname><replaceable>option</replaceable
 
88
      ></varname>=<replaceable>value</replaceable></quote> entries,
 
89
      with continuations in the style of RFC 822.  <quote><varname
 
90
      ><replaceable>option</replaceable></varname>: <replaceable
 
91
      >value</replaceable></quote> is also accepted.  Note that
 
92
      leading whitespace is removed from values.  Lines beginning with
 
93
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
 
94
      to provide comments.
 
95
    </para>
 
96
 
 
97
  </refsect1>
 
98
  <refsect1>
 
99
    <title>OPTIONS</title>
 
100
    
102
101
    <variablelist>
103
102
      <varlistentry>
104
 
        <term><literal><varname>interface</varname></literal></term>
105
 
        <listitem>
106
 
          <para>
107
 
            This option allows you to override the default network
108
 
            interfaces. By default mandos will not bind to any
109
 
            specific interface but instead use default avahi-server
110
 
            behaviour.
111
 
          </para>
112
 
        </listitem>
113
 
      </varlistentry>
114
 
 
115
 
      <varlistentry>
116
 
        <term><literal><varname>address</varname></literal></term>
117
 
        <listitem>
118
 
          <para>
119
 
            This option allows you to override the default network
120
 
            address. By default mandos will not bind to any
121
 
            specific address but instead use default avahi-server
122
 
            behaviour.
123
 
          </para>
124
 
        </listitem>
125
 
      </varlistentry>      
126
 
 
127
 
      <varlistentry>
128
 
        <term><literal><varname>port</varname></literal></term>
129
 
        <listitem>
130
 
          <para>
131
 
            This option allows you to override the default port to
132
 
            listen on. By default mandos will not specify any specific
133
 
            port and instead use a random port given by the OS from
134
 
            the use of INADDR_ANY.
135
 
          </para>
136
 
        </listitem>
137
 
      </varlistentry>
138
 
 
139
 
      <varlistentry>
140
 
        <term><literal><varname>debug</varname></literal></term>
141
 
        <listitem>
142
 
          <para>
143
 
            This option allows you to modify debug mode with a true/false
144
 
            boolean value. By default is debug set to <literal>false</literal>.
145
 
          </para>
146
 
        </listitem>
147
 
      </varlistentry>      
148
 
 
149
 
      <varlistentry>
150
 
        <term><literal><varname>priority</varname></literal></term>
151
 
        <listitem>
152
 
          <para>
153
 
            This option allows you to override the default gnutls
154
 
            priority that will be used in gnutls session. See
155
 
            <citerefentry><refentrytitle>gnutls_priority_init
156
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>for
157
 
            more information on gnutls priority strings.
158
 
          </para>         
159
 
        </listitem>
160
 
      </varlistentry>
161
 
 
162
 
      <varlistentry>
163
 
        <term><literal><varname>servicename</varname></literal></term>
164
 
        <listitem>
165
 
          <para>
166
 
            This option allows you to override the default Zeroconf
167
 
            service name use to announce mandos as a avahi service. By
168
 
            default mandos will use "Mandos".
169
 
          </para>
 
103
        <term><varname>interface</varname></term>
 
104
        <listitem>
 
105
          <synopsis><literal>interface = </literal><replaceable
 
106
          >IF</replaceable>
 
107
          </synopsis>
 
108
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
109
        </listitem>
 
110
      </varlistentry>
 
111
 
 
112
      <varlistentry>
 
113
        <term><varname>address</varname></term>
 
114
        <listitem>
 
115
          <synopsis><literal>address = </literal><replaceable
 
116
          >ADDRESS</replaceable>
 
117
          </synopsis>
 
118
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
119
        </listitem>
 
120
      </varlistentry>
 
121
 
 
122
      <varlistentry>
 
123
        <term><varname>port</varname></term>
 
124
        <listitem>
 
125
          <synopsis><literal>port = </literal><replaceable
 
126
          >PORT</replaceable>
 
127
          </synopsis>
 
128
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
129
        </listitem>
 
130
      </varlistentry>
 
131
 
 
132
      <varlistentry>
 
133
        <term><varname>debug</varname></term>
 
134
        <listitem>
 
135
          <synopsis><literal>debug = </literal>{ <literal
 
136
          >1</literal> | <literal>yes</literal> | <literal
 
137
          >true</literal> | <literal>on</literal> | <literal
 
138
          >0</literal> | <literal>no</literal> | <literal
 
139
          >false</literal> | <literal>off</literal> }
 
140
          </synopsis>
 
141
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
142
        </listitem>
 
143
      </varlistentry>
 
144
 
 
145
      <varlistentry>
 
146
        <term><varname>priority</varname></term>
 
147
        <listitem>
 
148
          <synopsis><literal>priority = </literal><replaceable
 
149
          >PRIORITY</replaceable>
 
150
          </synopsis>
 
151
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
152
        </listitem>
 
153
      </varlistentry>
 
154
 
 
155
      <varlistentry>
 
156
        <term><varname>servicename</varname></term>
 
157
        <listitem>
 
158
          <synopsis><literal>servicename = </literal><replaceable
 
159
          >NAME</replaceable>
 
160
          </synopsis>
 
161
          <xi:include href="mandos-options.xml"
 
162
                      xpointer="servicename"/>
170
163
        </listitem>
171
164
      </varlistentry>
172
165
      
173
166
    </variablelist>
174
167
  </refsect1>
175
 
 
176
 
  <refsect1 id="examples">
177
 
    <title>EXAMPLES</title>
178
 
    <informalexample>
179
 
      <programlisting>
180
 
        [server]
181
 
        # A configuration example
182
 
        interface = eth0 
183
 
        address = 2001:DB8:
184
 
        port = 1025 
185
 
        debug = true 
186
 
        priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
187
 
        servicename = Mandos
188
 
      </programlisting>
189
 
    </informalexample>
190
 
  </refsect1>  
191
168
  
192
169
  <refsect1 id="files">
193
170
    <title>FILES</title>
195
172
      The file described here is &CONFPATH;
196
173
    </para>
197
174
  </refsect1>
 
175
  
 
176
  <refsect1 id="bugs">
 
177
    <title>BUGS</title>
 
178
    <para>
 
179
      The <literal>[DEFAULT]</literal> is necessary because the Python
 
180
      built-in module <systemitem class="library">ConfigParser</systemitem>
 
181
      requres it.
 
182
    </para>
 
183
  </refsect1>
 
184
  
 
185
  <refsect1 id="example">
 
186
    <title>EXAMPLE</title>
 
187
    <informalexample>
 
188
      <para>
 
189
        No options are actually required:
 
190
      </para>
 
191
      <programlisting>
 
192
[DEFAULT]
 
193
      </programlisting>
 
194
    </informalexample>
 
195
    <informalexample>
 
196
      <para>
 
197
        An example using all the options:
 
198
      </para>
 
199
      <programlisting>
 
200
[DEFAULT]
 
201
# A configuration example
 
202
interface = eth0
 
203
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
 
204
port = 1025
 
205
debug = true
 
206
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
 
207
servicename = Daena
 
208
      </programlisting>
 
209
    </informalexample>
 
210
  </refsect1>
 
211
  
 
212
  <refsect1 id="see_also">
 
213
    <title>SEE ALSO</title>
 
214
    <para>
 
215
      <citerefentry>
 
216
        <refentrytitle>mandos</refentrytitle>
 
217
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
218
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
219
        <manvolnum>5</manvolnum></citerefentry>
 
220
    </para>
 
221
  </refsect1>
198
222
</refentry>