Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add info about settings_id in worker-proxy docs #788

Merged
merged 5 commits into from
Oct 26, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/workers/rspamd_proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ upstream "scan" {
hosts = "round-robin:host1:11333:10,host2:11333:10,host3:11333:5,host4:11333:5";
key = "..."; # Public key for encryption, generated by rspamadm keypair (optional)
compression = yes; # Use zstd compression (optional)
settings_id = "name"; # Apply a custom setting from the user settings module (optional)
}
~~~

Expand Down Expand Up @@ -128,6 +129,10 @@ mirror "test" {
}
~~~

### User settings

The proxy worker can apply a specific setting using the `settings_id` configured in an upstream through the [user settings module]({{ site.baseurl }}/doc/configuration/settings.html). Ensure that the user settings module includes a setting with the same name as defined in `settings_id`.

### Compare scripts

Comparison scripts are designed for executing straightforward actions with the results obtained from a mirror and the main cluster machine. These scripts do not support asynchronous requests, so your options are limited to logging or writing to files. Below is a basic example of such a script in the configuration:
Expand Down