commit e662375651ff307f41601bff97e0fda0971692d9
from: mischa <mischa@rx.high5.nl>
date: Sun Sep 04 20:51:06 2022 UTC

add comments in conf.php

commit - 36ef6f7c649a95fabb539b42be78340e9c7e50e9
commit + e662375651ff307f41601bff97e0fda0971692d9
blob - 5ecfee5f9364d5583f8e55703b2f93747d4207bd
blob + 45c60f897ee483706c2e950959fc499343d81c95
--- conf.php-sample
+++ conf.php-sample
@@ -1,27 +1,51 @@
 <?php
+//
+// OpenSMTPD Admin
+// by Mischa Peters <mischa at high5 dot nl>
+// Copyright (c) 2022 High5!
+// License Info: LICENSE.TXT
+//
+// File: conf.php
+//
+// PHP debugging, disable with 'false
+//
 define('DEBUG', 'true');
 
+// SQL configuration, done through PDO
+// https://www.php.net/manual/en/pdo.drivers.php
 define('DB_TYPE', 'mysql');
 define('DB_HOST', '');
 define('DB_USER', '');
 define('DB_PASS', '');
 define('DB_NAME', '');
 
+// Define default maximum number of aliases and mailboxes for a domain
 define('ALIASES', '10');
 define('MAILBOXES', '10');
 
+// Expose virtual mail construct 'vmail' to admins.
 define('ALIAS_CONTROL', 'NO');
+
+// Enable VIRTUAL_VACATION with 'YES"
 define('VACATION', 'NO');
 
+// Disable activity logging with 'NO"
+define('LOGGING', 'YES');
+
+// Admin email for logging
 define('ADMIN_EMAIL', 'postmaster@example.tld');
 
+// Default language file to use
 define('DEFAULT_LANGUAGE', 'en');
+
+// Number of records to show on each page
 define('PAGE_SIZE', '25');
-define('LOGGING', 'YES');
 
+// Enable header text
 define('SHOW_HEADER', 'NO');
 define('HEADER_TEXT', ':: OpenSMTPD Admin ::');
 
+// Enable footer text
 define('SHOW_FOOTER', 'YES');
 define('FOOTER_TEXT', 'Return to OpenSMTPD!');
 define('FOOTER_LINK', 'http://git.high5.nl/opensmtpdadmin');