blob: 17bfa94c306b277009b4e3fd3cff2132026a9077 (
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
% RSPAMADM(1) Rspamd User Manual
# NAME
rspamadm - rspamd administration utility
# SYNOPSIS
rspamadm [*global_options*] [*command*] [*command_options*]...
rspamadm -l
rspamadm help
rspamadm help <command>
rspamadm --help
# DESCRIPTION
`rspamadm` is a routine to manage rspamd spam filtering system. It is intended to perform
such actions as merging databases, performing configuration tests, encrypting passwords,
signing configurations and so on. You can get a list of available commands by running
rspamadm -l
# OPTIONS
-h, \--help
: Show help message
-v, \--verbose
: Enable verbose output
-l, \--list-commands
: List available commands
\--version
: Show version
\--var=*value*
: Redefine ucl variable in format `VARIABLE=VALUE`
# RETURN VALUE
On exit `rspamadm` returns `0` if operation was successfull and an error code otherwise.
# EXAMPLES
Get help for pw command:
rspamadm help pw
rspamadm pw --help
Encrypt controller's password:
rspamadm pw encrypt
Merge fuzzy databases:
rspamadm fuzzy_merge -s data1.sqlite -s data2.sqlite -t dest.sqlite
Perform configuration test:
rspamadm configtest -c rspamd.conf
Test configuration strictly and redefine some ucl vars:
rspamadm --var=DBDIR=/tmp configtest -c ./rspamd.conf -s
Dump the processed configuration:
rspamadm configdump
Dump the processed configuration as JSON string:
rspamadm configdump -j
Generate a keypair to use for HTTPCrypt encryption:
rspamadm keypair
# SEE ALSO
Rspamd documentation and source codes may be downloaded from
<https://rspamd.com/>.
|
