.\" Automatically generated by Pandoc 3.1.11.1
.\"
.TH "RSPAMADM" "1" "" "Rspamd User Manual" ""
.SH NAME
rspamadm \- rspamd administration utility
.SH SYNOPSIS
rspamadm [\f[I]global_options\f[R]] [\f[I]command\f[R]]
[\f[I]command_options\f[R]]\&...
.SH DESCRIPTION
\f[CR]rspamadm\f[R] 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 \f[B]commands\f[R] by running
.IP
.EX
rspamadm \-l
.EE
.PP
Also for each command you can check list of available
\f[B]command_options\f[R] by running
.IP
.EX
rspamadm help command
rspamadm command \-\-help
.EE
.SH OPTIONS
.TP
\-h, \-\-help
Show help message
.TP
\-v, \-\-verbose
Enable verbose output
.TP
\-l, \-\-list\-commands
List available commands
.TP
\-\-version
Show version
.TP
\-\-var=\f[I]value\f[R]
Redefine ucl variable in format \f[CR]VARIABLE=VALUE\f[R]
.SH RETURN VALUE
On exit \f[CR]rspamadm\f[R] returns \f[CR]0\f[R] if operation was
successful and an error code otherwise.
.SH EXAMPLES
Get help for pw command:
.IP
.EX
rspamadm help pw
rspamadm pw \-\-help
.EE
.PP
Encrypt controller\[cq]s password:
.IP
.EX
rspamadm pw encrypt
.EE
.PP
Merge fuzzy databases:
.IP
.EX
rspamadm fuzzy_merge \-s data1.sqlite \-s data2.sqlite \-t dest.sqlite
.EE
.PP
Perform configuration test:
.IP
.EX
rspamadm configtest \-c rspamd.conf
.EE
.PP
Test configuration strictly and redefine some ucl vars:
.IP
.EX
rspamadm \-\-var=DBDIR=/tmp configtest \-c ./rspamd.conf \-s
.EE
.PP
Dump the processed configuration:
.IP
.EX
rspamadm configdump
.EE
.PP
Dump the processed configuration as JSON string:
.IP
.EX
rspamadm configdump \-j
.EE
.PP
Generate a keypair to use for HTTPCrypt encryption:
.IP
.EX
rspamadm keypair
.EE
.SH SEE ALSO
Rspamd documentation and source codes may be downloaded from \c
.UR https://rspamd.com/
.UE \c
\&.