From: Vsevolod Stakhov <vsevolod@rspamd.com>
Date: Fri, 14 Nov 2025 14:06:37 +0000 (+0000)
Subject: [Fix] Update config comments to guide users to local.d
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=f76299c1e5e1b8335018852ae93bad916899b170;p=thirdparty%2Frspamd.git

[Fix] Update config comments to guide users to local.d

- Changed comments from 'Uncomment to enable' to 'To enable, add in local.d/url_suspect.conf:'
- Users should not edit shipped config files directly
- Follow Rspamd convention: use local.d/override.d for user customizations
- Updated all map parameter comments for consistency
- Clearer path structure: use local.d/maps/ subdirectory
---

diff --git a/conf/modules.d/url_suspect.conf b/conf/modules.d/url_suspect.conf
index 467612eb21..e4e869da74 100644
--- a/conf/modules.d/url_suspect.conf
+++ b/conf/modules.d/url_suspect.conf
@@ -23,12 +23,12 @@ url_suspect {
       }
 
       # OPTIONAL: Advanced pattern matching
-      # Uncomment to enable custom user field patterns
-      # pattern_map = "$LOCAL_CONFDIR/local.d/url_suspect_user_patterns.map";
+      # To enable, add in local.d/url_suspect.conf:
+      # pattern_map = "$LOCAL_CONFDIR/local.d/maps/url_suspect_user_patterns.map";
 
       # OPTIONAL: User blacklist
-      # Uncomment to enable user field blacklist
-      # blacklist_map = "$LOCAL_CONFDIR/local.d/url_suspect_user_blacklist.map";
+      # To enable, add in local.d/url_suspect.conf:
+      # blacklist_map = "$LOCAL_CONFDIR/local.d/maps/url_suspect_user_blacklist.map";
     }
 
     # Numeric IP address analysis
@@ -44,8 +44,8 @@ url_suspect {
       private_score = 0.5;       # Lower score for private IPs
 
       # OPTIONAL: Suspicious IP ranges map
-      # Uncomment to enable custom IP range checking
-      # range_map = "$LOCAL_CONFDIR/local.d/url_suspect_ip_ranges.map";
+      # To enable, add in local.d/url_suspect.conf:
+      # range_map = "$LOCAL_CONFDIR/local.d/maps/url_suspect_ip_ranges.map";
     }
 
     # TLD (Top Level Domain) analysis
@@ -60,8 +60,8 @@ url_suspect {
       missing_tld_score = 2.0;
 
       # OPTIONAL: Custom TLD map
-      # Uncomment to add additional TLDs to check
-      # tld_map = "$LOCAL_CONFDIR/local.d/url_suspect_tlds.map";
+      # To enable, add in local.d/url_suspect.conf:
+      # tld_map = "$LOCAL_CONFDIR/local.d/maps/url_suspect_tlds.map";
     }
 
     # Unicode and encoding analysis
@@ -95,8 +95,8 @@ url_suspect {
       max_url_length = 2048;
 
       # OPTIONAL: Suspicious ports map
-      # Uncomment to check for unusual ports
-      # port_map = "$LOCAL_CONFDIR/local.d/url_suspect_ports.map";
+      # To enable, add in local.d/url_suspect.conf:
+      # port_map = "$LOCAL_CONFDIR/local.d/maps/url_suspect_ports.map";
     }
   }
 
@@ -130,11 +130,11 @@ url_suspect {
   }
 
   # ADVANCED: Global whitelist
-  # Uncomment to skip checks for specific domains
-  # whitelist_map = "$LOCAL_CONFDIR/local.d/url_suspect_whitelist.map";
+  # To enable, add in local.d/url_suspect.conf:
+  # whitelist_map = "$LOCAL_CONFDIR/local.d/maps/url_suspect_whitelist.map";
 
-  # ADVANCED: Custom checks (disabled by default)
-  # Example:
+  # ADVANCED: Custom checks
+  # To enable, add in local.d/url_suspect.conf:
   # custom_checks {
   #   my_check = <<EOD
   #     return function(task, url, settings)