summaryrefslogtreecommitdiffstats
path: root/doc/rspamd.8.md
blob: c7c811cf4ecc49fad0c64820046134e0dd4dfdba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
% RSPAMD(8) Rspamd User Manual

# NAME

rspamd - main daemon for rapid spam filtering system

# SYNOPSIS

rspamd [*options*]...

rspamd --help

# DESCRIPTION

Rspamd filtering system is designed to be fast, modular and easily scalable system. 
Rspamd core is written in `C` language using event driven processing model. 
Plugins for rspamd can be written in `Lua` programming language.
Rspamd is designed to process connections completely asynchronous and do not block anywhere in code.

# OPTIONS

-f, \--no-fork
:	Do not daemonize main process

-c *path*, \--config=*path*
:	Specify config file(s)

-u *username*, \--user=*username*
:	User to run rspamd as

-g *groupname*, \--group=*groupname*
:	Group to run rspamd as

-p *path*, \--pid=*path*
:	Path to pidfile

-i, \--insecure
:	Ignore running workers as privileged users (insecure)

# EXAMPLES

Run rspamd daemon with default configuration:

	rspamd
	
Run rspamd in foreground with custom configuration:

	rspamd -f -c ~/rspamd.conf
	
Run rspamd specifying user and group:

	rspamd -u rspamd -g rspamd -c /etc/rspamd/rspamd.conf

# SEE ALSO

Rspamd documentation and source codes may be downloaded from
<https://rspamd.com/>.