]> git.ipfire.org Git - thirdparty/rspamd.git/commitdiff
[Conf] Clarify documentation in the config files
authorVsevolod Stakhov <vsevolod@highsecure.ru>
Fri, 11 Oct 2019 08:34:40 +0000 (09:34 +0100)
committerVsevolod Stakhov <vsevolod@highsecure.ru>
Fri, 11 Oct 2019 08:34:40 +0000 (09:34 +0100)
14 files changed:
conf/actions.conf
conf/cgp.inc
conf/common.conf
conf/composites.conf
conf/groups.conf
conf/logging.inc
conf/modules.conf
conf/options.inc
conf/settings.conf
conf/statistic.conf
conf/worker-controller.inc
conf/worker-fuzzy.inc
conf/worker-normal.inc
conf/worker-proxy.inc

index 75b0d2f73d583f299f8970cbb094ac8fa388ac21..a141be7780bee52f69b8b2f7388d7c0b4ebb4319 100644 (file)
@@ -2,17 +2,16 @@
 # 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.d/actions.conf' to add and merge
+# parameters defined inside this section
 #
-# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
-# parameters defined on the top level
+# You can modify 'override.d/actions.conf' to strictly override all
+# parameters defined inside this section
 #
-# 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/faq.html#what-are-the-locald-and-overrided-directories
+# for details
 #
-# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+# See also https://rspamd.com/doc/faq.html#what-are-rspamd-actions for actions definition
 
 actions {
     reject = 15; # Reject when reaching this score
index fd71fa5a6b83278e98dca1e7ca2ddc7bdb4fc4fe..436713cff77f05d31ddcbbb845f320568602ec82 100644 (file)
@@ -1,3 +1,9 @@
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# This file defines some specific settings that are applicable merely when using
+# CommuniGate Pro MTA and it's specific integration
+
 arc {
     sign_networks = [127.2.4.7];
 }
index a8025f314a86c32353d0074cc8753d700d94d6de..023fd5125f2f5569cf6c68d587a00d76d91b42da 100644 (file)
@@ -1,4 +1,4 @@
-# A common rspamd configuration file
+# A common rspamd configuration file (should never ever be changed)
 # Please don't modify this file as your changes might be overwritten with
 # the next update.
 #
index 2204f1e713fafc965c2834ce2923f55d87c88aef..def043f1b64723e35c8a5a4f8ae5037c268ad583 100644 (file)
@@ -2,15 +2,14 @@
 # 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.d/composites.conf' to add and merge
+# parameters defined inside this section
 #
-# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
-# parameters defined on the top level
+# You can modify 'override.d/composites.conf' to strictly override all
+# parameters defined inside this section
 #
-# 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/faq.html#what-are-the-locald-and-overrided-directories
+# for details
 #
 # See https://rspamd.com/doc/tutorials/writing_rules.html and
 # https://rspamd.com/doc/configuration/composites.html for details
index 51e2a6522db3bc3be3c1b58ecfe4d978687c99b3..bf783cc2f2d8a63d97b16cb4ec8f2183bc905194 100644 (file)
@@ -4,17 +4,16 @@
 # 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.d/groups.conf' to add and merge
+# parameters defined inside this section
 #
-# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
-# parameters defined on the top level
+# You can modify 'override.d/groups.conf' to strictly override all
+# parameters defined inside this section
 #
-# 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/faq.html#what-are-the-locald-and-overrided-directories
+# for details
 #
-# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+# See also: https://rspamd.com/doc/faq.html#how-to-change-score-for-some-symbol
 
 group "headers" {
     .include "$CONFDIR/scores.d/headers_group.conf"
index ebdbfc110267dd22e45e1e4c9f950a502229c73d..00dba3915a7a2850d6a9f0eee82dbf37ffdfbf2e 100644 (file)
@@ -1,4 +1,17 @@
-# Included from top-level .conf file
+# Logging configuration
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify 'local.d/logging.inc' to add and merge
+# parameters defined inside this section
+#
+# You can modify 'override.d/logging.inc' to strictly override all
+# parameters defined inside this section
+#
+# See https://rspamd.com/doc/faq.html#what-are-the-locald-and-overrided-directories
+# for details
+#
+# Relevant documentation: https://rspamd.com/doc/configuration/logging.html
 
 level = "info";
 log_format =<<EOD
index 3da04ae2cf2b560cf437c8f6a1686ce09055b08f..b37da06d5988febc3a2b434f42bfbdf3ee10d1c6 100644 (file)
@@ -1,3 +1,17 @@
-# Rspamd modules configuration
+# A common rspamd configuration file (should never ever be changed)
+# 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(glob=true) "${CONFDIR}/modules.d/*.conf"
\ No newline at end of file
index 4489ed29ffaf8e2072704c1a1ec84ef278142566..504e06a012a172dcf9cf6e6fd3e2590e76fb1c19 100644 (file)
@@ -1,4 +1,17 @@
-# Included from top-level .conf file
+# Logging configuration
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify 'local.d/options.inc' to add and merge
+# parameters defined inside this section
+#
+# You can modify 'override.d/options.inc' to strictly override all
+# parameters defined inside this section
+#
+# See https://rspamd.com/doc/faq.html#what-are-the-locald-and-overrided-directories
+# for details
+#
+# Relevant documentation: https://rspamd.com/doc/configuration/options.html
 
 filters = "chartable,dkim,spf,regexp,fuzzy_check";
 raw_mode = false;
index c03c1347785d67bb13a3c673dfd3f42fe8475b83..95d71e4bfda067b5c2d7189bbd87614ef36953c5 100644 (file)
@@ -1,14 +1,17 @@
-# You can modify '$LOCAL_CONFDIR/rspamd.conf.local.override' to redefine
-# parameters defined on the top level
+# Settings 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' to add
-# parameters defined on the top level
+# You can modify 'local.d/settings.conf' to add and merge
+# parameters defined inside this section
 #
-# 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
+# You can modify 'override.d/settings.conf' to strictly override all
+# parameters defined inside this section
 #
-# See https://rspamd.com/doc/tutorials/writing_rules.html for details
+# See https://rspamd.com/doc/faq.html#what-are-the-locald-and-overrided-directories
+# for details
+#
+# Module documentation: https://rspamd.com/doc/configuration/settings.html
 
 # If you want to use settings map, then please define something like:
 #
 # in rspamd.conf.override
 
 settings {
-/* Commented out
   # Some examples below (define in local.d/settings.conf without `settings {}`!)
-  some_users {
-    id = "some_users";
-    priority = high;
-    from = "@example.com";
-    rcpt = "admin";
-    rcpt = "/user.*/";
-    ip = "172.16.0.0/16";
-    user = "@example.net";
-    request_header = {
-      "MTA-Tag" = "\.example\.net$";
-    }
-    apply {
-      symbol1 = 10.0;
-      symbol2 = 0.0;
-      actions {
-        reject = 100.0;
-        greylist = 10.0;
-        "add header" = 5.0; # Please note the space, NOT an underscore
-      }
-    }
-    # Always add these symbols when settings rule has matched
-    symbols [
-      "symbol2", "symbol4"
-    ]
-  }
-  whitelist {
-    priority = low;
-    rcpt = "postmaster@example.com";
-    want_spam = yes;
-  }
+  #some_users {
+  #  id = "some_users";
+  #  priority = high;
+  #  from = "@example.com";
+  #  rcpt = "admin";
+  #  rcpt = "/user.*/";
+  #  ip = "172.16.0.0/16";
+  #  user = "@example.net";
+  #  request_header = {
+  #    "MTA-Tag" = "\.example\.net$";
+  #  }
+  #  apply {
+  #    symbol1 = 10.0;
+  #    symbol2 = 0.0;
+  #    actions {
+  #      reject = 100.0;
+  #      greylist = 10.0;
+  #      "add header" = 5.0; # Please note the space, NOT an underscore
+  #    }
+  #  }
+  # Always add these symbols when settings rule has matched
+  #  symbols [
+  #    "symbol2", "symbol4"
+  #  ]
+  #}
+  #whitelist {
+  #  priority = low;
+  #  rcpt = "postmaster@example.com";
+  #  want_spam = yes;
+  #}
   # Disable some checks for authenticated users
-  authenticated {
-    priority = high;
-    authenticated = yes;
-    apply {
-      groups_disabled = ["rbl", "spf"];
-    }
-  }
-  # End of example
-*/
+  #authenticated {
+  #  priority = high;
+  #  authenticated = yes;
+  #  apply {
+  #    groups_disabled = ["rbl", "spf"];
+  #  }
+  #}
+  # End of examples
+
   .include(try=true,priority=1,duplicate=merge) "$LOCAL_CONFDIR/local.d/settings.conf"
   .include(try=true; priority=10) "$LOCAL_CONFDIR/override.d/settings.conf"
 }
\ No newline at end of file
index 0d76cd399319b5cffd8e60c0e884188b5a521fb2..60b6dcb3e1019f96bf94d85a788857aaa6897454 100644 (file)
@@ -1,23 +1,22 @@
+# Statistics 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.d/statistics.conf' to add and merge
+# parameters defined inside this section
 #
-# You can modify '$LOCAL_CONFDIR/rspamd.conf.local' to add
-# parameters defined on the top level
+# You can modify 'override.d/statistics.conf' to strictly override all
+# parameters defined inside this section
 #
-# 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
+# If you just need to change the default bayes classifier, you can also use
+# 'local.d/classifier-bayes.conf' or 'override.d/classifier-bayes.conf'. But
+# never ever use both `statistics.conf` and `classifier-bayes.conf` locals files
+# together!
 #
-# See https://rspamd.com/doc/tutorials/writing_rules.html for details
-
-# Rspamd statistic setup
-# Pre-built files could be loaded from:
-# http://rspamd.com/rspamd_statistics/bayes.spam.sqlite
-#  - and -
-# http://rspamd.com/rspamd_statistics/bayes.ham.sqlite
+# See https://rspamd.com/doc/faq.html#what-are-the-locald-and-overrided-directories
+# for details
+#
+# Module documentation: https://rspamd.com/doc/configuration/statistic.html
 
 classifier "bayes" {
   tokenizer {
index ac4c1355df05f9345d10c5f738272a0d5a1ffefe..1fdffff662ee6892b28cb36b35f05c09a4a0a654 100644 (file)
@@ -1,4 +1,16 @@
-# Included from top-level .conf file
+# Controller worker setup
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify 'local.d/worker-controller.inc' to add and merge
+# parameters defined inside this section
+#
+# You can modify 'override.d/worker-controller.inc' to strictly override all
+# parameters defined inside this section
+#
+# See https://rspamd.com/doc/faq.html#what-are-the-locald-and-overrided-directories
+# for details
+# Module documentation: https://rspamd.com/doc/workers/controller.html
 
 count = 1;
 password = "q1";
index bd4029bc3f31eee55c7ffcd843fb910aa3e3b9b7..5cf788c085bcaa2b6a46203e197a0a09c13de717 100644 (file)
@@ -1,4 +1,16 @@
-# Included from top-level .conf file
+# Fuzzy storage worker setup
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify 'local.d/worker-fuzzy.inc' to add and merge
+# parameters defined inside this section
+#
+# You can modify 'override.d/worker-fuzzy.inc' to strictly override all
+# parameters defined inside this section
+#
+# See https://rspamd.com/doc/faq.html#what-are-the-locald-and-overrided-directories
+# for details
+# Module documentation: https://rspamd.com/doc/workers/fuzzy_storage.html
 
 backend = "redis";
 
index 532455d0ad686f1a5c7cc4b930e0c8df50cccdbf..285a17a18bee8c500f55142c38a069b01c729db4 100644 (file)
@@ -1,3 +1,15 @@
-# Included from top-level .conf file
+# Normal scanner worker setup
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify 'local.d/worker-normal.inc' to add and merge
+# parameters defined inside this section
+#
+# You can modify 'override.d/worker-normal.inc' to strictly override all
+# parameters defined inside this section
+#
+# See https://rspamd.com/doc/faq.html#what-are-the-locald-and-overrided-directories
+# for details
+# Module documentation: https://rspamd.com/doc/workers/normal.html
 
 mime = true;
index cfc18c059b474727c36643758391d11595409ce1..96417e38973e95fbf432d8f1037cc31a506bedf6 100644 (file)
@@ -1,4 +1,16 @@
-# Included from top-level .conf file
+# Proxy worker setup
+# Please don't modify this file as your changes might be overwritten with
+# the next update.
+#
+# You can modify 'local.d/worker-proxy.inc' to add and merge
+# parameters defined inside this section
+#
+# You can modify 'override.d/worker-proxy.inc' to strictly override all
+# parameters defined inside this section
+#
+# See https://rspamd.com/doc/faq.html#what-are-the-locald-and-overrided-directories
+# for details
+# Module documentation: https://rspamd.com/doc/workers/rspamd_proxy.html
 
 milter = yes; # Enable milter mode
 timeout = 120s; # Needed for Milter usually