diff options
author | Vsevolod Stakhov <vsevolod@highsecure.ru> | 2013-12-28 17:25:10 +0000 |
---|---|---|
committer | Vsevolod Stakhov <vsevolod@highsecure.ru> | 2013-12-28 17:25:10 +0000 |
commit | 52bebcde537a7b631cad2c32de7788ac0d3f862b (patch) | |
tree | a58710183d3cd520ebd9c9144d0b1cb1b2e7ac7e /doc | |
parent | e47c31784d02da27c838f554993369bc692f8a05 (diff) | |
download | rspamd-52bebcde537a7b631cad2c32de7788ac0d3f862b.tar.gz rspamd-52bebcde537a7b631cad2c32de7788ac0d3f862b.zip |
Add documentation skeleton.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/markdown/architecture/index.md | 0 | ||||
-rw-r--r-- | doc/markdown/configuration/index.md | 0 | ||||
-rw-r--r-- | doc/markdown/index.md | 22 | ||||
-rw-r--r-- | doc/markdown/lua/index.md | 0 | ||||
-rw-r--r-- | doc/markdown/modules/index.md | 0 | ||||
-rw-r--r-- | doc/markdown/workers/index.md | 0 |
6 files changed, 22 insertions, 0 deletions
diff --git a/doc/markdown/architecture/index.md b/doc/markdown/architecture/index.md new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/doc/markdown/architecture/index.md diff --git a/doc/markdown/configuration/index.md b/doc/markdown/configuration/index.md new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/doc/markdown/configuration/index.md diff --git a/doc/markdown/index.md b/doc/markdown/index.md new file mode 100644 index 000000000..27e889f4d --- /dev/null +++ b/doc/markdown/index.md @@ -0,0 +1,22 @@ +# Rspamd documentation project + +## Introduction +Rspamd is a fast and advanced spam filtering system. It is based on event-driven processing model +allowing to work with multiple messages simultaneously without blocking anywhere during messages +processing. Rspamd contains various modules shipped in the default distribution and permits to be +extended with the own custom modules and rules written in [Lua](http://lua.org) programming language. +Rspamd uses complex estimation system based on a set of rules, each of those rules has its own score and +the final score of a message is defined by a sum of rules' scores that were true for that message. This approach +is similar to other complex spam filtering systems, such as [SpamAssassin](http://spamassassin.apache.org). +At the same time, rspamd uses fuzzy logic to process unknown messages. That includes fuzzy hashes and +statistics module. + +## Table of Contents +This document contains the basic documentation for rspamd spam filtering system. It is divided into the following +parts: + +- [Architecture](/architecture/) presents the architecture of rspamd and how spam filtering is performed +- [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 diff --git a/doc/markdown/lua/index.md b/doc/markdown/lua/index.md new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/doc/markdown/lua/index.md diff --git a/doc/markdown/modules/index.md b/doc/markdown/modules/index.md new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/doc/markdown/modules/index.md diff --git a/doc/markdown/workers/index.md b/doc/markdown/workers/index.md new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/doc/markdown/workers/index.md |