summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVsevolod Stakhov <vsevolod@highsecure.ru>2014-09-11 13:02:01 +0100
committerVsevolod Stakhov <vsevolod@highsecure.ru>2014-09-11 13:02:01 +0100
commit4adaf7e4b270b0dd0c891b630bfda5442ca09874 (patch)
tree9e2d2d48e00636b648883f744a67421de62bdc70
parent57c3dd72006a31a1aa0707e68bda09b6294a60bc (diff)
downloadrspamd-4adaf7e4b270b0dd0c891b630bfda5442ca09874.tar.gz
rspamd-4adaf7e4b270b0dd0c891b630bfda5442ca09874.zip
Update migration document.
-rw-r--r--doc/markdown/index.md3
-rw-r--r--doc/markdown/migration.md17
2 files changed, 18 insertions, 2 deletions
diff --git a/doc/markdown/index.md b/doc/markdown/index.md
index 181dc956e..cab8c85e0 100644
--- a/doc/markdown/index.md
+++ b/doc/markdown/index.md
@@ -19,4 +19,5 @@ parts:
- [Rspamd configuration](configuration/) describes principles of rspamd configuration
- [Modules](modules/) chapter lists rspamd modules and defines their configuration attributes
- [Workers](workers/) section describes workers that are implemented in the rspamd
-- [Lua API](lua/) explains how to extend rspamd with own lua modules \ No newline at end of file
+- [Lua API](lua/) explains how to extend rspamd with own lua modules
+- [Migration](migration.md) section contains the list of incompatible changes between rspamd versions and recommendations of how to update your rspamd system. \ No newline at end of file
diff --git a/doc/markdown/migration.md b/doc/markdown/migration.md
index 954c60f6d..c6d1625a8 100644
--- a/doc/markdown/migration.md
+++ b/doc/markdown/migration.md
@@ -34,6 +34,14 @@ worker {
}
~~~
+### Settings changes
+
+Settings system has been completely reworked. It is now a lua plugin that
+registers pre-filter and assign settings according to some dynamic map or
+a static configuration. Should you want to use the new settings system then
+please check the recent [documentation](https://rspamd.com/doc/configuration/settings.html).
+The old settings have been completely removed from rspamd.
+
### Lua changes
There are many changes in lua API and some of them are unfortunately breaking ones.
@@ -153,4 +161,11 @@ if smtp_from then
task:insert_result(symbol_sender, 1)
end
end
-~~~ \ No newline at end of file
+~~~
+
+### Protocol changes
+
+Rspamd now uses `HTTP` protocols for all operations, therefore an additional
+client library is unlikely needed. The fallback to old `spamc` protocol has also
+been implemented automatically to be compatible with `rmilter` and other software
+that uses `rspamc` protocol. \ No newline at end of file