RSPAMADM(1)

πŸ“¦
version 4.2.3 Β· 2 versions
, in alpine 3.24, arch rolling, debian trixie, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0, ubuntu stonking

πŸ‘‘ RSPAMADM(1) β€” rspamadm, the rspamd admin bestie

okay so bestie, welcome to the manual page for rspamadm, living in section 1 of the Rspamd User Manual ✨ this is your little backstage pass to running the whole rspamd spam filtering system, and honestly? she does it all πŸ’…


🌸 NAME

rspamadm β€” rspamd administration utility


πŸ¦‹ SYNOPSIS

rspamadm [global_options] [command] [command_options]...

πŸ’– DESCRIPTION

rspamadm is the routine you use to manage the rspamd spam filtering system. Think of her as the friend who handles all the little tasks so you don't have to 🫢 She's here to do stuff like merging databases, running configuration tests, encrypting passwords, signing configurations, and so on, and so on. the list goes on fr fr.

Wanna see every command she's got? run this:

rspamadm -l

And for each individual command, you can peek at the command_options it takes by running either of these:

rspamadm help command
rspamadm command --help

both work, pick your fighter πŸ’–


✨ OPTIONS ✨

  • -h, --help β€” show the help message, the classic
  • -v, --verbose β€” enable verbose output, aka she tells you everything πŸ’€
  • -l, --list-commands β€” list every available command
  • --version β€” show the version
  • --var=value β€” redefine a ucl variable, in the format VARIABLE=VALUE

πŸŽ€ RETURN VALUE

When she exits, rspamadm returns 0 if the operation was successful, and an error code otherwise. no in-between, she's very clear about it 😌


🌈 EXAMPLES

Get help for the pw command:

rspamadm help pw
rspamadm pw --help

Encrypt the controller’s password:

rspamadm pw encrypt

Merge fuzzy databases:

rspamadm fuzzy_merge -s data1.sqlite -s data2.sqlite -t dest.sqlite

Perform a configuration test:

rspamadm configtest -c rspamd.conf

Test the 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 a 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/ β€” go, run, be free 🧚


okay that's the whole page bestie πŸ’œ that was RSPAMADM(1) from the Rspamd User Manual, and yes she ate, no cap πŸ‘‘ go merge some databases and slay πŸ’…

πŸ“¦ where this page comes from