Contents TableOfContents
| Table of Contents |
|---|
Note: This page is under construction and shouldn't be considered "complete". If there are any questions, etc, please feel free to contact the users at spamassassin.apache.org list for more information.
Notes / FAQ
Can plugins be distributed via updates/channels?indent \\ From a technical standpoint, updates can contain plugins. However, the default channel, updates.spamassassin.org, will not publish plugins using this method at this time since people are likely not ready to accept automatic code updates. \\
After sa-update completes, do I have to move the files somewhere for them to be used?indent \\ No. By default, sa-update and the [SpamAssassin] modules use the same location for updates. This means that after a successful update run, the new rules are available for use. As usual, if using spamd, a restart is required for the new rules to be read in and enabled. \\
Should I use "--updatedir" to put updates in the default rules directory (ie: /usr/share/spamassassin), or the site rules directory (ie: /etc/mail/spamassassin)?indent \\ No! Those two directories have specific uses, and attempting to install updates to that directory will likely cripple your [SpamAssassin] installation. This is because when an update is installed, all previous files in the directory are removed first. \\
If I use "--updatedir" to install an update in a subdirectory of my site rules directory (ie: /etc/mail/spamassassin), a number of my local settings (typically set via local.cf) no longer function. Why?indent \\ This can happen if the update channel creates a channel file with a name lexically after the local settings, such as "updates_spamassassin_org.cf". For more information, read the "Using sa-update" section below, and also refer to the man page for "spamassassin". \\
What do I need to do with-respect-to sa-update after a SpamAssassin upgrade?indent \\ Whenever you upgrade the version of [SpamAssassin] that's installed, the directory where the updates are expected to be changes (it's based on the version). So whenever you upgrade, you will want to run sa-update for all of the channels that you want to have installed. \\
After upgrading SpamAssassin several times, there are a number of directories .../3.001001, .../3.001002, .../3.001003, etc. What should I do with them?indent \\ You definitely want to keep the latest version that matches the version of [SpamAssassin] that you have installed. However, the older versions can be removed whenever you like. \\
How often should I run sa-update?indent \\ As often as you like. It typically depends on what time-frame is comfortable for you, and how quickly channels are going to be publishing updates. Generally speaking, once a day is a good starting point. \\
After sa-update was used, the report contact setting becomes @@.indent \\ _This was fixed in 3.1.4._ This issue was tracked in \[bug 4862|http://issues.apache.org/SpamAssassin/show_bug.cgi?id=4862 bug 4862\].]. \\
Can I use sa-update as non-root too?indent \\ Of course. It works just fine as non-root for personal installations. Updates end up in $HOME/var, which is where your [SingleUserUnixInstall] of [SpamAssassin] will look for them. \\
What if I need update requests to go through a proxy server?indent \\ sa-update uses the {{LWP::UserAgent}} module, which allows certain environment variables to be set so that requests use defined proxy servers. The main one of interest is "http_proxy", which should be set to an URL defining the proxy. ie: {{export http_proxy='http://proxy.example.com:8080/'}} \\
For more information about how to use sa-update and how it works, please read below.
...
| No Format |
|---|
$ rm -f channels ; touch channels $ echo updates.spamassassin.org >> channels $ echo saupdates.example.com >> channels $ sa-update --channelfile channels |
--checkonly
| indent |
|---|
Check for update availability, do not install.
|
--allowplugins
| indent |
|---|
Allow updates to load plugin code (DANGEROUS). You should never enable this for 3rd party update channels, since plugins can execute unrestricted code on your system!
|
--refreshmirrors
| indent |
|---|
Force the MIRRORED.BY file to be updated.
|
--install <filename>
| indent |
|---|
Install updates directly from this file. Signature verification will read from filename.asc and filename.sha1 .
|
GPG Related
--(no)gpg:: By default, sa-update will require the use of GPG signatures to verify that downloaded updates are in fact legitimate. However, there may be channels which do not publish GPG signatures, or the system may not have GPG installed. In these situations, specify the
...
| No Format |
|---|
$ rm -f gpgkeys ; touch gpgkeys $ echo 26C900A46DD40CD5AD24F6D7DEE01987265FA05B >> gpgkeys $ echo 5244EC45 >> gpgkeys $ sa-update --gpgkeyfile gpgkeys |
--import <file>
| indent |
|---|
Import GPG key(s) from <file> into sa-update's keyring. Use multiple times for multiple files.
|
Other
| Wiki Markup |
|---|
*-D, --debug \[area=n,...\]* |
| indent |
|---|
:: Show debugging information. This can be useful just to see what sa-update is doing, but is also useful to debug problems, etc. This option takes the same optional parameter (DebugChannels) as the other standard [SpamAssassin] tools. |
-V, --version:: Display which version of
| indent |
|---|
Display which version of sa-update is installed. sa-update is versioned by Subversion revision number as opposed to being tied to a specific [SpamAssassin] version. |
-v, --verbose
| indent |
|---|
Be more verbose, like print updated channel names.
|
-h, --help:: Print usage message.
| indent |
|---|
Print usage message.
|
More information is available via the POD/man page for sa-update.
...
SARE Channels
Details Unfortunately the SARE ruleset has been discontinued in 2009. (Historical details of various channels from SARE can be seen at SareChannels)
The Backend
Details of the rule-update generation backend at updates.spamassassin.org can be read at SaUpdateBackend.