]> git.ipfire.org Git - thirdparty/rspamd.git/commitdiff
Update SA plugin documentation
authorVsevolod Stakhov <vsevolod@highsecure.ru>
Mon, 21 Dec 2015 09:09:22 +0000 (09:09 +0000)
committerVsevolod Stakhov <vsevolod@highsecure.ru>
Mon, 21 Dec 2015 09:09:22 +0000 (09:09 +0000)
doc/markdown/modules/spamassassin.md

index 7cc7693f87a28191f9ae9868526bbf47464a838a..f41af3141ad8a29bfb4d65869e38dd4a7c3ef8dd 100644 (file)
@@ -15,6 +15,8 @@ spamassassin {
        ruleset = "/path/to/file";
        # Limit search size to 100 kilobytes for all regular expressions
        match_limit = 100k;
+       # Those regexp atoms will not be passed through hyperscan:
+       pcre_only = ["RULE1", "__RULE2"];
 }
 ~~~
 
@@ -42,9 +44,13 @@ Currently, rspamd supports the following functions:
 * some header functions, such as `exists`
 * some eval functions
 * some plugins:
-    - Mail::SpamAssassin::Plugin::FreeMail
-    - Mail::SpamAssassin::Plugin::HeaderEval
-    - Mail::SpamAssassin::Plugin::ReplaceTags
+    + 'Mail::SpamAssassin::Plugin::FreeMail',
+    + 'Mail::SpamAssassin::Plugin::HeaderEval',
+    + 'Mail::SpamAssassin::Plugin::ReplaceTags',
+    + 'Mail::SpamAssassin::Plugin::RelayEval',
+    + 'Mail::SpamAssassin::Plugin::MIMEEval',
+    + 'Mail::SpamAssassin::Plugin::BodyEval',
+    + 'Mail::SpamAssassin::Plugin::MIMEHeader'
 
 Rspamd does **not** support network plugins, HTML plugins and some other plugins.
 This is planned for the next releases of rspamd.
@@ -57,9 +63,10 @@ of inefficient regular expressions that scan large text bodies. However, the opt
 performed by rspamd can significantly reduce the amount of work required to process
 SA rules. Moreover, if your PCRE library is built with JIT support, rspamd can benefit
 from this by a significant grade. On start, rspamd tells if it can use JIT compilation and
-warns if it cannot.
+warns if it cannot. Some regular expressions might also benefit from `hyperscan` support
+that is available on x86_64 platforms starting from rspamd 1.1.
 
 Spamassassin plugin is written in lua with many functional elements. Hence, to speed
 it up you might want to build rspamd with [luajit](http://luajit.org) that performs
 blazingly fast and is almost as fast as plain C. Luajit is enabled by default since
-rspamd 0.9.
\ No newline at end of file
+rspamd 0.9.