2015-09-28 17:45:01 +02:00
|
|
|
% RSPAMADM(1) Rspamd User Manual
|
|
|
|
|
|
|
|
# NAME
|
|
|
|
|
|
|
|
rspamadm - rspamd administration utility
|
|
|
|
|
|
|
|
# SYNOPSIS
|
|
|
|
|
|
|
|
rspamadm [*global_options*] [*command*] [*command_options*]...
|
|
|
|
|
|
|
|
# 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,
|
2016-06-17 11:40:52 +02:00
|
|
|
signing configurations and so on. You can get a list of available **commands** by running
|
2015-09-28 17:45:01 +02:00
|
|
|
|
|
|
|
rspamadm -l
|
|
|
|
|
2016-06-17 11:40:52 +02:00
|
|
|
Also for each command you can check list of available **command_options** by running
|
|
|
|
|
|
|
|
rspamadm help command
|
|
|
|
rspamadm command --help
|
|
|
|
|
|
|
|
|
2015-09-28 17:45:01 +02:00
|
|
|
# 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
|
|
|
|
|
2017-05-13 17:20:00 +02:00
|
|
|
On exit `rspamadm` returns `0` if operation was successful and an error code otherwise.
|
2015-09-28 17:45:01 +02:00
|
|
|
|
|
|
|
# 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
|
|
|
|
|
|
|
|
|
2015-10-05 13:40:12 +02:00
|
|
|
Dump the processed configuration:
|
|
|
|
|
|
|
|
rspamadm configdump
|
|
|
|
|
|
|
|
Dump the processed configuration as JSON string:
|
|
|
|
|
|
|
|
rspamadm configdump -j
|
|
|
|
|
2015-09-28 17:45:01 +02:00
|
|
|
Generate a keypair to use for HTTPCrypt encryption:
|
|
|
|
|
|
|
|
rspamadm keypair
|
|
|
|
|
|
|
|
# SEE ALSO
|
|
|
|
|
|
|
|
Rspamd documentation and source codes may be downloaded from
|
2017-05-13 17:20:00 +02:00
|
|
|
<https://rspamd.com/>.
|