6f118698db1ca1514cbcca58f477ed73c4f24c69
[list-remote-forwards.git] / doc / list-remote-forwardsrc.example
1 #
2 # Sample configuration file for list-remote-forwards.
3 #
4
5 # The name of the database (or file, if SQLite) to which we should connect.
6 #
7 # Default: The name of the current user (Postgres only)
8 #
9 # database = "postfixadmin"
10
11
12 # SQL query used to produce a list of local domains. This should return
13 # the set of all domains (i.e one column) that are local to the
14 # server. See the default value for an example.
15 #
16 # Default: "SELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY domain;"
17 #
18 # domain_query = "SELECT DISTINCT domain FROM alias;"
19
20
21 # The name of a mail exchange, the forwards of whose domains we should
22 # ignore. For example, if one mail exchanger, mx1.example.com, has
23 # strict spam filtering, it may be acceptable to have remote forwarding
24 # for domains that have mx1.example.com as their mail exchanger (MX
25 # record). In that case, you might want to exclude those domains from
26 # the report, by naming mx1.example.com here.
27 #
28 # Default: [] (empty)
29 #
30 # exclude_mx = ["mx1.example.com"]
31
32
33 # SQL query used to produce a list of all forwards on the mail
34 # system. This query should return the set of all (address, goto)
35 # triples, where "goto" is the destination address; i.e. to where
36 # the "address" forwards. The "goto" field may contain more
37 # than one email address, separated by commas.
38 #
39 # Default: "SELECT address,goto FROM alias ORDER BY address;"
40 #
41 # forward_query = "SELECT address,alias FROM aliases;"
42
43
44
45 # Hostname where the database is located (Postgres-only).
46 #
47 # Default: None, a UNIX domain socket connection is attempted (Postgres only)
48 #
49 # host = "localhost"
50
51
52 # Password used to connect to the database (Postgres-only).
53 #
54 # Default: None (assumes passwordless authentication)
55 #
56 # password = "hunter2"
57
58
59 # Port number used to connect to the database (Postgres-only).
60 #
61 # Default: None, a UNIX domain socket connection is attempted (Postgres only)
62 #
63 # port = 5432
64
65
66
67 # Username used to connect to the database (Postgres-only).
68 #
69 # Default: The current user
70 #
71 # username = "postgres"