|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| .github/ | H | 13-Dec-2021 | - | 119 | 81 |
| centos/ | H | 13-Dec-2021 | - | 481 | 390 |
| clang-plugin/ | H | 03-May-2022 | - | 933 | 754 |
| cmake/ | H | 13-Dec-2021 | - | 1,669 | 1,468 |
| conf/ | H | 13-Dec-2021 | - | 8,086 | 6,298 |
| contrib/ | H | 13-Dec-2021 | - | 205,774 | 153,227 |
| debian/ | H | 07-May-2022 | - | 709 | 569 |
| doc/ | H | 13-Dec-2021 | - | 1,722 | 1,385 |
| docker/ | H | 13-Dec-2021 | - | 67 | 58 |
| freebsd/ | H | 13-Dec-2021 | - | 143 | 91 |
| interface/ | H | 03-May-2022 | - | 1,841 | 1,743 |
| lualib/ | H | 13-Dec-2021 | - | 31,016 | 23,150 |
| rules/ | H | 13-Dec-2021 | - | 5,058 | 3,998 |
| src/ | H | 03-May-2022 | - | 243,357 | 184,254 |
| test/ | H | 07-May-2022 | - | 54,849 | 50,195 |
| utils/ | H | 03-May-2022 | - | 4,874 | 3,583 |
| .drone.yml | H A D | 13-Dec-2021 | 10.3 KiB | 282 | 264 |
| .eslintrc.json | H A D | 13-Dec-2021 | 2.6 KiB | 76 | 73 |
| .gitignore | H A D | 13-Dec-2021 | 316 | 27 | 26 |
| .luacheckrc | H A D | 13-Dec-2021 | 1.4 KiB | 78 | 66 |
| .stylelintrc.json | H A D | 13-Dec-2021 | 840 | 32 | 31 |
| .tidyallrc | H A D | 13-Dec-2021 | 515 | 23 | 16 |
| AUTHORS.md | H A D | 13-Dec-2021 | 733 | 31 | 18 |
| CONTRIBUTING.md | H A D | 13-Dec-2021 | 6.3 KiB | 103 | 68 |
| ChangeLog | H A D | 13-Dec-2021 | 285.8 KiB | 6,033 | 5,911 |
| LICENSE.md | H A D | 13-Dec-2021 | 9.1 KiB | 170 | 138 |
| README.md | H A D | 13-Dec-2021 | 2.9 KiB | 52 | 28 |
| blas-config.h.in | H A D | 13-Dec-2021 | 282 | 11 | 9 |
| config.h.in | H A D | 13-Dec-2021 | 11.3 KiB | 426 | 376 |
| dist.sh | H A D | 13-Dec-2021 | 828 | 30 | 16 |
| lua_style.md | H A D | 13-Dec-2021 | 13.8 KiB | 733 | 534 |
| package.json | H A D | 13-Dec-2021 | 274 | 14 | 13 |
| rspamd.service | H A D | 13-Dec-2021 | 386 | 18 | 15 |
| set-version.sh | H A D | 13-Dec-2021 | 480 | 15 | 11 |
| uncrustify.cfg | H A D | 13-Dec-2021 | 3.3 KiB | 135 | 134 |
| uncrustify.sh | H A D | 13-Dec-2021 | 395 | 12 | 9 |
README.md
1# <a href="https://rspamd.com"><img src="https://rspamd.com/img/rspamd_logo_black.png" alt="Rspamd" width="220px"/></a>
2
3[![DroneCI](https://ci.rspamd.com/api/badges/rspamd/rspamd/status.svg)](https://ci.rspamd.com/rspamd/rspamd)
4
5
6## Introduction
7
8[Rspamd](https://rspamd.com) is an advanced spam filtering system and email processing framework that allows evaluation of messages by a number of
9rules including regular expressions, statistical analysis and custom services
10such as URL black lists. Each message is analysed by Rspamd and given a verdict that might be used by MTA for further processing (e.g. to reject a message, or add a special header indicating spam) along with other information, such as possible DKIM signature or modifications suggested for a message.
11
12Rspamd can act as a [Milter](https://en.wikipedia.org/wiki/Milter) allowing direct interaction with popular MTA systems, such as Postfix or Sendmail.
13
14Rspamd is designed to process hundreds of messages per second simultaneously, and provides a number of
15useful features including a comprehensive [Lua API](https://rspamd.com/doc/lua/) that allows access to messages processing in various aspects as well as [asynchronous](https://rspamd.com/doc/lua/sync_async.html) network API to access external resources, such as DNS, HTTP or even generic TCP/UDP services.
16
17
18## Getting Started
19
20A good starting point to study how to install and configure Rspamd is [the quick start guide](https://rspamd.com/doc/quickstart.html).
21
22Rspamd 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).
23
24We advice to use packages provided by Rspamd project if available for your OS instead of packages that might be provided by some Linux distributives, as they are usually out of date and does not provide the desired spam filtering quality nor supported by Rspamd project.
25
26## Spam filtering features
27
28Rspamd is shipped with various spam filtering modules and features enabled just out of the box.
29The full list of built-in modules could be found in the [Rspamd documentation](https://rspamd.com/doc/modules/).
30
31If 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>
32
33## Contributing
34
35Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for submitting pull requests to us.
36
37## Authors
38
39* **Vsevolod Stakhov** - [vstakhov](https://github.com/vstakhov)
40
41See also the list of [contributors](AUTHORS.md) who participated in this project.
42
43## License
44
45This project is licensed under the Apache 2.0 License - see the [LICENSE.md](LICENSE.md) file for details
46
47## References
48
49* Home site: <https://rspamd.com>
50* Development: <https://github.com/rspamd/rspamd>
51* Site repository: <https://github.com/rspamd/rspamd.com>
52