2018-08-15 19:24:33 +02:00
[![CircleCI ](https://circleci.com/gh/rspamd/rspamd/tree/master.svg?style=svg )](https://circleci.com/gh/rspamd/rspamd/tree/master)
2013-08-08 16:30:03 +02:00
2014-10-26 19:07:20 +01:00
## Introduction
2016-06-28 18:45:28 +02:00
2015-10-30 22:14:21 +01:00
[Rspamd ](https://rspamd.com ) is an advanced spam filtering system that allows evaluation of messages by a number of
2014-10-26 19:07:20 +01:00
rules including regular expressions, statistical analysis and custom services
2017-10-06 14:06:46 +02:00
such as URL black lists. Each message is analysed by Rspamd and given a `spam score` .
2013-08-08 14:58:16 +02:00
2017-10-06 14:43:36 +02:00
According to this spam score and the user's settings, Rspamd recommends an action for
2016-08-07 15:22:25 +02:00
the MTA to apply to the message, for example, to pass, reject or add a header.
2017-12-17 08:53:25 +01:00
Rspamd is designed to process hundreds of messages per second simultaneously, and provides a number of
2017-10-26 16:59:46 +02:00
useful features.
2013-08-08 14:58:16 +02:00
2013-07-26 12:48:30 +02:00
2018-09-22 13:43:40 +02:00
## Getting Started
2013-07-26 12:48:30 +02:00
2018-09-22 13:43:40 +02:00
A good starting point to study how to install and configure Rspamd is [the quick start guide ](https://rspamd.com/doc/quickstart.html ).
2013-07-26 12:48:30 +02:00
2018-09-22 13:43:40 +02:00
Rspamd is [packaged ](https://rspamd.com/downloads.html ) for the major Linux distributions, and is also available via [FreeBSD ports ](https://freshports.org/mail/rspamd ), NetBSD [pkgsrc ](https://pkgsrc.org ) and [OpenBSD ports ](http://openports.se/mail/rspamd ).
2014-10-26 19:07:20 +01:00
2018-09-22 13:43:40 +02:00
You can also watch some [videos about Rspamd ](https://rspamd.com/media.html ).
2014-10-26 19:07:20 +01:00
2018-09-22 13:43:40 +02:00
## Spam filtering features
2014-10-26 19:07:20 +01:00
2018-09-22 13:43:40 +02:00
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 ](https://rspamd.com/doc/modules/ ).
2013-07-26 12:48:30 +02:00
2018-09-22 13:43:40 +02:00
If that is not enough, Rspamd provides an extensive [Lua API ](https://rspamd.com/doc/lua/ ) to write your own rules and plugins: < https: // rspamd . com / doc / tutorials / writing_rules . html >
2014-10-26 19:07:20 +01:00
2018-09-22 13:43:40 +02:00
## Contributing
2014-10-26 19:07:20 +01:00
2018-09-22 13:43:40 +02:00
Please read [CONTRIBUTIONS.md ](https://github.com/rspamd/rspamd/blob/master/CONTRIBUTIONS.md ) for details on the process for submitting pull requests to us.
2014-10-26 19:07:20 +01:00
2018-09-22 13:43:40 +02:00
## Authors
2013-07-26 12:48:30 +02:00
2018-09-22 13:43:40 +02:00
* **Vsevolod Stakhov** - [vstakhov ](https://github.com/vstakhov )
2013-07-26 12:48:30 +02:00
2018-09-22 13:43:40 +02:00
See also the list of [contributors ](https://github.com/rspamd/rspamd/AUTHORS.md ) who participated in this project.
2014-10-26 19:07:20 +01:00
2018-09-22 13:43:40 +02:00
## License
2014-10-26 19:07:20 +01:00
2018-09-22 13:43:40 +02:00
This project is licensed under the Apache 2.0 License - see the [LICENSE.md ](LICENSE.md ) file for details
2014-10-26 19:07:20 +01:00
## References
* Home site: < https: // rspamd . com >
2018-08-15 19:25:35 +02:00
* Development: < https: // github . com / rspamd / rspamd >
2018-09-22 14:21:20 +02:00
* Site repository: < https: // github . com / rspamd / rspamd . com >