diff options
Diffstat (limited to 'doc/markdown/index.md')
| -rw-r--r-- | doc/markdown/index.md | 49 |
1 files changed, 37 insertions, 12 deletions
diff --git a/doc/markdown/index.md b/doc/markdown/index.md index 1a74b7e7e..68955f8e3 100644 --- a/doc/markdown/index.md +++ b/doc/markdown/index.md @@ -1,16 +1,41 @@ -# Rspamd documentation project +# Rspamd documentation -## Introduction -Rspamd is a fast and advanced spam filtering system. It is based on an event-driven processing model which allows it to work with multiple messages simultaneously without blocking anywhere during message processing. Rspamd contains various modules shipped in the default distribution and allows extension with custom modules and rules written in [Lua](http://lua.org). +## Tutorials and introduction documents -Rspamd uses a complex estimation system based on a set of rules. Each of these rules has its own score and the final score of a message is defined as the sum of the scores that were true for that message. This approach is similar to other complex spam filtering systems, such as [SpamAssassin](http://spamassassin.apache.org). Rspamd also implements fuzzy logic, including fuzzy hashes and a statistics module, to process messages. +Here are the main introduction documents that are recommended for reading if you are going to use Rspamd in your mail system. -## Table of Contents +* **[Quick Start](quick_start.md)** - learn how to install, setup and perform initial configuring of Rspamd +* **[Upgrading](migration.md)** - the list of incompatible changes between versions of Rspamd +* **[Frequently asked questions](faq.md)** - common questions about Rspamd and Rmilter +* **[Migrating from SA](migrate_sa.md)** - the guide for those who wants to migrate an existing SpamAssassin system to Rspamd +* **[MTA integration](integration.md)** document describes how to integrate Rspamd into your mail infrastructure +* **[Creating your fuzzy storage](http://rspamd.com/doc/fuzzy_storage.html)** document provides information about how to make your own hashes storage and how to learn it efficiently -- [Tutorials](tutorials/) a collection of tutorial-like documents for rspamd -- [Architecture](architecture/) presents the architecture of rspamd and explains how spam filtering is performed -- [Rspamd configuration](configuration/) describes the principles of rspamd configuration -- [Modules](modules/) lists rspamd modules and defines their configuration attributes -- [Workers](workers/) describes worker processes that are implemented in rspamd -- [Lua API](lua/) explains how to extend rspamd with lua modules -- [Migration](migration.md) contains the list of incompatible changes between rspamd versions and recommendations on how to update your rspamd system +### Rspamd and Dovecot Antispam integration + +* [Training Rspamd with dovecot antispam plugin, part 1](https://kaworu.ch/blog/2014/03/25/dovecot-antispam-with-Rspamd/) - this tutorial describes how to train Rspamd automatically using the `antispam` pluging of the `dovecot` IMAP server +* [Training Rspamd with dovecot antispam plugin, part 2](https://kaworu.ch/blog/2015/10/12/dovecot-antispam-with-Rspamd-part2/) - continuation of the previous tutorial + +## Configuration + +This section contains documents about various configuration details. + +* **[General information](./configuration/index.md)** explains basic principles of Rspamd configuration +* **[Modules documentation](./modules/)** gives a detailed description of each Rspamd module +* **[Workers documentation](./workers/)** contains information about different Rspamd worker processes: scanners, controller, fuzzy storage and so on +* **[Users settings description](./configuration/settings.md)** could be useful if you need to setup per-user configuration or want process mail in different ways, for example, for inbound and outbound messages. + +## Architecture + +These documents are useful if you need to know details about Rspamd internals. + +* **[General information](./architecture/index.md)** provides an overview of the Rspamd architecture +* **[Protocol documentation](./architecture/protocol.md)** describes Rspamd protocol which is used to communicate with external tools, such as Rmilter or `rspamc` client utility + + +## Extending Rspamd + +This section contains documents about writing new rules for Rspamd and, in particular, Rspamd Lua API. + +* **[Writing Rspamd rules](./tutorials/writing_rules.md)** is a step-by-step guide that describes how to write rules for Rspamd +* **[LUA API reference](./lua/)** provides the extensive information about all LUA modules available in Rspamd |