Update release date.
[aox:aox.git] / doc / aoxsuper.conf.man
1 .\" Copyright 2009 The Archiveopteryx Developers <info@aox.org>
2 .TH aoxsuper.conf 5 2009-07-13 aox.org "Archiveopteryx Documentation"
3 .SH NAME
4 aoxsuper.conf - configuration file for Archiveopteryx.
5 .SH SYNOPSIS
6 .B $CONFIGDIR/aoxsuper.conf
7 .br
8 .SH DESCRIPTION
9 .nh
10 .PP
11 The
12 .I aoxsuper.conf
13 file contains a few configuration settings for Archiveopteryx. It is read by
14 .BR aox (8)
15 at startup. Syntax errors, unknown variables,
16 and other errors are logged on stderr.
17 .PP
18 .I aoxsuper.conf
19 is usually created at installation time, by running
20 .BR $LIBDIR/installer .
21 .PP
22 There is only one required variable, namely
23 .IR db-owner-password .
24 .SH "SECURITY NOTE"
25 Anyone who can read
26 .I aoxsuper.conf
27 can see the database owner password, and use this password to read all
28 mail, or even to damage or destroy the mail database.
29 .PP
30 By default,
31 .I aoxsuper.conf
32 is readable only by root.
33 .SH SETTINGS
34 .PP
35 The format is as for
36 .BR archiveopteryx.conf (5):
37 .IP
38 name = value # comment
39 .PP
40 All variables in
41 .BR archiveopteryx.conf (5)
42 may be overridden in
43 .IR aoxsuper.conf ,
44 if it is necessary that
45 .BR aox (8)
46 sees a different value than the servers see.
47 .SS "Database Access"
48 .IP db-owner
49 The name of the Postgres user that owns the database and is used to
50 perform privileged operations (such as deleting mail). The default is
51 .IR $DBOWNER .
52 .IP db-owner-password
53 The database password used for the
54 .IR db-owner .
55 The default is an empty string.
56 .IP
57 Unless a password is specified, the Archiveopteryx installer sets up a
58 randomly-chosen password and writes it to the configuration file.
59 .SH AUTHOR
60 The Archiveopteryx Developers, info@aox.org.
61 .SH VERSION
62 This man page covers Archiveopteryx version 3.1.2, released 2009-07-13,
63 http://www.archiveopteryx.org/3.1.2
64 .SH SEE ALSO
65 .BR archiveopteryx.conf (5),
66 .BR archiveopteryx (8),
67 .BR deliver (8),
68 .BR logd (8),
69 .BR tlsproxy (8),
70 http://www.archiveopteryx.org