2023-01-25 09:29:36 +00:00
<!doctype html>
< html lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< meta name = "description" content = "A fullstack but simple mail-server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.) using Docker." >
< meta name = "author" content = "docker-mailserver (Github Organization)" >
< link rel = "canonical" href = "https://docker-mailserver.github.io/docker-mailserver/edge/config/security/rspamd/" >
< link rel = "icon" href = "../../../assets/logo/favicon-32x32.png" >
< meta name = "generator" content = "mkdocs-1.3.0, mkdocs-material-8.3.9" >
< title > Security | Rspamd - Docker Mailserver< / title >
< link rel = "stylesheet" href = "../../../assets/stylesheets/main.1d29e8d0.min.css" >
< link rel = "stylesheet" href = "../../../assets/stylesheets/palette.cbb835fc.min.css" >
< link rel = "preconnect" href = "https://fonts.gstatic.com" crossorigin >
< link rel = "stylesheet" href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" >
< style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style >
< link rel = "stylesheet" href = "../../../assets/css/customizations.css" >
< script > _ _md _scope = new URL ( "../../.." , location ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script >
< / head >
< body dir = "ltr" data-md-color-scheme = "default" data-md-color-primary = "indigo" data-md-color-accent = "indigo" >
< script > var palette = _ _md _get ( "__palette" ) ; if ( palette && "object" == typeof palette . color ) for ( var key of Object . keys ( palette . color ) ) document . body . setAttribute ( "data-md-color-" + key , palette . color [ key ] ) < / script >
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" autocomplete = "off" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" autocomplete = "off" >
< label class = "md-overlay" for = "__drawer" > < / label >
< div data-md-component = "skip" >
< a href = "#about" class = "md-skip" >
Skip to content
< / a >
< / div >
< div data-md-component = "announce" >
< / div >
< div data-md-component = "outdated" hidden >
< aside class = "md-banner md-banner--warning" >
< / aside >
< / div >
< header class = "md-header" data-md-component = "header" >
< nav class = "md-header__inner md-grid" aria-label = "Header" >
< a href = "../../.." title = "Docker Mailserver" class = "md-header__button md-logo" aria-label = "Docker Mailserver" data-md-component = "logo" >
< img src = "../../../assets/logo/dmo-logo-white.min.svg" alt = "logo" >
< / a >
< label class = "md-header__button md-icon" for = "__drawer" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z" / > < / svg >
< / label >
< div class = "md-header__title" data-md-component = "header-title" >
< div class = "md-header__ellipsis" >
< div class = "md-header__topic" >
< span class = "md-ellipsis" >
Docker Mailserver
< / span >
< / div >
< div class = "md-header__topic" data-md-component = "header-topic" >
< span class = "md-ellipsis" >
Security | Rspamd
< / span >
< / div >
< / div >
< / div >
< form class = "md-header__option" data-md-component = "palette" >
< input class = "md-option" data-md-color-media = "(prefers-color-scheme: light)" data-md-color-scheme = "default" data-md-color-primary = "indigo" data-md-color-accent = "indigo" aria-label = "Switch to dark mode" type = "radio" name = "__palette" id = "__palette_1" >
< label class = "md-header__button md-icon" title = "Switch to dark mode" for = "__palette_2" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z" / > < / svg >
< / label >
< input class = "md-option" data-md-color-media = "(prefers-color-scheme: dark)" data-md-color-scheme = "slate" data-md-color-primary = "indigo" data-md-color-accent = "blue" aria-label = "Switch to light mode" type = "radio" name = "__palette" id = "__palette_2" >
< label class = "md-header__button md-icon" title = "Switch to light mode" for = "__palette_1" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z" / > < / svg >
< / label >
< / form >
< label class = "md-header__button md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< / label >
< div class = "md-search" data-md-component = "search" role = "dialog" >
< label class = "md-search__overlay" for = "__search" > < / label >
< div class = "md-search__inner" role = "search" >
< form class = "md-search__form" name = "search" >
< input type = "text" class = "md-search__input" name = "query" aria-label = "Search" placeholder = "Search" autocapitalize = "off" autocorrect = "off" autocomplete = "off" spellcheck = "false" data-md-component = "search-query" required >
< label class = "md-search__icon md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" / > < / svg >
< / label >
< nav class = "md-search__options" aria-label = "Search" >
< button type = "reset" class = "md-search__icon md-icon" aria-label = "Clear" tabindex = "-1" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z" / > < / svg >
< / button >
< / nav >
< / form >
< div class = "md-search__output" >
< div class = "md-search__scrollwrap" data-md-scrollfix >
< div class = "md-search-result" data-md-component = "search-result" >
< div class = "md-search-result__meta" >
Initializing search
< / div >
< ol class = "md-search-result__list" > < / ol >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "md-header__source" >
< a href = "https://github.com/docker-mailserver/docker-mailserver" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 496 512" > <!-- ! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --> < path d = "M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z" / > < / svg >
< / div >
< div class = "md-source__repository" >
docker-mailserver
< / div >
< / a >
< / div >
< / nav >
< / header >
< div class = "md-container" data-md-component = "container" >
< nav class = "md-tabs" aria-label = "Tabs" data-md-component = "tabs" >
< div class = "md-tabs__inner md-grid" >
< ul class = "md-tabs__list" >
< li class = "md-tabs__item" >
< a href = "../../.." class = "md-tabs__link" >
Home
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../../../introduction/" class = "md-tabs__link" >
Introduction
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../../setup.sh/" class = "md-tabs__link md-tabs__link--active" >
Configuration
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../../../examples/tutorials/basic-installation/" class = "md-tabs__link" >
Examples
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../../../faq/" class = "md-tabs__link" >
FAQ
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../../../contributing/general/" class = "md-tabs__link" >
Contributing
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "https://hub.docker.com/r/mailserver/docker-mailserver/" class = "md-tabs__link" >
DockerHub
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "https://github.com/docker-mailserver/docker-mailserver/pkgs/container/docker-mailserver" class = "md-tabs__link" >
GHCR
< / a >
< / li >
< / ul >
< / div >
< / nav >
< main class = "md-main" data-md-component = "main" >
< div class = "md-main__inner md-grid" >
< div class = "md-sidebar md-sidebar--primary" data-md-component = "sidebar" data-md-type = "navigation" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--primary md-nav--lifted" aria-label = "Navigation" data-md-level = "0" >
< label class = "md-nav__title" for = "__drawer" >
< a href = "../../.." title = "Docker Mailserver" class = "md-nav__button md-logo" aria-label = "Docker Mailserver" data-md-component = "logo" >
< img src = "../../../assets/logo/dmo-logo-white.min.svg" alt = "logo" >
< / a >
Docker Mailserver
< / label >
< div class = "md-nav__source" >
< a href = "https://github.com/docker-mailserver/docker-mailserver" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 496 512" > <!-- ! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --> < path d = "M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z" / > < / svg >
< / div >
< div class = "md-source__repository" >
docker-mailserver
< / div >
< / a >
< / div >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../.." class = "md-nav__link" >
Home
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../../introduction/" class = "md-nav__link" >
Introduction
< / a >
< / li >
< li class = "md-nav__item md-nav__item--active md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle" data-md-toggle = "__nav_3" type = "checkbox" id = "__nav_3" checked >
< label class = "md-nav__link" for = "__nav_3" >
Configuration
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Configuration" data-md-level = "1" >
< label class = "md-nav__title" for = "__nav_3" >
< span class = "md-nav__icon md-icon" > < / span >
Configuration
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../setup.sh/" class = "md-nav__link" >
Your Best Friend setup.sh
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../environment/" class = "md-nav__link" >
Environment Variables
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle = "__nav_3_3" type = "checkbox" id = "__nav_3_3" checked >
< label class = "md-nav__link" for = "__nav_3_3" >
User Management
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "User Management" data-md-level = "2" >
< label class = "md-nav__title" for = "__nav_3_3" >
< span class = "md-nav__icon md-icon" > < / span >
User Management
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../user-management/accounts/" class = "md-nav__link" >
Accounts
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../user-management/aliases/" class = "md-nav__link" >
Aliases
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle = "__nav_3_4" type = "checkbox" id = "__nav_3_4" checked >
< label class = "md-nav__link" for = "__nav_3_4" >
Best Practices
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Best Practices" data-md-level = "2" >
< label class = "md-nav__title" for = "__nav_3_4" >
< span class = "md-nav__icon md-icon" > < / span >
Best Practices
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../best-practices/dkim/" class = "md-nav__link" >
DKIM
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../best-practices/dmarc/" class = "md-nav__link" >
DMARC
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../best-practices/spf/" class = "md-nav__link" >
SPF
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../best-practices/autodiscover/" class = "md-nav__link" >
Auto-discovery
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--active md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle" data-md-toggle = "__nav_3_5" type = "checkbox" id = "__nav_3_5" checked >
< label class = "md-nav__link" for = "__nav_3_5" >
Security
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Security" data-md-level = "2" >
< label class = "md-nav__title" for = "__nav_3_5" >
< span class = "md-nav__icon md-icon" > < / span >
Security
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../understanding-the-ports/" class = "md-nav__link" >
Understanding the Ports
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../ssl/" class = "md-nav__link" >
SSL/TLS
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../fail2ban/" class = "md-nav__link" >
Fail2Ban
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../mail_crypt/" class = "md-nav__link" >
Mail Encryption
< / a >
< / li >
< li class = "md-nav__item md-nav__item--active" >
< input class = "md-nav__toggle md-toggle" data-md-toggle = "toc" type = "checkbox" id = "__toc" >
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
Rspamd
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< a href = "./" class = "md-nav__link md-nav__link--active" >
Rspamd
< / a >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#about" class = "md-nav__link" >
About
< / a >
< / li >
< li class = "md-nav__item" >
2023-02-19 11:37:08 +00:00
< a href = "#the-default-configuration" class = "md-nav__link" >
The Default Configuration
2023-01-25 09:29:36 +00:00
< / a >
2023-02-19 11:37:08 +00:00
< nav class = "md-nav" aria-label = "The Default Configuration" >
2023-01-25 09:29:36 +00:00
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
2023-02-19 11:37:08 +00:00
< a href = "#mode-of-operation" class = "md-nav__link" >
Mode of Operation
2023-01-25 09:29:36 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
2023-02-19 11:37:08 +00:00
< a href = "#modules" class = "md-nav__link" >
Modules
< / a >
< nav class = "md-nav" aria-label = "Modules" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#disabled-by-default" class = "md-nav__link" >
Disabled By Default
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#anti-virus-clamav" class = "md-nav__link" >
Anti-Virus (ClamAV)
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#rbls-realtime-blacklists-dnsbls-dns-based-blacklists" class = "md-nav__link" >
RBLs (Realtime Blacklists) / DNSBLs (DNS-based Blacklists)
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#missing-in-the-current-implementation" class = "md-nav__link" >
Missing in the Current Implementation
2023-01-25 09:29:36 +00:00
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
2023-02-19 11:37:08 +00:00
< a href = "#providing-custom-settings-overriding-settings" class = "md-nav__link" >
Providing Custom Settings & Overriding Settings
2023-01-25 09:29:36 +00:00
< / a >
2023-02-19 11:37:08 +00:00
< nav class = "md-nav" aria-label = "Providing Custom Settings & Overriding Settings" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#manually" class = "md-nav__link" >
Manually
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#with-the-help-of-a-custom-file" class = "md-nav__link" >
With the Help of a Custom File
< / a >
< / li >
< / ul >
< / nav >
2023-01-25 09:29:36 +00:00
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle = "__nav_3_6" type = "checkbox" id = "__nav_3_6" checked >
< label class = "md-nav__link" for = "__nav_3_6" >
Troubleshooting
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Troubleshooting" data-md-level = "2" >
< label class = "md-nav__title" for = "__nav_3_6" >
< span class = "md-nav__icon md-icon" > < / span >
Troubleshooting
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../troubleshooting/debugging/" class = "md-nav__link" >
Debugging
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "../../pop3/" class = "md-nav__link" >
Mail Delivery with POP3
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle = "__nav_3_8" type = "checkbox" id = "__nav_3_8" checked >
< label class = "md-nav__link" for = "__nav_3_8" >
Advanced Configuration
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Advanced Configuration" data-md-level = "2" >
< label class = "md-nav__title" for = "__nav_3_8" >
< span class = "md-nav__icon md-icon" > < / span >
Advanced Configuration
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../advanced/optional-config/" class = "md-nav__link" >
Optional Configuration
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle = "__nav_3_8_2" type = "checkbox" id = "__nav_3_8_2" checked >
< label class = "md-nav__link" for = "__nav_3_8_2" >
Maintenance
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Maintenance" data-md-level = "3" >
< label class = "md-nav__title" for = "__nav_3_8_2" >
< span class = "md-nav__icon md-icon" > < / span >
Maintenance
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../advanced/maintenance/update-and-cleanup/" class = "md-nav__link" >
Update and Cleanup
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle = "__nav_3_8_3" type = "checkbox" id = "__nav_3_8_3" checked >
< label class = "md-nav__link" for = "__nav_3_8_3" >
Override the Default Configs
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Override the Default Configs" data-md-level = "3" >
< label class = "md-nav__title" for = "__nav_3_8_3" >
< span class = "md-nav__icon md-icon" > < / span >
Override the Default Configs
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../advanced/override-defaults/dovecot/" class = "md-nav__link" >
Dovecot
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../advanced/override-defaults/postfix/" class = "md-nav__link" >
Postfix
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../advanced/override-defaults/user-patches/" class = "md-nav__link" >
Modifications via Script
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "../../advanced/auth-ldap/" class = "md-nav__link" >
LDAP Authentication
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../advanced/mail-sieve/" class = "md-nav__link" >
Email Filtering with Sieve
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../advanced/mail-fetchmail/" class = "md-nav__link" >
Email Gathering with Fetchmail
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle = "__nav_3_8_7" type = "checkbox" id = "__nav_3_8_7" checked >
< label class = "md-nav__link" for = "__nav_3_8_7" >
Email Forwarding
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Email Forwarding" data-md-level = "3" >
< label class = "md-nav__title" for = "__nav_3_8_7" >
< span class = "md-nav__icon md-icon" > < / span >
Email Forwarding
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../advanced/mail-forwarding/relay-hosts/" class = "md-nav__link" >
Relay Hosts
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../advanced/mail-forwarding/aws-ses/" class = "md-nav__link" >
AWS SES
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "../../advanced/full-text-search/" class = "md-nav__link" >
Full-Text Search
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../advanced/kubernetes/" class = "md-nav__link" >
Kubernetes
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../advanced/ipv6/" class = "md-nav__link" >
IPv6
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../advanced/podman/" class = "md-nav__link" >
Podman
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../advanced/dovecot-master-accounts/" class = "md-nav__link" >
Dovecot Master Accounts
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle = "__nav_4" type = "checkbox" id = "__nav_4" checked >
< label class = "md-nav__link" for = "__nav_4" >
Examples
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Examples" data-md-level = "1" >
< label class = "md-nav__title" for = "__nav_4" >
< span class = "md-nav__icon md-icon" > < / span >
Examples
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle = "__nav_4_1" type = "checkbox" id = "__nav_4_1" checked >
< label class = "md-nav__link" for = "__nav_4_1" >
Tutorials
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Tutorials" data-md-level = "2" >
< label class = "md-nav__title" for = "__nav_4_1" >
< span class = "md-nav__icon md-icon" > < / span >
Tutorials
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../../examples/tutorials/basic-installation/" class = "md-nav__link" >
Basic Installation
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../../examples/tutorials/mailserver-behind-proxy/" class = "md-nav__link" >
Mailserver behind Proxy
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../../examples/tutorials/docker-build/" class = "md-nav__link" >
Building your own Docker image
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../../examples/tutorials/blog-posts/" class = "md-nav__link" >
Blog Posts
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle = "__nav_4_2" type = "checkbox" id = "__nav_4_2" checked >
< label class = "md-nav__link" for = "__nav_4_2" >
Use Cases
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Use Cases" data-md-level = "2" >
< label class = "md-nav__title" for = "__nav_4_2" >
< span class = "md-nav__icon md-icon" > < / span >
Use Cases
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../../examples/use-cases/forward-only-mailserver-with-ldap-authentication/" class = "md-nav__link" >
Forward-Only Mail-Server with LDAP
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../../examples/use-cases/imap-folders/" class = "md-nav__link" >
Customize IMAP Folders
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "../../../faq/" class = "md-nav__link" >
FAQ
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle = "__nav_6" type = "checkbox" id = "__nav_6" checked >
< label class = "md-nav__link" for = "__nav_6" >
Contributing
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Contributing" data-md-level = "1" >
< label class = "md-nav__title" for = "__nav_6" >
< span class = "md-nav__icon md-icon" > < / span >
Contributing
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../../../contributing/general/" class = "md-nav__link" >
General Information
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../../contributing/tests/" class = "md-nav__link" >
Tests
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../../contributing/issues-and-pull-requests/" class = "md-nav__link" >
Issues and Pull Requests
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "https://hub.docker.com/r/mailserver/docker-mailserver/" class = "md-nav__link" >
DockerHub
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "https://github.com/docker-mailserver/docker-mailserver/pkgs/container/docker-mailserver" class = "md-nav__link" >
GHCR
< / a >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-sidebar md-sidebar--secondary" data-md-component = "sidebar" data-md-type = "toc" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#about" class = "md-nav__link" >
About
< / a >
< / li >
< li class = "md-nav__item" >
2023-02-19 11:37:08 +00:00
< a href = "#the-default-configuration" class = "md-nav__link" >
The Default Configuration
2023-01-25 09:29:36 +00:00
< / a >
2023-02-19 11:37:08 +00:00
< nav class = "md-nav" aria-label = "The Default Configuration" >
2023-01-25 09:29:36 +00:00
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
2023-02-19 11:37:08 +00:00
< a href = "#mode-of-operation" class = "md-nav__link" >
Mode of Operation
2023-01-25 09:29:36 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
2023-02-19 11:37:08 +00:00
< a href = "#modules" class = "md-nav__link" >
Modules
< / a >
< nav class = "md-nav" aria-label = "Modules" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#disabled-by-default" class = "md-nav__link" >
Disabled By Default
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#anti-virus-clamav" class = "md-nav__link" >
Anti-Virus (ClamAV)
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#rbls-realtime-blacklists-dnsbls-dns-based-blacklists" class = "md-nav__link" >
RBLs (Realtime Blacklists) / DNSBLs (DNS-based Blacklists)
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#missing-in-the-current-implementation" class = "md-nav__link" >
Missing in the Current Implementation
2023-01-25 09:29:36 +00:00
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
2023-02-19 11:37:08 +00:00
< a href = "#providing-custom-settings-overriding-settings" class = "md-nav__link" >
Providing Custom Settings & Overriding Settings
< / a >
< nav class = "md-nav" aria-label = "Providing Custom Settings & Overriding Settings" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#manually" class = "md-nav__link" >
Manually
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#with-the-help-of-a-custom-file" class = "md-nav__link" >
With the Help of a Custom File
2023-01-25 09:29:36 +00:00
< / a >
2023-02-19 11:37:08 +00:00
< / li >
< / ul >
< / nav >
2023-01-25 09:29:36 +00:00
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
< a href = "https://github.com/docker-mailserver/docker-mailserver/edit/master/docs/content/config/security/rspamd.md" title = "Edit this page" class = "md-content__button md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25Z" / > < / svg >
< / a >
< h1 > Rspamd< / h1 >
< div class = "admonition warning" >
2023-02-19 11:37:08 +00:00
< p class = "admonition-title" > The current state of Rspamd integration into DMS< / p >
< p > Recent pull requests have stabilized integration of Rspamd to a point that we encourage users to test the feature. We are confident that there are no major bugs in our integration that make using Rspamd infeasible. Please note that there may still be (breaking) changes ahead as integration is still work in progress!< / p >
< p > We expect to stabilize this feature with version < code > v12.1.0< / code > .< / p >
2023-01-25 09:29:36 +00:00
< / div >
< h2 id = "about" > < a class = "toclink" href = "#about" > About< / a > < / h2 >
2023-02-19 11:37:08 +00:00
< p > Rspamd is a < a href = "https://rspamd.com/" > "fast, free and open-source spam filtering system"< / a > . DMS integrates Rspamd like any other service. You will need to enable Rspamd (via < code > ENABLE_RSPAMD=1< / code > ) manually as it is disabled by default.< / p >
< p > We provide a very simple but easy to maintain setup of Rspamd. If you want to have a look at the default configuration files for Rspamd that DMS packs, navigate to < a href = "https://github.com/docker-mailserver/docker-mailserver/tree/master/target/rspamd" > < code > target/rspamd/< / code > inside the repository< / a > . Please consult the < a href = "#the-default-configuration" > section "The Default Configuration"< / a > section down below for a written overview.< / p >
< p > If you want to adjust Rspamd's configuration, have a look at the < a href = "#providing-custom-settings-overriding-settings" > "Providing Custom Settings & Overriding Settings" section< / a > down below.< / p >
< div class = "admonition note" >
< p class = "admonition-title" > AMD64 vs ARM64< / p >
< p > We are currently doing a best-effort installation of Rspamd for ARM64 (from the Debian backports repository for Debian 11). The current version difference is two minor versions (AMD64 is at version 3.4, ARM64 at 3.2 [13th Feb 2023]).< / p >
< p > Maintainers noticed only few differences, some of them with a big impact though. For those running Rspamd on ARM64, we recommend < a href = "#with-the-help-of-a-custom-file" > disabling< / a > the < a href = "https://rspamd.com/doc/modules/dkim_signing.html" > DKIM signing module< / a > if you don't use it.< / p >
< / div >
< h2 id = "the-default-configuration" > < a class = "toclink" href = "#the-default-configuration" > The Default Configuration< / a > < / h2 >
< h3 id = "mode-of-operation" > < a class = "toclink" href = "#mode-of-operation" > Mode of Operation< / a > < / h3 >
< p > The proxy worker operates in < a href = "https://rspamd.com/doc/workers/rspamd_proxy.html#self-scan-mode" > self-scan mode< / a > . This simplifies the setup as we do not require a normal worker. You can easily change this though by < a href = "#providing-custom-settings-overriding-settings" > overriding the configuration by DMS< / a > .< / p >
< p > DMS does not set a default password for the controller worker. You may want to do that yourself. In setup where you already have an authentication provider in front of the Rspamd webpage, you may add < code > secure_ip = "0.0.0.0/0";< / code > to < code > worker-controller.inc< / code > to disable password authentication inside Rspamd completely.< / p >
< h3 id = "modules" > < a class = "toclink" href = "#modules" > Modules< / a > < / h3 >
< p > You can find a list of all Rspamd modules < a href = "https://rspamd.com/doc/modules/" > on their website< / a > .< / p >
< h4 id = "disabled-by-default" > < a class = "toclink" href = "#disabled-by-default" > Disabled By Default< / a > < / h4 >
< p > DMS disables certain modules (clickhouse, elastic, greylist, neural, reputation, spamassassin, url_redirector, metric_exporter) by default. We believe these are not required in a standard setup, and they would otherwise needlessly use system resources.< / p >
< h4 id = "anti-virus-clamav" > < a class = "toclink" href = "#anti-virus-clamav" > Anti-Virus (ClamAV)< / a > < / h4 >
< p > You can choose to enable ClamAV, and Rspamd will then use it to check for viruses. Just set the environment variable < code > ENABLE_CLAMAV=1< / code > .< / p >
< h4 id = "rbls-realtime-blacklists-dnsbls-dns-based-blacklists" > < a class = "toclink" href = "#rbls-realtime-blacklists-dnsbls-dns-based-blacklists" > RBLs (Realtime Blacklists) / DNSBLs (DNS-based Blacklists)< / a > < / h4 >
< p > The < a href = "https://rspamd.com/doc/modules/rbl.html" > RBL module< / a > is enabled by default. As a consequence, Rspamd will perform DNS lookups to a variety of blacklists. Whether an RBL or a DNSBL is queried depends on where the domain name was obtained: RBL servers are queried with IP addresses extracted from message headers, DNSBL server are queried with domains and IP addresses extracted from the message body [< a href = "https://forum.eset.com/topic/25277-dnsbl-vs-rbl-mail-security/?do=findComment&comment=119818" > source< / a > ].< / p >
< div class = "admonition danger" >
< p class = "admonition-title" > Rspamd and DNS Block Lists< / p >
< p > When the RBL module is enabled, Rspamd will do a variety of DNS requests to (amongst other things) DNSBLs. There are a variety of issues involved when using DNSBLs. Rspamd will try to mitigate some of them by properly evaluating all return codes. This evaluation is a best effort though, so if the DNSBL operators change or add return codes, it may take a while for Rspamd to adjust as well.< / p >
< p > If you want to use DNSBLs, < strong > try to use your own DNS resolver< / strong > and make sure it is set up correctly, i.e. it should be a non-public & < strong > recursive< / strong > resolver. Otherwise, you might not be able (< a href = "https://www.spamhaus.org/faq/section/DNSBL%20Usage#365" > see this Spamhaus post< / a > ) to make use of the block lists.< / p >
< / div >
< h3 id = "missing-in-the-current-implementation" > < a class = "toclink" href = "#missing-in-the-current-implementation" > Missing in the Current Implementation< / a > < / h3 >
< p > We currently lack easy integration for < a href = "https://rspamd.com/doc/modules/dkim_signing.html" > DKIM signing outgoing mails< / a > . We use OpenDKIM though which works just as well. If you want to use Rspamd for DKIM signing, you need to provide all settings yourself and probably also set the environment variable < code > ENABLE_OPENDKIM=0< / code > . Rspamd will still check for valid DKIM signatures for incoming mail by default.< / p >
< h2 id = "providing-custom-settings-overriding-settings" > < a class = "toclink" href = "#providing-custom-settings-overriding-settings" > Providing Custom Settings & Overriding Settings< / a > < / h2 >
< h3 id = "manually" > < a class = "toclink" href = "#manually" > Manually< / a > < / h3 >
2023-01-25 09:29:36 +00:00
< p > DMS brings sane default settings for Rspamd. They are located at < code > /etc/rspamd/local.d/< / code > inside the container (or < code > target/rspamd/local.d/< / code > in the repository). If you want to change these settings and / or provide your own settings, you can< / p >
< ol >
< li > place files at < code > /etc/rspamd/override.d/< / code > which will override Rspamd settings and DMS settings< / li >
< li > (re-)place files at < code > /etc/rspamd/local.d/< / code > to override DMS settings and merge them with Rspamd settings< / li >
< / ol >
2023-02-19 11:37:08 +00:00
< div class = "admonition warning" >
< p class = "admonition-title" > Clashing Overrides< / p >
< p > Note that when also < a href = "#with-the-help-of-a-custom-file" > using the < code > rspamd-commands< / code > file< / a > , files in < code > override.d< / code > may be overwritten in case you adjust them manually and with the help of the file.< / p >
< / div >
< h3 id = "with-the-help-of-a-custom-file" > < a class = "toclink" href = "#with-the-help-of-a-custom-file" > With the Help of a Custom File< / a > < / h3 >
< p > DMS provides the ability to do simple adjustments to Rspamd modules with the help of a single file. Just place a file called < code > rspamd-modules.conf< / code > into the directory < code > docker-data/dms/config/< / code > (which translates to < code > /tmp/docker-mailserver/< / code > in the container). If this file is present, DMS will evaluate it. The structure is < em > very< / em > simple. Each line in the file looks like this:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > COMMAND ARGUMENT1 ARGUMENT2 ARGUMENT3
< / code > < / pre > < / div >
< p > where < code > COMMAND< / code > can be:< / p >
< ol >
< li > < code > disable-module< / code > : disables the module with name < code > ARGUMENT1< / code > < / li >
< li > < code > enable-module< / code > : explicitly enables the module with name < code > ARGUMENT1< / code > < / li >
< li > < code > set-option-for-module< / code > : sets the value for option < code > ARGUMENT2< / code > to < code > ARGUMENT3< / code > inside module < code > ARGUMENT1< / code > < / li >
< li > < code > set-option-for-controller< / code > : set the value of option < code > ARGUMENT1< / code > to < code > ARGUMENT2< / code > for the controller worker< / li >
< li > < code > set-option-for-proxy< / code > : set the value of option < code > ARGUMENT1< / code > to < code > ARGUMENT2< / code > for the proxy worker< / li >
< li > < code > set-common-option< / code > : set the option < code > ARGUMENT1< / code > that < a href = "https://rspamd.com/doc/configuration/options.html" > defines basic Rspamd behaviour< / a > to value < code > ARGUMENT2< / code > < / li >
< li > < code > add-line< / code > : this will add the complete line after < code > ARGUMENT1< / code > (with all characters) to the file < code > /etc/rspamd/override.d/< ARGUMENT1> < / code > < / li >
< / ol >
< div class = "admonition note" >
< p class = "admonition-title" > File Names & Extensions< / p >
< p > For command 1 - 3, we append the < code > .conf< / code > suffix to the module name to get the correct file name automatically. For commands 4 - 6, the file name is fixed (you don't even need to provide it). For command 7, you will need to provide the whole file name (including the suffix) yourself!< / p >
< / div >
< p > You can also have comments (the line starts with < code > #< / code > ) and blank lines in < code > rspamd-modules.conf< / code > - they are properly handled and not evaluated.< / p >
< div class = "admonition tip" >
< p class = "admonition-title" > Adjusting Modules This Way< / p >
< p > These simple commands are meant to give users the ability to < em > easily< / em > alter modules and their options. As a consequence, they are not powerful enough to enable multi-line adjustments. If you need to do something more complex, we advise to do that < a href = "#manually" > manually< / a > !< / p >
2023-02-10 23:24:41 +00:00
< / div >
2023-01-25 09:29:36 +00:00
< / article >
< / div >
< / div >
< a href = "#" class = "md-top md-icon" data-md-component = "top" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z" / > < / svg >
Back to top
< / a >
< / main >
< footer class = "md-footer" >
< nav class = "md-footer__inner md-grid" aria-label = "Footer" >
< a href = "../mail_crypt/" class = "md-footer__link md-footer__link--prev" aria-label = "Previous: Mail Encryption" rel = "prev" >
< div class = "md-footer__button md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" / > < / svg >
< / div >
< div class = "md-footer__title" >
< div class = "md-ellipsis" >
< span class = "md-footer__direction" >
Previous
< / span >
Mail Encryption
< / div >
< / div >
< / a >
< a href = "../../troubleshooting/debugging/" class = "md-footer__link md-footer__link--next" aria-label = "Next: Debugging" rel = "next" >
< div class = "md-footer__title" >
< div class = "md-ellipsis" >
< span class = "md-footer__direction" >
Next
< / span >
Debugging
< / div >
< / div >
< div class = "md-footer__button md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z" / > < / svg >
< / div >
< / a >
< / nav >
< div class = "md-footer-meta md-typeset" >
< div class = "md-footer-meta__inner md-grid" >
< div class = "md-copyright" >
< div class = "md-copyright__highlight" >
< p > & copy < a href = "https://github.com/docker-mailserver" > < em > Docker Mailserver Organization< / em > < / a > < br / > < span > This project is licensed under the MIT license.< / span > < / p >
< / div >
Made with
< a href = "https://squidfunk.github.io/mkdocs-material/" target = "_blank" rel = "noopener" >
Material for MkDocs
< / a >
< / div >
< / div >
< / div >
< / footer >
< / div >
< div class = "md-dialog" data-md-component = "dialog" >
< div class = "md-dialog__inner md-typeset" > < / div >
< / div >
< script id = "__config" type = "application/json" > { "base" : "../../.." , "features" : [ "navigation.tabs" , "navigation.top" , "navigation.expand" , "navigation.instant" , "content.code.annotate" ] , "search" : "../../../assets/javascripts/workers/search.b97dbffb.min.js" , "translations" : { "clipboard.copied" : "Copied to clipboard" , "clipboard.copy" : "Copy to clipboard" , "search.config.lang" : "en" , "search.config.pipeline" : "trimmer, stopWordFilter" , "search.config.separator" : "[\\s\\-]+" , "search.placeholder" : "Search" , "search.result.more.one" : "1 more on this page" , "search.result.more.other" : "# more on this page" , "search.result.none" : "No matching documents" , "search.result.one" : "1 matching document" , "search.result.other" : "# matching documents" , "search.result.placeholder" : "Type to start searching" , "search.result.term.missing" : "Missing" , "select.version.title" : "Select version" } , "version" : { "provider" : "mike" } } < / script >
< script src = "../../../assets/javascripts/bundle.6c7ad80a.min.js" > < / script >
< / body >
< / html >
