]> gitweb.michael.orlitzky.com - mailbox-count.git/blob - doc/mailbox-countrc.example
mailbox-count.cabal: update to v0.0.6.
[mailbox-count.git] / doc / mailbox-countrc.example
1 #
2 # Sample configuration file for mailbox-count.
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 # Produce a detailed report listing all mailboxes by domain.
13 #
14 # Default: false
15 #
16 # detail = true
17
18
19 # SQL query used to produce the detail report. This should return the
20 # set of all (domain, username) pairs. See the default value for an
21 # example.
22 #
23 # Default: "SELECT domain,username FROM mailbox ORDER BY domain;"
24 #
25 # detail_query = "SELECT domain,username FROM mailbox LIMIT 1000;"
26
27
28 # Hostname where the database is located (Postgres-only).
29 #
30 # Default: None, a UNIX domain socket connection is attempted (Postgres only)
31 #
32 # host = "localhost"
33
34
35 # Password used to connect to the database (Postgres-only).
36 #
37 # Default: None (assumes passwordless authentication)
38 #
39 # password = "hunter2"
40
41
42 # Port number used to connect to the database (Postgres-only).
43 #
44 # Default: None, a UNIX domain socket connection is attempted (Postgres only)
45 #
46 # port = 5432
47
48
49 # SQL query used to produce the summary report. This should return
50 # (domain, user count) pairs. See the default value for an
51 # example.
52 #
53 # Default: "SELECT domain,COUNT(username) FROM mailbox GROUP BY domain ORDER BY domain;"
54 #
55 # summary_query = "SELECT domain,COUNT(username) as cnt GROUP BY domain ORDER by cnt;"
56
57
58 # Username used to connect to the database (Postgres-only).
59 #
60 # Default: The current user
61 #
62 # username = "postgres"