[Doc] Add comments about configuration

diff --git a/conf/common.conf b/conf/common.conf
index b6ad9192a62bf7729e07ccfd8dd1268f223471c4..ebb52bf78e9c05a7277263804fc93eb5238bb603 100644 (file)
--- a/conf/common.conf
+++ b/conf/common.conf
@@ -1,4 +1,18 @@
 # A common rspamd configuration file
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
 
 lua = "$RULESDIR/rspamd.lua"
 

diff --git a/conf/composites.conf b/conf/composites.conf
index 70021a7f024752883b205abac29dcdb2cdc8a78d..bfa0b1b47492201d980e7f95afa839678a767f58 100644 (file)
--- a/conf/composites.conf
+++ b/conf/composites.conf
@@ -1,4 +1,18 @@
 # Composites setup
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
 
 composite {
     name = "FORGED_RECIPIENTS_MAILLIST";

diff --git a/conf/metrics.conf b/conf/metrics.conf
index b61b28bc20c8fe9484f6bab3175eaa8aada6b822..4be8325c5af27ffcb1e121076aaa6475af33ec11 100644 (file)
--- a/conf/metrics.conf
+++ b/conf/metrics.conf
@@ -1,4 +1,18 @@
 # Metrics settings
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
 
 metric {
     name = "default";

diff --git a/conf/modules.d/chartable.conf b/conf/modules.d/chartable.conf
index 0f4374fbbadc85a4ef26df836863d746d9352846..24f4811d020a2ed6183de717a54587b9e745c4b8 100644 (file)
--- a/conf/modules.d/chartable.conf
+++ b/conf/modules.d/chartable.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 chartable {
     .include(try=true,priority=5) "${DBDIR}/dynamic/chartable.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/chartable.conf"

diff --git a/conf/modules.d/dkim.conf b/conf/modules.d/dkim.conf
index 189c13346f83e44d6840b46a221521aa103171b8..7a2795d59d0509d6c3c41f7e07de55d79e17c71b 100644 (file)
--- a/conf/modules.d/dkim.conf
+++ b/conf/modules.d/dkim.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 dkim {
     .include(try=true,priority=5) "${DBDIR}/dynamic/dkim.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/dkim.conf"

diff --git a/conf/modules.d/dmarc.conf b/conf/modules.d/dmarc.conf
index fad8c9bf2c71ca45cb127936eef9e8d150d02669..75d9342a90eb2b607e307b00c5761f0bff130565 100644 (file)
--- a/conf/modules.d/dmarc.conf
+++ b/conf/modules.d/dmarc.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 dmarc {
     .include(try=true,priority=5) "${DBDIR}/dynamic/dmarc.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/dmarc.conf"

diff --git a/conf/modules.d/emails.conf b/conf/modules.d/emails.conf
index 67263ec24bfad203a880e740c1f4c4fe048f7d75..8f6a163e5df250f1fcf22b23091e2f2d4b58ffc6 100644 (file)
--- a/conf/modules.d/emails.conf
+++ b/conf/modules.d/emails.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 emails {
     .include(try=true,priority=5) "${DBDIR}/dynamic/emails.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/emails.conf"

diff --git a/conf/modules.d/forged_recipients.conf b/conf/modules.d/forged_recipients.conf
index e71d2ee240cde792576bd9fead30a40a346dc70d..7ecdbce5259a21324f29ca79badfa2db462553f8 100644 (file)
--- a/conf/modules.d/forged_recipients.conf
+++ b/conf/modules.d/forged_recipients.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 forged_recipients {
     .include(try=true,priority=5) "${DBDIR}/dynamic/forged_recipients.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/forged_recipients.conf"

diff --git a/conf/modules.d/fuzzy_check.conf b/conf/modules.d/fuzzy_check.conf
index eb347b6564446a009efef5d6f517e9c414c81e70..7b95bfda6653b88f3d8b365936996f8045d19942 100644 (file)
--- a/conf/modules.d/fuzzy_check.conf
+++ b/conf/modules.d/fuzzy_check.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 fuzzy_check {
     # Include dynamic conf for the rule
     .include(try=true,priority=5) "${DBDIR}/dynamic/fuzzy_check.conf"

diff --git a/conf/modules.d/hfilter.conf b/conf/modules.d/hfilter.conf
index 46cc78cb436289aae8ab61778dbadb782034c736..7da35403e2158ad37e8f206d74ca8a9afe80b297 100644 (file)
--- a/conf/modules.d/hfilter.conf
+++ b/conf/modules.d/hfilter.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 hfilter {
     .include(try=true,priority=5) "${DBDIR}/dynamic/hfilter.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/hfilter.conf"

diff --git a/conf/modules.d/ip_score.conf b/conf/modules.d/ip_score.conf
index a37eef10045565d5acf689dd25c4fc83fd380853..f8599fc06db543036648594625051cb566eda8c0 100644 (file)
--- a/conf/modules.d/ip_score.conf
+++ b/conf/modules.d/ip_score.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 ip_score {
     .include(try=true,priority=5) "${DBDIR}/dynamic/ip_score.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/ip_score.conf"

diff --git a/conf/modules.d/maillist.conf b/conf/modules.d/maillist.conf
index 59e24ad5db586519cbcaed5c18eadc39fad00232..26e0ca7ad3170127530142e5d37e5a1862bcc5ae 100644 (file)
--- a/conf/modules.d/maillist.conf
+++ b/conf/modules.d/maillist.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 maillist {
     .include(try=true,priority=5) "${DBDIR}/dynamic/maillist.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/maillist.conf"

diff --git a/conf/modules.d/mime_types.conf b/conf/modules.d/mime_types.conf
index fac9aa63b99d1c3e75f0d9ffb9aa93bba57a8994..c42ea9e76a2530fec438198de3f64a5f7fd316d5 100644 (file)
--- a/conf/modules.d/mime_types.conf
+++ b/conf/modules.d/mime_types.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 mime_types {
     .include(try=true,priority=5) "${DBDIR}/dynamic/mime_types.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/mime_types.conf"

diff --git a/conf/modules.d/multimap.conf b/conf/modules.d/multimap.conf
index aeaaef5e56c130c5cae53f078d90c273fe231595..72f5671777b2270cfd1bb43ecaf6cc4cf9271635 100644 (file)
--- a/conf/modules.d/multimap.conf
+++ b/conf/modules.d/multimap.conf
@@ -1,5 +1,49 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 multimap {
     .include(try=true,priority=5) "${DBDIR}/dynamic/multimap.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/multimap.conf"
     .include(try=true,priority=10) "$LOCAL_CONFDIR/override.d/multimap.conf"
 }
+
+/* Example setup
+sender_from_whitelist_user {
+            type = "from";
+            filter = "email:user";
+            map = "file:///tmp/from.map";
+            symbol = "SENDER_FROM_WHITELIST_USER";
+            action = "accept"; # Prefilter mode
+}
+sender_from_regexp {
+            type = "header";
+            header = "from";
+            filter = "regexp:/.*@/";
+            map = "file:///tmp/from_re.map";
+            symbol = "SENDER_FROM_REGEXP";
+}
+url_map {
+            type = "url";
+            filter = "tld";
+            map = "file:///tmp/url.map";
+            symbol = "URL_MAP";
+}
+url_tld_re {
+            type = "url";
+            filter = "tld:regexp:/\.[^.]+$/"; # Extracts the last component of URL
+            map = "file:///tmp/url.map";
+            symbol = "URL_MAP_RE";
+}
+*/

diff --git a/conf/modules.d/once_received.conf b/conf/modules.d/once_received.conf
index 84431888e4086a8eacfca20ee3d773e9c5a287b2..65efa20a775f6d74af37a0d4f0b884b6815befaa 100644 (file)
--- a/conf/modules.d/once_received.conf
+++ b/conf/modules.d/once_received.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 once_received {
     .include(try=true,priority=5) "${DBDIR}/dynamic/once_received.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/once_received.conf"

diff --git a/conf/modules.d/phishing.conf b/conf/modules.d/phishing.conf
index e48b13407a23f325addba61b23200c71207a5005..15b724a1007be9e515382b80107ebd2cbf0048a9 100644 (file)
--- a/conf/modules.d/phishing.conf
+++ b/conf/modules.d/phishing.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 phishing {
     .include(try=true,priority=5) "${DBDIR}/dynamic/phishing.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/phishing.conf"

diff --git a/conf/modules.d/ratelimit.conf b/conf/modules.d/ratelimit.conf
index 04654840ab0fc68d696aba1991deedfd1384c0de..97833c6f5e7591b1253961c06d9826dd84b35963 100644 (file)
--- a/conf/modules.d/ratelimit.conf
+++ b/conf/modules.d/ratelimit.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 ratelimit {
     .include(try=true,priority=5) "${DBDIR}/dynamic/ratelimit.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/ratelimit.conf"

diff --git a/conf/modules.d/rbl.conf b/conf/modules.d/rbl.conf
index 27ecdc229142ae10c0a769a5c67b753f0f0eb995..6b103230bb1c1c367f5127e8f902d7bde17ca040 100644 (file)
--- a/conf/modules.d/rbl.conf
+++ b/conf/modules.d/rbl.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 rbl {
     .include(try=true,priority=5) "${DBDIR}/dynamic/rbl.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/rbl.conf"

diff --git a/conf/modules.d/regexp.conf b/conf/modules.d/regexp.conf
index e1ef210328b4be25a6e518f01e1a47c016f3c973..56c4fe46c7d788fd1aa0f8ffce34c5a95cb2eb61 100644 (file)
--- a/conf/modules.d/regexp.conf
+++ b/conf/modules.d/regexp.conf
@@ -1,4 +1,21 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 regexp {
-    .include(try=true,priority=1) "${DBDIR}/dynamic/regexp.conf"
+    .include(try=true,priority=5) "${DBDIR}/dynamic/regexp.conf"
+    .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/regexp.conf"
+    .include(try=true,priority=10) "$LOCAL_CONFDIR/override.d/regexp.conf"
     max_size = 1M;
-}
\ No newline at end of file
+}

diff --git a/conf/modules.d/rspamd_update.conf b/conf/modules.d/rspamd_update.conf
index dde2100604ed8b17f17935ccd4fa0dd7e737635e..be34888a21202740304f9689c2ad42be25e6cf77 100644 (file)
--- a/conf/modules.d/rspamd_update.conf
+++ b/conf/modules.d/rspamd_update.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 rspamd_update {
     .include(try=true,priority=5) "${DBDIR}/dynamic/rspamd_update.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/rspamd_update.conf"

diff --git a/conf/modules.d/spf.conf b/conf/modules.d/spf.conf
index d815902057ad9ea440ce78c446a6a87c44d6c845..e25158d344cc6f44078d23fe91fd670d08452950 100644 (file)
--- a/conf/modules.d/spf.conf
+++ b/conf/modules.d/spf.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 spf {
     .include(try=true,priority=5) "${DBDIR}/dynamic/spf.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/spf.conf"

diff --git a/conf/modules.d/surbl.conf b/conf/modules.d/surbl.conf
index bdcdc8f57fc0cafa4b0b4197e3a9c151e034a4aa..e9411b8c6e7d5b3aa0ea4a4df8d0a4dcba42382e 100644 (file)
--- a/conf/modules.d/surbl.conf
+++ b/conf/modules.d/surbl.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 surbl {
     .include(try=true,priority=5) "${DBDIR}/dynamic/surbl.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/surbl.conf"

diff --git a/conf/modules.d/whitelist.conf b/conf/modules.d/whitelist.conf
index 05f18847af28609a706b3bd939a6144ff4517540..13013ff5302f767ae8b77592e7551ea529c00e48 100644 (file)
--- a/conf/modules.d/whitelist.conf
+++ b/conf/modules.d/whitelist.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 whitelist {
     .include(try=true,priority=5) "${DBDIR}/dynamic/whitelist.conf"
     .include(try=true,priority=1) "$LOCAL_CONFDIR/local.d/whitelist.conf"

diff --git a/conf/rspamd.systemd.conf b/conf/rspamd.systemd.conf
index cf60b7c2118b4898122399a79228125370275fac..6ab25f6a44012a5d8285793d6b52ed0df4036e80 100644 (file)
--- a/conf/rspamd.systemd.conf
+++ b/conf/rspamd.systemd.conf
@@ -1,3 +1,20 @@
+# Systemd enabled top level configuration file
+
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 .include "$CONFDIR/common.conf"
 
 options {

diff --git a/conf/rspamd.sysvinit.conf b/conf/rspamd.sysvinit.conf
index e24fe89020af8eb1c47d6bbc6b381ebe61662053..f5db622944930478c231681047cda622446d1be7 100644 (file)
--- a/conf/rspamd.sysvinit.conf
+++ b/conf/rspamd.sysvinit.conf
@@ -1,3 +1,20 @@
+# System V init adopted top level configuration
+
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 .include "$CONFDIR/common.conf"
 
 options {

diff --git a/conf/statistic.conf b/conf/statistic.conf
index 3cc2bfcda0e6eb8dcdf8438ed5867ca6ee1b9211..3315fe4b44c026c7a4e1b5a7af7f5a78d96587fc 100644 (file)
--- a/conf/statistic.conf
+++ b/conf/statistic.conf
@@ -1,3 +1,18 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
+# parameters defined on the top level
+#
+# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
+# parameters defined on the top level
+#
+# For specific modules or configuration you can also modify
+# '$LOCAL_CONFDIR/local.d/file.conf' - to add your options or rewrite defaults
+# '$LOCAL_CONFDIR/override.d/file.conf' - to override the defaults
+#
+# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+
 # Rspamd statistic setup
 # Pre-build files could be loaded from:
 # http://rspamd.com/rspamd_statistics/bayes.spam.sqlite