|
<< Click to Display Table of Contents >> Navigation: »No topics above this level« Configuration |
After installation, SpamAssassin is already preconfigured and can be used immediately. To ensure a maximum performance, many options can be individually configured to fit your system's needs.
The configuration of the system service of the SpamAssassin in a Box is done via the configuration file:
"C:\ProgramData\JAM Software\spamdService\SpamAssassinServiceController.config"
Below you will find all the relevant configuration options. The option names are the XML element names in that file and have to be spelled exactly as shown.
AutoUpdateRules |
Automatically run update for SpamAssassin rules (recommended!). The interval for updating the rule set can be specified in SaUpdateIntervalInDays. |
AvoidRestartOnAllOverCpuUsage |
Avoid restart of 'SpamD' when CPU usage is over the specified value. |
AvoidRestartOnSpamDCpuUsage |
Avoid restart of SpamAssassin daemon (spamd.exe) if CPU load of the daemon is above the specified value. This ensures that a restart isn't triggered while the daemon is processing mails. |
CustomCommandLine |
Defines the complete command line for the SpamAssassin daemon. It is used only if the UseCustomCommandLine option is set to "True". In that case the individual start parameters listed further below are ignored completely. Attention: This value should be changed by experienced users only. |
DebugService |
Turns on the debug mode of SpamAssassin in a Box. The debug information is stored in the Windows Event Viewer. To turn on the debug mode of the daemon itself, use the DebugSpamD option. |
NumberOfLogsKept |
Specifies the number of log files that are kept in the "sa-logs" folder. By default, ten log files will be kept which equals a period of ten days. A value of 0 disables keeping older log files. |
PingCheckTryCount |
Specifies how many attempts the service makes to reach the SpamAssassin daemon over the network. If all attempts fail, the daemon is restarted. During operation this check runs at most every 120 seconds. A value of 0 disables the check. |
ProxyURL |
The proxy URL that is used for network communication. If this value is empty, the proxy server that is defined in the internet settings of the system is used. |
SaUpdateIntervalInDays |
Specifies the interval in days between each SpamAssassin rules update. |
SaUpdateParameters |
Contains the parameters for executing the SpamAssassin rules update tool (sa-update). The channelfile contains the servers that are used when updating the rule set. For more information regarding sa-update, please see the official SpamAssassin docs. |
SaUpdateTimeoutInSeconds |
Specifies how long the service waits for "sa-update.exe" to finish. If this time elapses, the update is aborted and retried at the next interval. |
SpamDStartupTimeoutInSeconds |
Specifies how long the service waits for the SpamAssassin daemon to report that it is ready after being started. On heavily loaded systems with a large rule set, increasing this value can be useful. |
SpamdRestartIntervalInMinutes |
Specifies the interval for restarting 'SpamD' (in minutes). |
UseCustomCommandLine |
Determines whether to use the command line assembled from the individual start parameters or the command line defined via the CustomCommandLine option. |
UseSeperateLogFiles |
If this option is enabled, the service will create a new log file for the SpamAssassin daemon each day. If this option is disabled, the SpamAssassin daemon will always use the same log file. The most current log file is named "SpamD.log". Older log files are named in the form "SpamD.bak0.log", "SpamD.bak1.log", etc. |
The following options reside in the same configuration file. When starting the daemon, the service translates them into the "spamd.exe" command line parameters shown in brackets; for a detailed description of those parameters see the official SpamAssassin docs. If a text option is left empty, or a True/False option is set to "False", the corresponding parameter is not passed on.
AllowTell |
Allow learning and forgetting (to a local Bayes database), reporting and revoking (to a remote database) by spamd. |
AllowedIPs |
Comma-separated list of authorized hosts or networks which can connect to this spamd instance. |
ListenIP |
Tells spamd to listen on the specified IP address. Multiple IP adresses, separated by comma, can be specified. |
ListenPort |
Specifies the port number for the server to listen on. |
MaxChildren |
This option specifies the maximum number of children to spawn. The minimum value is 1. |
MinChildren |
The minimum number of children that will be kept running. The minimum value is 1. |
MaxSpare |
The upper limit for the number of spare children allowed to run. |
MinSpare |
The lower limit for the number of spare children allowed to run. |
MaxConnPerChild |
This option specifies the maximum number of connections each child should process before dying and letting the master spamd process spawn a new child. The minimum value is 1. |
TimeoutChild |
This option specifies the number of seconds to wait for a spamd child to process or check a message. The minimum value is 1, and a value of 0 will disable child timeouts completely. |
TimeoutTcp |
This option specifies the number of seconds to wait for headers from a client (spamc) before closing the connection. The minimum value is 1, and a value of 0 will disable socket timeouts completely. |
SysLog |
Specify the path for the log file that is used by the SpamAssassin daemon. |
DebugSpamD |
Produce debugging output for the SpamAssassin daemon. The output is written to the log file specified via SysLog. |
Local |
Perform only local tests on all mail. In other words, skip DNS and other network tests. |
Ssl |
Accept SSL encrypted connections. This requires SslKey and SslCertificate to be specified as well. |
SslKey |
Path to the file containing the server's private key for SSL encrypted connections. |
SslCertificate |
Path to the file containing the server's certificate for SSL encrypted connections. |