1"use strict";(self.webpackChunkrspamd_docs=self.webpackChunkrspamd_docs||[]).push([[780],{28453:(e,s,t)=>{t.d(s,{R:()=>a,x:()=>o});var n=t(96540);const r={},i=n.createContext(r);function a(e){const s=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),n.createElement(i.Provider,{value:s},e.children)}},47158:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>n,toc:()=>l});const n=JSON.parse('{"id":"about/index","title":"Overview","description":"Introduction","source":"@site/docs/about/index.md","sourceDirName":"about","slug":"/about/","permalink":"/about/","draft":false,"unlisted":false,"editUrl":"https://github.com/rspamd/docs.rspamd.com/edit/master/docs/about/index.md","tags":[],"version":"current","frontMatter":{"title":"Overview"}}');var r=t(74848),i=t(28453);const a={title:"Overview"},o="Overview",d={},l=[{value:"Introduction",id:"introduction",level:2},{value:"Getting Started",id:"getting-started",level:2},{value:"Spam filtering features",id:"spam-filtering-features",level:2},{value:"License",id:"license",level:2}];function c(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"overview",children:"Overview"})}),"\n",(0,r.jsx)(s.h2,{id:"introduction",children:"Introduction"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Rspamd"})," is an advanced spam filtering system that allows evaluation of messages by a number of\nrules including regular expressions, statistical analysis and custom services\nsuch as URL black lists. Each message is analysed by Rspamd and given a ",(0,r.jsx)(s.code,{children:"spam score"}),"."]}),"\n",(0,r.jsx)(s.p,{children:"According to this spam score and the user's settings, Rspamd recommends an action for\nthe MTA to apply to the message, for example, to pass, reject or add a header.\nRspamd is designed to process hundreds of messages per second simultaneously, and provides a number of\nuseful features."}),"\n",(0,r.jsx)(s.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,r.jsxs)(s.p,{children:["A good starting point to study how to install and configure Rspamd is ",(0,r.jsx)(s.a,{href:"/tutorials/quickstart",children:"the quick start guide"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["Rspamd is ",(0,r.jsx)(s.a,{href:"/downloads",children:"packaged"})," for the major Linux distributions, and is also available via ",(0,r.jsx)(s.a,{href:"https://freshports.org/mail/rspamd",children:"FreeBSD ports"}),", ",(0,r.jsx)(s.a,{href:"https://pkgsrc.org",children:"NetBSD pkgsrc"})," and ",(0,r.jsx)(s.a,{href:"https://openports.pl/path/mail/rspamd",children:"OpenBSD ports"}),"."]}),"\n",(0,r.jsx)(s.h2,{id:"spam-filtering-features",children:"Spam filtering features"}),"\n",(0,r.jsxs)(s.p,{children:["Rspamd is shipped with various spam filtering modules and features enabled just out of the box.\nThe full list of built-in modules could be found in the ",(0,r.jsx)(s.a,{href:"/modules/",children:"modules documentation"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If that is not enough, Rspamd provides an extensive ",(0,r.jsx)(s.a,{href:"/lua/",children:"Lua API"})," to ",(0,r.jsx)(s.a,{href:"/developers/writing_rules",children:"write your own rules and plugins"}),"."]}),"\n",(0,r.jsx)(s.h2,{id:"license",children:"License"}),"\n",(0,r.jsxs)(s.p,{children:["This project is licensed under the ",(0,r.jsx)(s.a,{href:"https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)",children:"Apache 2.0 License"})]})]})}function u(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.