Rspamd Documentation

Installation and Administration

Here are the main introduction documents that are recommended for reading if you are going to use Rspamd in your mail system.

• Quick start - learn how to install, setup and perform initial configuring of Rspamd
• MTA integration - describes how to integrate Rspamd into your mail infrastructure
• Upgrading - the list of incompatible changes between versions of Rspamd
• Frequently asked questions - common questions about Rspamd and Rmilter
• Migrating from SA - the guide for those who want to migrate an existing SpamAssassin system to Rspamd

Reference guide

This section contains documents about various configuration details.

• Configuration structure explains the basic principles of Rspamd configuration files
  • Users settings description could be useful if you need to setup per-user configuration or want to process mail in different ways, for example, for inbound and outbound messages.
  • Top-level options are used to set the global options for Rspamd, such as DNS resolver setup and so on
  • Logging setup is required if you need customized logging
  • Metrics, actions and symbols are very important as they allow to set custom rules scores and thresholds for different actions
  • Composite symbols are useful to combine rules into meta-rules
  • Statistical module describes the Bayes classifier and its backends
• Modules documentation gives the detailed description of each Rspamd module
• Workers documentation contains information about different Rspamd worker processes: scanners, controller, fuzzy storage and so on
• Redis configuration page describes how to configure Redis cache for Rspamd
• Redis replication is a step-by-step guide on establishing Bayesian statistics and fuzzy storage replication
• Rspamadm - describes utilities contained in the rspamadm command
• Stunnel setup is a step-by-step guide to secure communications between Redis instances with stunnel
• Upstreams article depicts how Rspamd connects to external servers (e.g. Redis or DNS)
• Getting feedback from users with IMAPSieve - how to get a copy of the message moved by user from or into the Junk folder

Developers documentation

This section contains details about Rspamd internals, documents about writing new rules for Rspamd and, in particular, Rspamd Lua API.

• Writing Rspamd rules is a step-by-step guide that describes how to write rules for Rspamd
• Lua API reference provides the extensive information about all Lua modules available in Rspamd
• Creating your fuzzy storage provides information about how to make your own hashes storage and how to learn it efficiently
• Architecture information provides an overview of the Rspamd internal structure
• Protocol documentation describes Rspamd protocol which is used to communicate with external tools, such as Rmilter or rspamc client utility
• Contributing to rspamd.com web-site describes general conventions and how to test web-site changes

External resources

• Training Rspamd with Dovecot antispam plugin, part 1¹ - this tutorial describes how to train Rspamd automatically using the antispam plugin of the Dovecot IMAP server
• Training Rspamd with Dovecot antispam plugin, part 2¹ - continuation of the previous tutorial

1. antispam plugin is deprecated, use IMAPSieve instead