2018-03-03 02:32:04 +01:00
|
|
|
# Rspamd web interface
|
2015-12-31 18:38:02 +01:00
|
|
|
|
2018-03-05 06:44:30 +01:00
|
|
|
## Overview
|
2015-12-31 18:38:02 +01:00
|
|
|
|
|
|
|
This is a simple control interface for rspamd spam filtering system.
|
|
|
|
It provides basic functions for setting metric actions, scores,
|
|
|
|
viewing statistic and learning.
|
|
|
|
|
|
|
|
<img src="https://rspamd.com/img/webui.png" class="img-responsive" alt="Webui screenshot">
|
2021-01-22 17:44:55 +01:00
|
|
|
<img src="https://rspamd.com/img/webui_throughput.png" class="img-responsive" alt="Webui screenshot">
|
2015-12-31 18:38:02 +01:00
|
|
|
|
2018-03-05 06:44:30 +01:00
|
|
|
## Rspamd setup
|
2015-12-31 18:38:02 +01:00
|
|
|
|
|
|
|
It is required to configure dynamic settings to store configured values.
|
|
|
|
Basically this can be done by providing the following line in options settings:
|
|
|
|
|
2021-01-22 17:44:55 +01:00
|
|
|
~~~ucl
|
2015-12-31 18:38:02 +01:00
|
|
|
options {
|
|
|
|
dynamic_conf = "/var/lib/rspamd/rspamd_dynamic";
|
|
|
|
}
|
|
|
|
~~~
|
|
|
|
|
|
|
|
Please note that this path must have write access for rspamd user.
|
|
|
|
|
|
|
|
Then controller worker should be configured:
|
|
|
|
|
2021-01-22 17:44:55 +01:00
|
|
|
~~~ucl
|
2015-12-31 18:38:02 +01:00
|
|
|
worker {
|
|
|
|
type = "controller";
|
|
|
|
bind_socket = "localhost:11334";
|
|
|
|
count = 1;
|
2021-01-22 17:44:55 +01:00
|
|
|
# Password for normal commands (use rspamadm pw)
|
|
|
|
password = "$2$anydoddx67ggcs74owybhcwqsq3z67q4$udympbo8pfcfqkeiiuj7gegabk5jpt8edmhseujhar9ooyuzig5b";
|
2022-02-22 23:01:28 +01:00
|
|
|
# Password for privileged commands (use rspamadm pw)
|
2021-01-22 17:44:55 +01:00
|
|
|
enable_password = "$2$nx6sqkxtewx9c5s3hxjmabaxdcr46pk9$45qajkbyqx77abapiqugpjpsojj38zcqn7xnp3ekqyu674koux4b";
|
2015-12-31 18:38:02 +01:00
|
|
|
# Path to webiu static files
|
|
|
|
static_dir = "${WWWDIR}";
|
|
|
|
}
|
|
|
|
~~~
|
|
|
|
|
|
|
|
Password option should be changed for sure for your specific configuration. Encrypted password using is encouraged (`rspamadm pw --encrypt`).
|
|
|
|
|
2018-03-05 06:44:30 +01:00
|
|
|
## Interface setup
|
2015-12-31 18:38:02 +01:00
|
|
|
|
|
|
|
Interface itself is written in pure HTML5/js and, hence, it requires zero setup.
|
|
|
|
Just enter a password for webui access and you are ready.
|
|
|
|
|
2018-03-05 06:44:30 +01:00
|
|
|
## Contact information
|
2015-12-31 18:38:02 +01:00
|
|
|
|
|
|
|
Rspamd interface is distributed under the terms of [MIT license](http://opensource.org/licenses/MIT). For all questions related to this
|
|
|
|
product please see the [support page](https://rspamd.com/support.html)
|