diff options
author | Vsevolod Stakhov <vsevolod@highsecure.ru> | 2016-07-09 11:17:18 +0100 |
---|---|---|
committer | Vsevolod Stakhov <vsevolod@highsecure.ru> | 2016-07-09 11:17:18 +0100 |
commit | 14803e9faeefeee69e97902573f3e367ceaf9744 (patch) | |
tree | a2a27b8032f2e4c96d8801c1436ec25ab465c9e7 /doc/markdown/modules/index.md | |
parent | 2d2a741df6954e042ae2f5ce6c1a66c2d61acc11 (diff) | |
download | rspamd-14803e9faeefeee69e97902573f3e367ceaf9744.tar.gz rspamd-14803e9faeefeee69e97902573f3e367ceaf9744.zip |
[Doc] Documentation now lives in rspamd.com repo
Diffstat (limited to 'doc/markdown/modules/index.md')
-rw-r--r-- | doc/markdown/modules/index.md | 70 |
1 files changed, 0 insertions, 70 deletions
diff --git a/doc/markdown/modules/index.md b/doc/markdown/modules/index.md deleted file mode 100644 index afb440a8e..000000000 --- a/doc/markdown/modules/index.md +++ /dev/null @@ -1,70 +0,0 @@ -# Rspamd modules - -Rspamd ships with a set of modules. Some modules are written in C to speedup -complex procedures while others are written in lua to reduce code size. -Actually, new modules are encouraged to be written in lua and add the essential -support to the Lua API itself. Truly speaking, lua modules are very close to -C modules in terms of performance. However, lua modules can be written and loaded -dynamically. - -## C Modules - -C modules provides core functionality of rspamd and are actually statically linked -to the main rspamd code. C modules are defined in the `options` section of rspamd -configuration. If no `filters` attribute is defined then all modules are disabled. -The default configuration enables all modules explicitly: - -~~~ucl -filters = "chartable,dkim,spf,surbl,regexp,fuzzy_check"; -~~~ - -Here is the list of C modules available: - -- [regexp](regexp.md): the core module that allow to define regexp rules, -rspamd internal functions and lua rules. -- [surbl](surbl.md): this module extracts URLs from messages and check them against -public DNS black lists to filter messages with malicious URLs. -- [spf](spf.md): checks SPF records for messages processed. -- [dkim](dkim.md): performs DKIM signatures checks. -- [dmarc](dmarc.md): performs DKIM signatures checks. -- [fuzzy_check](fuzzy_check.md): checks messages fuzzy hashes against public blacklists. -- [chartable](chartable.md): checks character sets of text parts in messages. - -## Lua modules - -Lua modules are dynamically loaded on rspamd startup and are reloaded on rspamd -reconfiguration. Should you want to write a lua module consult with the -[Lua API documentation](../lua/). To define path to lua modules there is a special section -named `modules` in rspamd: - -~~~ucl -modules { - path = "/path/to/dir/"; - path = "/path/to/module.lua"; - path = "$PLUGINSDIR/lua"; -} -~~~ - -If a path is a directory then rspamd scans it for `*.lua" pattern and load all -files matched. - -Here is the list of Lua modules shipped with rspamd: - -- [multimap](multimap.md) - a complex module that operates with different types -of maps. -- [rbl](rbl.md) - a plugin that checks messages against DNS blacklist based on -either SMTP FROM addresses or on information from `Received` headers. -- [emails](emails.md) - extract emails from a message and checks it against DNS -blacklists. -- [maillist](maillist.md) - determines the common mailing list signatures in a message. -- [once_received](once_received.md) - detects messages with a single `Received` headers -and performs some additional checks for such messages. -- [phishing](phishing.md) - detects messages with phished URLs. -- [ratelimit](ratelimit.md) - implements leaked bucket algorithm for ratelimiting and -uses `redis` to store data. -- [trie](trie.md) - uses suffix trie for extra-fast patterns lookup in messages. -- [mime_types](mime_types.md) - applies some rules about mime types met in messages -- [rspamd_update](rspamd_update.md) - load dynamic rules and other rspamd updates -- [spamassassin](spamassassin.md) - load spamassassin rules -- [dmarc](dmarc.md) - performs DMARC policy checks -- [dcc](dcc.md) - performs [DCC](http://www.dcc-servers.net/dcc/) lookups to determine message bulkiness |