rspamd/rspamd-docker

Rspamd as Docker image

Introduction

Rspamd is an advanced spam filtering system and email processing framework that allows evaluation of messages by a number of rules including regular expressions, statistical analysis and custom services such as URL black lists. Each message is analysed by Rspamd and given a verdict that might be used by MTA for further processing (e.g. to reject a message, or add a special header indicating spam) along with other information, such as possible DKIM signature or modifications suggested for a message.

Rspamd can act as a Milter allowing direct interaction with popular MTA systems, such as Postfix or Sendmail.

Rspamd is designed to process hundreds of messages per second simultaneously, and provides a number of useful features including a comprehensive Lua API that allows access to messages processing in various aspects as well as asynchronous network API to access external resources, such as DNS, HTTP or even generic TCP/UDP services.

Getting Started

A good starting point to study how to install and configure Rspamd is the quick start guide.

Rspamd is packaged for the major Linux distributions, and is also available via FreeBSD ports, NetBSD pkgsrc and OpenBSD ports.

We advice to use packages provided by Rspamd project if available for your OS instead of packages that might be provided by some Linux distributives, as they are usually out of date and does not provide the desired spam filtering quality nor supported by Rspamd project.

Spam filtering features

Rspamd is shipped with various spam filtering modules and features enabled just out of the box. The full list of built-in modules could be found in the Rspamd documentation.

If that is not enough, Rspamd provides an extensive Lua API to write your own rules and plugins: https://rspamd.com/doc/tutorials/writing_rules.html

License

This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in rspamd by you, as defined in the APACHE 2.0 license, shall be licensed as above, without any additional terms or conditions.

Authors

• Vsevolod Stakhov - vstakhov

See also the list of contributors who participated in this project.

References

• Home site: https://rspamd.com
• Development: https://github.com/rspamd/rspamd
• Site repository: https://github.com/rspamd/rspamd.com

rspamd-docker's Issues

Docker image is completely flat

Rather we should be layered on top of debian:bookworm-slim or whichever applicable base image. But we want to shed packages... RUN --mount=type=cache,from=... looks like a likely solution but CI is confirmed not ready for this (drone docker in docker version is 20.10).

Default password for controller and web interface

On my local after running

docker compose up

When i go to http://localhost:11334/
I am treated with a dialog box asking for a password. I am not able to find any default value of password either in docker files or any config files.
I also tried creating a worker-controller.inc file as per documentation in

config/rspamd/local.d

which then gets copied to

/etc/rspamd/local.d

in docker container

my worker-controller.inc

worker {
    type = "controller";
    password = "qwerty";
}

but this also didn't work

What is the default password and how can it be changed