Updates for doc/modules main page #506
Conversation
| Here are some guidelines regarding where module configurations are stored: | ||
|
|
||
| - The Rspamd-provided configuration files are in `$LOCAL_CONFDIR/modules.d`. | ||
| - Your overrides are set in `$LOCAL_CONFDIR/local.d` |
There was a problem hiding this comment.
Probably it is better to call that local additions instead of overrides as there are real overrides.
There was a problem hiding this comment.
Yes, will fix this and another reference on line 156. Thanks.
| - So defaults are usually in `/etc/rspamd/modules.d`, overrides in `/etc/rspamd/local.d` | ||
| - These $values may be changed at build time - the rules here apply for a default build | ||
| - To see the values of the environment variables that are actually being used by Rspamd at run-time, | ||
| Run `rspamadm lua` and enter `rspamd_paths` at the prompt. This returns a JSON object with values. Ctrl-C to exit. |
There was a problem hiding this comment.
Better Ctrl+D as Ctrl+C does not store history ;)
| - [clickhouse](clickhouse.html) - pushes scan-related information to clickhouse DBMS (requires configuration) | ||
| - [bayes_expiry](bayes_expiry.html) - provides expiration of statistical tokens (requires Redis and configuration) | ||
| - [clickhouse](clickhouse.html) - pushes scan-related information to the clickhouse DBMS (requires configuration) | ||
| - [bayes_expiry](bayes_expiry.html) - provides expiration of statistical tokens (requires Redis and configuration) * |
There was a problem hiding this comment.
The last * character looks like a misprint, isn't it?
There was a problem hiding this comment.
See line 67-69 about the asterisk. It looks like there is no bayes_expiry.conf file, and that might be the only Lua module that doesn't.
Would it be better to leave out "with a trailing asterisk" and then to be explicit that bayes_expiry requires the creation of a new bayes_expiry.config file?
Maybe that's an oversight in file system and you want to add an empty .config file?
Since we're in this area, we say "requires configuration" but I don't think there is any detail about what kind of configuration is required - it's left to the user to figure out each file and parameter. If that info is documented somewhere, I'll add a reference in here.
There was a problem hiding this comment.
Response posted in the code here (doesn't seem to be reflected in this pull thread).
There was a problem hiding this comment.
It doesn't require creation of a config file. Bayes expiry module configuration is a part of the classifier configuration. It is documented here.
An attempt has been made to update and clarify the lists of C and Lua modules. Please verify the accuracy of those informational changes.
In addition to the "Disabling module" section, new sections have been added: "Enabling a disabled module" and "Config file locations for modules". While this information exists elsewhere, explitly and inferred, I believe it is helpful to provide it in dedicated sections here on this main page.
Other changes like that are planned, where some information is repeated in places where the user is likely to be looking for that specific information. Redundancies will be minimized, with links created later to point to back to single-source details.
Some changes here are purely cosmetic.
The only commit relevant to this PR is for 81b0353 on 2021/May/03. Other commits are due to branch merges.