3e435603ba0d4cb9d1a07a5a5d1ec3fc22b6de96
[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 exchanger, 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 # Given as a list, it can be used to exclude more than one mail
29 # exchanger.
30 #
31 # Default: [] (empty)
32 #
33 # exclude_mx = ["mx1.example.com"]
34
35
36 # SQL query used to produce a list of all forwards on the mail
37 # system. This query should return the set of all (address, goto)
38 # triples, where "goto" is the destination address; i.e. to where
39 # the "address" forwards. The "goto" field may contain more
40 # than one email address, separated by commas.
41 #
42 # Default: "SELECT address,goto FROM alias ORDER BY address;"
43 #
44 # forward_query = "SELECT address,alias FROM aliases;"
45
46
47
48 # Hostname where the database is located (Postgres-only).
49 #
50 # Default: None, a UNIX domain socket connection is attempted (Postgres only)
51 #
52 # host = "localhost"
53
54
55 # Password used to connect to the database (Postgres-only).
56 #
57 # Default: None (assumes passwordless authentication)
58 #
59 # password = "hunter2"
60
61
62 # Port number used to connect to the database (Postgres-only).
63 #
64 # Default: None, a UNIX domain socket connection is attempted (Postgres only)
65 #
66 # port = 5432
67
68
69
70 # Username used to connect to the database (Postgres-only).
71 #
72 # Default: The current user
73 #
74 # username = "postgres"