Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: [Original edit by KevinMcGrail] Added vetting process explicitly

...

An advantage to participating is that it makes SpamAssassin more accurate on your email.

How?

(New masscheck contributors are now being accepted since about 2012-08-09.)

  1. Send an email to private@spamassassin.apache.org requesting an rsync account for nightly mass-checks. If you get no response, it can help to post to the public dev@spamassassin.apache.org mailing listIt is helpful if you include a few sentences with your background and expertise for vetting purposes. NOTE: New masscheck contributors are now being accepted since about 2012-08-09.
  2. When your request is processed, you'll be notified and added to the RuleQA Mailing List for SpamAssassin.
  3. Ensure SpamAssassin and its plugins are fully installed.
  4. Download the auto-mass-check script (browse repo):
    • No Format
        git clone git://git.fedorahosted.org/auto-mass-check.git
      
  5. Copy auto-mass-check/auto-mass-check.sh to ~/bin/
  6. Copy auto-mass-check/auto-mass-check.cf to ~/.auto-mass-check.cf
  7. Modify ~/.auto-mass-check.cf to point at your ham and spam folders. Be sure to configure properly for mbox (mbox) or Maildir (dir) folder formats. Leave the RSYNC options unchanged for now, because you will be running auto-mass-check in test mode at first.
  8. The masschecker is set to run 8 threads by default. Depending on your box's resources this could too much or too little. Modify your auto-mass-check.sh to set this and changes JOBS=8 as needed. NOTE: there are several JOBS=X entries for each masscheck type that each need to be changed.
  9. Optionally set TRUSTED_NETWORKS and INTERNAL_NETWORKS in ~/.auto-mass-check.cf
  10. Ensure there is no router/firewall blocking port 873 (used by rsync protocol)
  11. Run auto-mass-check.sh.
    • Look in ~/masscheckwork/nightly_mass_check/masses/ for ham-*.log and spam-*.log files. (Or weekly_mass_check on Saturday.)
    • Are the filenames good? They should be named something like ham-username.log or ham-net-username.log.
    • Read CorpusCleaning and HandClassifiedCorpora for guidelines of how to identify ham in your spam folder, and spam in your ham folder, and which messages you should be simply deleted.
    • If you move/delete messages, do not forget to "Compact Folder" to be sure they are actually gone.
    • Repeat auto-mass-check until you are certain both folders are cleaned.
  12. Edit ~/.auto-mass-check.cf and set RSYNC_USERNAME and RSYNC_PASSWORD with values from step 1.
  13. Run auto-mass-check.sh, which will upload your results.
  14. Ask a more experienced participant (probably the person who recruited you) to check your results on the server. They can see the uploaded log files by running a command like rsync --old-d username@rsync.spamassassin.org::corpus/. You can also verify that your corpora show up on http://ruleqa.spamassassin.org/ - the green box near the top shows all included usernames.
  15. If your upload looks good, then you're probably ready to automate nightly checks. Configure auto-mass-check to run as a cron job as your non-root user at or after 9AM UTC. (After weekly-versions.txt / nightly-versions.txt gets updated in rsync.spamassassin.org::corpus . If you run it earlier it will break things. )

...