diff options
author | Vsevolod Stakhov <vsevolod@highsecure.ru> | 2015-12-31 17:38:02 +0000 |
---|---|---|
committer | Vsevolod Stakhov <vsevolod@highsecure.ru> | 2015-12-31 17:38:02 +0000 |
commit | 2375dba898b481837879940dfdcf3ea85248fe01 (patch) | |
tree | cced5fb680e9a362d1de25630bff537865d38365 /interface/README.md | |
parent | 1543c98d38ffb84a1e405081436d0a25bee713a6 (diff) | |
download | rspamd-2375dba898b481837879940dfdcf3ea85248fe01.tar.gz rspamd-2375dba898b481837879940dfdcf3ea85248fe01.zip |
Remove bloody submodules.
Diffstat (limited to 'interface/README.md')
-rw-r--r-- | interface/README.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/interface/README.md b/interface/README.md new file mode 100644 index 000000000..0507301bc --- /dev/null +++ b/interface/README.md @@ -0,0 +1,50 @@ +#Rspamd web interface + +##Overview. + +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"> + +##Rspamd setup. + +It is required to configure dynamic settings to store configured values. +Basically this can be done by providing the following line in options settings: + +~~~nginx +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: + +~~~nginx +worker { + type = "controller"; + bind_socket = "localhost:11334"; + count = 1; + # Password for normal commands + password = "q1"; + # Password for privilleged commands + enable_password = "q2"; + # 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`). + +##Interface setup. + +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. + +##Contact information. + +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) |