Add m_sql_log

1 files changed, 20 insertions, 0 deletions

diff --git a/data/modules.example.conf b/data/modules.example.conf
index 28bef2850..aaf7048b2 100644
--- a/data/modules.example.conf
+++ b/data/modules.example.conf
@@ -458,6 +458,26 @@ module { name = "help" }
 }
 
 /*
+ * m_sql_log
+ *
+ * This module adds an additional target option to log{} blocks
+ * that allows logging Service's logs to SQL. To log to SQL, add
+ * the SQL service name to log:targets prefixed by sql_log:. For
+ * example:
+ *
+ * log
+ * {
+ *     targets = "services.log sql_log:mysql/main"
+ *     ...
+ * }
+ *
+ * By default this module logs to the table `logs`, and will create
+ * it if it doesn't exist. This module does not create any indexes (keys)
+ * on the table and it is recommended you add them yourself as necessary.
+ */
+#module { name = "m_sql_log" }
+
+/*
  * m_sql_oper
  *
  * This module allows granting users services operator privileges and possibly IRC Operator