blob: 22bcf4d9188b02ac14bc90ca62aaf899bd886431 (
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
.TH "RSPAMADM" "1" "" "Rspamd User Manual" ""
.SH NAME
.PP
rspamadm \- rspamd administration utility
.SH SYNOPSIS
.PP
rspamadm [\f[I]global_options\f[]] [\f[I]command\f[]]
[\f[I]command_options\f[]]...
.PP
rspamadm \-l
.PP
rspamadm help
.PP
rspamadm help
.PP
rspamadm \-\-help
.SH DESCRIPTION
.PP
\f[C]rspamadm\f[] 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
.IP
.nf
\f[C]
rspamadm\ \-l
\f[]
.fi
.SH OPTIONS
.TP
.B \-h, \-\-help
Show help message
.RS
.RE
.TP
.B \-v, \-\-verbose
Enable verbose output
.RS
.RE
.TP
.B \-l, \-\-list\-commands
List available commands
.RS
.RE
.TP
.B \-\-version
Show version
.RS
.RE
.TP
.B \-\-var=\f[I]value\f[]
Redefine ucl variable in format \f[C]VARIABLE=VALUE\f[]
.RS
.RE
.SH RETURN VALUE
.PP
On exit \f[C]rspamadm\f[] returns \f[C]0\f[] if operation was
successfull and an error code otherwise.
.SH EXAMPLES
.PP
Get help for pw command:
.IP
.nf
\f[C]
rspamadm\ help\ pw
rspamadm\ pw\ \-\-help
\f[]
.fi
.PP
Encrypt controller\[aq]s password:
.IP
.nf
\f[C]
rspamadm\ pw\ encrypt
\f[]
.fi
.PP
Merge fuzzy databases:
.IP
.nf
\f[C]
rspamadm\ fuzzy_merge\ \-s\ data1.sqlite\ \-s\ data2.sqlite\ \-t\ dest.sqlite
\f[]
.fi
.PP
Perform configuration test:
.IP
.nf
\f[C]
rspamadm\ configtest\ \-c\ rspamd.conf
\f[]
.fi
.PP
Test configuration strictly and redefine some ucl vars:
.IP
.nf
\f[C]
rspamadm\ \-\-var=DBDIR=/tmp\ configtest\ \-c\ ./rspamd.conf\ \-s
\f[]
.fi
.PP
Dump the processed configuration:
.IP
.nf
\f[C]
rspamadm\ configdump
\f[]
.fi
.PP
Dump the processed configuration as JSON string:
.IP
.nf
\f[C]
rspamadm\ configdump\ \-j
\f[]
.fi
.PP
Generate a keypair to use for HTTPCrypt encryption:
.IP
.nf
\f[C]
rspamadm\ keypair
\f[]
.fi
.SH SEE ALSO
.PP
Rspamd documentation and source codes may be downloaded from
<https://rspamd.com/>.
|
