Vsevolod Stakhov 53b7abaeab
Merge pull request #2635 from philfry/fix_preproc
1 day ago
.circleci Sync lua coverage with .drone.yml 3 weeks ago
.github [Minor] Update ussue template 3 months ago
centos [Fix] Fix endless loop when waiting for Rspamd to stop 3 months ago
clang-plugin Remove unused function 2 weeks ago
conf [Conf] Fix configuration sample for ratelimit 1 day ago
contrib [Fix] Do not allow syntax errors in include files... 1 week ago
debian [Minor] Redis support is now unconditional 4 months ago
doc [Minor] Update help/man pages 3 months ago
docker Retrieve GPG via keyserver in Dockerfile 8 months ago
freebsd Revert "Disable reload command in rc scripts" 2 years ago
interface [WebUI] Add history rows per page control 4 weeks ago
lualib [Minor] Add received tokens 3 days ago
rules [Minor] Make LEAKED_PASSWORD_SCAM rule more strict 1 week ago
src fix preprocessor syntax 1 day ago
test [Test] Remove broken tests 3 days ago
utils [Minor] Fix rspamd_stats so it passes Perl::Critic tests 1 month ago
.drone.yml Don't print summary line 6 days ago
.eslintrc.json [WebUI] Add history rows per page control 4 weeks ago
.gitignore [Minor] Reformat Perl scripts 1 month ago
.hgtags Added tag 0.6.7 for changeset f14508f80e52 4 years ago
.luacheckrc [Minor] Disable useless noisy warning 2 weeks ago
.tidyallrc [Minor] Reformat Pod documents 1 month ago
AUTHORS.md [Minor] Add authors and contributors document 1 month ago
CMakeLists.txt [Minor] Update version to 1.8.3 1 day ago
CONTRIBUTIONS.md Add notice in the contributions file 2 years ago
ChangeLog Release 1.8.2 1 day ago
FindArch.cmake Hyperscan is available for x86_64 only so far 2 years ago
FindRagel.cmake [Minor] Add a simple received parser benchmark routine 2 years ago
LICENSE.md [Minor] Proper license format 1 month ago
README.md Update README.md 1 month ago
config.h.in [Minor] Check for cached libevent time routines 1 month ago
dist.sh Use mktemp when available 3 years ago
package.json [Minor] Fix issues in lua http 4 weeks ago
rspamd.service [Minor] Require network-online target as well 8 months ago
uncrustify.cfg Add uncrustify source. 4 years ago
uncrustify.sh Add uncrustify source. 4 years ago

README.md

Rspamd

DroneCI

Introduction

Rspamd is an advanced spam filtering system that allows evaluation of messages by a number of rules including regular expressions, statistical analysis and custom services such as URL black lists. Each message is analysed by Rspamd and given a spam score.

According to this spam score and the user's settings, Rspamd recommends an action for the MTA to apply to the message, for example, to pass, reject or add a header. Rspamd is designed to process hundreds of messages per second simultaneously, and provides a number of useful features.

Getting Started

A good starting point to study how to install and configure Rspamd is the quick start guide.

Rspamd is packaged for the major Linux distributions, and is also available via FreeBSD ports, NetBSD pkgsrc and OpenBSD ports.

You can also watch some videos about Rspamd.

Spam filtering features

Rspamd is shipped with various spam filtering modules and features enabled just out of the box. The full list of built-in modules could be found in the Rspamd documentation.

If that is not enough, Rspamd provides an extensive Lua API to write your own rules and plugins: https://rspamd.com/doc/tutorials/writing_rules.html

Contributing

Please read CONTRIBUTIONS.md for details on the process for submitting pull requests to us.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details

References