razor-agents(5)

1RAZOR-AGENTS(1)       User Contributed Perl Documentation      RAZOR-AGENTS(1)
2
3
4

NAME

6       Razor-Agents - Collection of files for checking, reporting, and
7       revoking spam
8

DESCRIPTION

10       Vipul's Razor is a distributed, collaborative, spam detection,
11       reporting, and filtering network. The primary focus of the system is to
12       identify and remove all email spam from the internet.  Visit the
13       website at http://razor.sourceforge.net/.
14

USAGE

16       First a razorhome directory should be created where log, conf, and
17       cached server information will live.  This is done via "-create" option
18       to razor-admin(1).  See man page for details.
19
20       You can immediately check spam using razor-check(1).  See man page for
21       details.
22
23       To report spam, an identity must be registered.  This is done via
24       "-register" option to razor-admin(1).  After that, razor-report(1) and
25       razor-revoke(1) will work flawlessly.
26

CONFIGURATION

28       All Razor-Agents share a configuration file.  The contents of the
29       configuration file are detailed in the razor-agent.conf(5) manpage.
30
31       Config file is computed before razorhome, in the following order:
32
33        -conf=/path/file.conf           used if readable, else
34        <home>/.razor/razor-agent.conf  used if readable, else
35        /etc/razor/razor-agent.conf     used if readable, else
36        all defaults are used.
37
38       To see configuration defaults, do
39         razor-admin -create -conf=/tmp/razor2-defaults.conf
40

RAZORHOME

42       All Razor-Agents also share a razorhome directory, where identity,
43       logging, and cached information about servers is stored.  Razorhome is
44       computed after configuration file, in the following order.
45
46        -home=/tmp/razor/                     used if readable, else
47        'razorhome' from configuration file   used if readable, else
48        <home>/.razor/                        used if readable, else
49        <home>/.razor/                        is created.  if that fails,
50                                              no razorhome.
51
52
53        NOTE: If there is no razorhome, razor-report and razor-revoke will
54              not work unless you specify  -ident=/path/identity
55              razor-check will still work.
56

FILES

58       Besides those listed at the end with their own manpages, Razor Agents
59       also has the following files.
60
61       razorhome/identity
62           Usually a symlink to identity file containing user+pass.  Used by
63           razor-report(1) and razor-revoke(1).
64
65       razorhome/razor-agent.log
66           Default log file.  To change, edit razor-agent.conf(5).
67
68       razorhome/servers.*.lst
69           Cached list of Razor Servers.  If more than one, they are ordered
70           by closest ping time.
71
72       razorhome/server.<name>.lst
73           Cached info for <name> server. The "srl" key in this file is
74           compared against the server greeting, and if server's is greater,
75           new cache info is retrieved from the server.
76

EXAMPLES

78       razor-check -d -debuglevel=9 mbox
79           Checks spam in mbox.  prints numbers for those found to be spam.
80           -d logs to stdout, -debuglevel=9 is verbose logging
81
82       razor-admin -create -home=/home/chad/.razor -d -s
83           Creates razorhome in /home/chad/.razor, log to stdout, does not
84           connect to server (-s simulate).
85
86       razor-report spam -debuglevel=0
87           sends spam to server, with no log msgs.
88

AUTHORS

90       Vipul Ved Prakash, <mail@vipul.net> and Chad Norwood <chad@samo.org>
91