RSPAMADM(1) RSPAMADM(1)

# [NAME](#NAME)

rspamadm - rspamd administration utility

# [SYNOPSIS](#SYNOPSIS)

rspamadm \[*global\_options*] \[*command*] \[*command\_options*]...

# [DESCRIPTION](#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
    
```

Also for each command you can check list of available **command\_options** by running

```
rspamadm help command
rspamadm command --help
    
```

# [OPTIONS](#OPTIONS)

[-h, --help](#h,)

Show help message

[-v, --verbose](#v,)

Enable verbose output

[-l, --list-commands](#l,)

List available commands

[--version](#version)

Show version

[--var=*value*](#var=)

Redefine ucl variable in format VARIABLE=VALUE

# [RETURN VALUE](#RETURN_VALUE)

On exit rspamadm returns 0 if operation was successful and an error code otherwise.

# [EXAMPLES](#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](#SEE_ALSO)

Rspamd documentation and source codes may be downloaded from [https://rspamd.com/](https://rspamd.com/).

Rspamd User Manual

---

Document: rspamadm(1) from rspamd 4.2.2-r0 (Chainguard OS)
Source: https://github.com/rspamd/rspamd