Add an example config file.

[mailbox-count.git] / doc / mailbox-countrc.example

diff --git a/doc/mailbox-countrc.example b/doc/mailbox-countrc.example
new file mode 100644 (file)
index 0000000..8a3529d
--- /dev/null
+++ b/doc/mailbox-countrc.example
@@ -0,0 +1,44 @@
+#
+# Sample configuration file for mailbox-count.
+#
+
+# The name of the database to which we should connect.
+#
+# Default: The name of the current user (Postgres only)
+#
+# database = "postfixadmin"
+
+
+# Produce a detailed report listing all mailboxes by domain.
+#
+# Default: false
+#
+# detail = true
+
+
+# Hostname where the database is located.
+#
+# Default: None, a UNIX domain socket connection is attempted (Postgres only)
+#
+# host = "localhost"
+
+
+# Password used to connect to the database.
+#
+# Default: None (assumes passwordless authentication)
+#
+# password = "hunter2"
+
+
+# Port number used to connect to the database.
+#
+# Default: None, a UNIX domain socket connection is attempted (Postgres only)
+#
+# port = 5432
+
+
+# Username used to connect to the database.
+#
+# Default: The current user
+#
+# username = "postgres"